Class: TencentCloud::Ess::V20201111::CreateEmbedWebUrlRequest

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20201111/models.rb

Overview

CreateEmbedWebUrl请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(operator = nil, embedtype = nil, businessid = nil, agent = nil, reviewer = nil, option = nil, userdata = nil) ⇒ CreateEmbedWebUrlRequest

Returns a new instance of CreateEmbedWebUrlRequest.



3478
3479
3480
3481
3482
3483
3484
3485
3486
# File 'lib/v20201111/models.rb', line 3478

def initialize(operator=nil, embedtype=nil, businessid=nil, agent=nil, reviewer=nil, option=nil, userdata=nil)
  @Operator = operator
  @EmbedType = embedtype
  @BusinessId = businessid
  @Agent = agent
  @Reviewer = reviewer
  @Option = option
  @UserData = userdata
end

Instance Attribute Details

#AgentObject

注意:

  1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口创建文件转换任务 查询转换任务状态 来进行转换成PDF资源。
  2. CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件,并且大小不能超过 10M。
    在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:

  • Agent:

    代理企业和员工的信息。

  • Reviewer:

    抄送方信息

  • Option:

    个性化参数,用于控制页面展示内容

  • UserData: (ul)
  • 目前仅支持EmbedType=CREATE_TEMPLATE时传入
  • 指定后,创建,编辑,删除模板时,回调都会携带该userData
  • 支持的格式:json字符串的BASE64编码字符串
  • 示例:
    • json字符串:"ComeFrom":"xxx",BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9
    • eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式


3476
3477
3478
# File 'lib/v20201111/models.rb', line 3476

def Agent
  @Agent
end

#BusinessIdObject

注意:

  1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口创建文件转换任务 查询转换任务状态 来进行转换成PDF资源。
  2. CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件,并且大小不能超过 10M。
    在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:

  • Agent:

    代理企业和员工的信息。

  • Reviewer:

    抄送方信息

  • Option:

    个性化参数,用于控制页面展示内容

  • UserData: (ul)
  • 目前仅支持EmbedType=CREATE_TEMPLATE时传入
  • 指定后,创建,编辑,删除模板时,回调都会携带该userData
  • 支持的格式:json字符串的BASE64编码字符串
  • 示例:
    • json字符串:"ComeFrom":"xxx",BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9
    • eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式


3476
3477
3478
# File 'lib/v20201111/models.rb', line 3476

def BusinessId
  @BusinessId
end

#EmbedTypeObject

注意:

  1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口创建文件转换任务 查询转换任务状态 来进行转换成PDF资源。
  2. CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件,并且大小不能超过 10M。
    在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:

  • Agent:

    代理企业和员工的信息。

  • Reviewer:

    抄送方信息

  • Option:

    个性化参数,用于控制页面展示内容

  • UserData: (ul)
  • 目前仅支持EmbedType=CREATE_TEMPLATE时传入
  • 指定后,创建,编辑,删除模板时,回调都会携带该userData
  • 支持的格式:json字符串的BASE64编码字符串
  • 示例:
    • json字符串:"ComeFrom":"xxx",BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9
    • eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式


3476
3477
3478
# File 'lib/v20201111/models.rb', line 3476

def EmbedType
  @EmbedType
end

#OperatorObject

注意:

  1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口创建文件转换任务 查询转换任务状态 来进行转换成PDF资源。
  2. CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件,并且大小不能超过 10M。
    在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:



3476
3477
3478
# File 'lib/v20201111/models.rb', line 3476

def Operator
  @Operator
end

#OptionObject

注意:

  1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口创建文件转换任务 查询转换任务状态 来进行转换成PDF资源。
  2. CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件,并且大小不能超过 10M。
    在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:



3476
3477
3478
# File 'lib/v20201111/models.rb', line 3476

def Option
  @Option
end

#ReviewerObject

注意:

  1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口创建文件转换任务 查询转换任务状态 来进行转换成PDF资源。
  2. CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件,并且大小不能超过 10M。
    在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:



3476
3477
3478
# File 'lib/v20201111/models.rb', line 3476

def Reviewer
  @Reviewer
end

#UserDataObject

注意:

  1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口创建文件转换任务 查询转换任务状态 来进行转换成PDF资源。
  2. CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件,并且大小不能超过 10M。
    在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

Parameters:



3476
3477
3478
# File 'lib/v20201111/models.rb', line 3476

def UserData
  @UserData
end

Instance Method Details

#deserialize(params) ⇒ Object



3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
# File 'lib/v20201111/models.rb', line 3488

def deserialize(params)
  unless params['Operator'].nil?
    @Operator = UserInfo.new
    @Operator.deserialize(params['Operator'])
  end
  @EmbedType = params['EmbedType']
  @BusinessId = params['BusinessId']
  unless params['Agent'].nil?
    @Agent = Agent.new
    @Agent.deserialize(params['Agent'])
  end
  unless params['Reviewer'].nil?
    @Reviewer = ReviewerInfo.new
    @Reviewer.deserialize(params['Reviewer'])
  end
  unless params['Option'].nil?
    @Option = EmbedUrlOption.new
    @Option.deserialize(params['Option'])
  end
  @UserData = params['UserData']
end