Package com.tencentcloudapi.ess.v20201111.models

Class CreateEmbedWebUrlRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Agent getAgent()
      Get 代理企业和员工的信息。
      在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
      String getBusinessId()
      Get WEB嵌入的业务资源ID PREVIEW_SEAL_DETAIL，必填，取值为印章id MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id
      String getEmbedType()
      Get WEB嵌入资源类型，支持以下类型 CREATE_SEAL: 生成创建印章的嵌入页面 CREATE_TEMPLATE：生成创建模板的嵌入页面 MODIFY_TEMPLATE：生成编辑模板的嵌入页面 PREVIEW_TEMPLATE：生成预览模板的嵌入页面 PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面 PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面 EXTEND_SERVICE：生成拓展服务的嵌入页面 PREVIEW_FLOW：生成预览合同的嵌入页面 PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面
      UserInfo getOperator()
      Get 执行本接口操作的员工信息。
      注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
      EmbedUrlOption getOption()
      Get 个性化参数，用于控制页面展示内容
      ReviewerInfo getReviewer()
      Get 抄送方信息
      void setAgent​(Agent Agent)
      Set 代理企业和员工的信息。
      在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
      void setBusinessId​(String BusinessId)
      Set WEB嵌入的业务资源ID PREVIEW_SEAL_DETAIL，必填，取值为印章id MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id
      void setEmbedType​(String EmbedType)
      Set WEB嵌入资源类型，支持以下类型 CREATE_SEAL: 生成创建印章的嵌入页面 CREATE_TEMPLATE：生成创建模板的嵌入页面 MODIFY_TEMPLATE：生成编辑模板的嵌入页面 PREVIEW_TEMPLATE：生成预览模板的嵌入页面 PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面 PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面 EXTEND_SERVICE：生成拓展服务的嵌入页面 PREVIEW_FLOW：生成预览合同的嵌入页面 PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面
      void setOperator​(UserInfo Operator)
      Set 执行本接口操作的员工信息。
      注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
      void setOption​(EmbedUrlOption Option)
      Set 个性化参数，用于控制页面展示内容
      void setReviewer​(ReviewerInfo Reviewer)
      Set 抄送方信息
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • CreateEmbedWebUrlRequest

        public CreateEmbedWebUrlRequest()

      • CreateEmbedWebUrlRequest

        public CreateEmbedWebUrlRequest​(CreateEmbedWebUrlRequest source)
        NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

    • Method Detail

      • getOperator

        public UserInfo getOperator()
        Get 执行本接口操作的员工信息。
        注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
        Returns:
        Operator 执行本接口操作的员工信息。
        注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。

      • setOperator

        public void setOperator​(UserInfo Operator)
        Set 执行本接口操作的员工信息。
        注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
        Parameters:
        Operator - 执行本接口操作的员工信息。
        注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。

      • getEmbedType

        public String getEmbedType()
        Get WEB嵌入资源类型，支持以下类型
        • CREATE_SEAL: 生成创建印章的嵌入页面
        • CREATE_TEMPLATE：生成创建模板的嵌入页面
        • MODIFY_TEMPLATE：生成编辑模板的嵌入页面
        • PREVIEW_TEMPLATE：生成预览模板的嵌入页面
        • PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
        • PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
        • EXTEND_SERVICE：生成拓展服务的嵌入页面
        • PREVIEW_FLOW：生成预览合同的嵌入页面
        • PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面
        Returns:
        EmbedType WEB嵌入资源类型，支持以下类型
        • CREATE_SEAL: 生成创建印章的嵌入页面
        • CREATE_TEMPLATE：生成创建模板的嵌入页面
        • MODIFY_TEMPLATE：生成编辑模板的嵌入页面
        • PREVIEW_TEMPLATE：生成预览模板的嵌入页面
        • PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
        • PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
        • EXTEND_SERVICE：生成拓展服务的嵌入页面
        • PREVIEW_FLOW：生成预览合同的嵌入页面
        • PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面

      • setEmbedType

        public void setEmbedType​(String EmbedType)
        Set WEB嵌入资源类型，支持以下类型
        • CREATE_SEAL: 生成创建印章的嵌入页面
        • CREATE_TEMPLATE：生成创建模板的嵌入页面
        • MODIFY_TEMPLATE：生成编辑模板的嵌入页面
        • PREVIEW_TEMPLATE：生成预览模板的嵌入页面
        • PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
        • PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
        • EXTEND_SERVICE：生成拓展服务的嵌入页面
        • PREVIEW_FLOW：生成预览合同的嵌入页面
        • PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面
        Parameters:
        EmbedType - WEB嵌入资源类型，支持以下类型
        • CREATE_SEAL: 生成创建印章的嵌入页面
        • CREATE_TEMPLATE：生成创建模板的嵌入页面
        • MODIFY_TEMPLATE：生成编辑模板的嵌入页面
        • PREVIEW_TEMPLATE：生成预览模板的嵌入页面
        • PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
        • PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
        • EXTEND_SERVICE：生成拓展服务的嵌入页面
        • PREVIEW_FLOW：生成预览合同的嵌入页面
        • PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面

      • getBusinessId

        public String getBusinessId()
        Get WEB嵌入的业务资源ID
        • PREVIEW_SEAL_DETAIL，必填，取值为印章id
        • MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id
        • PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id
          Returns:
          BusinessId WEB嵌入的业务资源ID
          • PREVIEW_SEAL_DETAIL，必填，取值为印章id
          • MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id
          • PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id

          • setBusinessId

            public void setBusinessId​(String BusinessId)
            Set WEB嵌入的业务资源ID
            • PREVIEW_SEAL_DETAIL，必填，取值为印章id
            • MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id
            • PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id
              Parameters:
              BusinessId - WEB嵌入的业务资源ID
              • PREVIEW_SEAL_DETAIL，必填，取值为印章id
              • MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id
              • PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id

              • getAgent

                public Agent getAgent()
                Get 代理企业和员工的信息。
                在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
                Returns:
                Agent 代理企业和员工的信息。
                在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

              • setAgent

                public void setAgent​(Agent Agent)
                Set 代理企业和员工的信息。
                在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
                Parameters:
                Agent - 代理企业和员工的信息。
                在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

              • getReviewer

                public ReviewerInfo getReviewer()
                Get 抄送方信息
                Returns:
                Reviewer 抄送方信息

              • setReviewer

                public void setReviewer​(ReviewerInfo Reviewer)
                Set 抄送方信息
                Parameters:
                Reviewer - 抄送方信息

              • getOption

                public EmbedUrlOption getOption()
                Get 个性化参数，用于控制页面展示内容
                Returns:
                Option 个性化参数，用于控制页面展示内容

              • setOption

                public void setOption​(EmbedUrlOption Option)
                Set 个性化参数，用于控制页面展示内容
                Parameters:
                Option - 个性化参数，用于控制页面展示内容