Class: TencentCloud::Ess::V20201111::TemplateInfo

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

Overview

模板组成

一个模板通常会包含以下结构信息

  • 模板基本信息
  • 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
  • 填写控件 Components
  • 签署控件 SignComponents
  • 生成模板的文件基础信息 FileInfos

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(templateid = nil, templatename = nil, recipients = nil, components = nil, signcomponents = nil, description = nil, documentresourceids = nil, fileinfos = nil, attachmentresourceids = nil, signorder = nil, status = nil, creator = nil, createdon = nil, promoter = nil, templatetype = nil, available = nil, organizationid = nil, creatorid = nil, previewurl = nil, userflowtype = nil, templateversion = nil, published = nil, sharetemplateid = nil, templateseals = nil, seals = nil) ⇒ TemplateInfo

Returns a new instance of TemplateInfo.



17685
17686
17687
17688
17689
17690
17691
17692
17693
17694
17695
17696
17697
17698
17699
17700
17701
17702
17703
17704
17705
17706
17707
17708
17709
17710
17711
 
# File 'lib/v20201111/models.rb', line 17685

def initialize(templateid=nil, templatename=nil, recipients=nil, components=nil, signcomponents=nil, description=nil, documentresourceids=nil, fileinfos=nil, attachmentresourceids=nil, signorder=nil, status=nil, creator=nil, createdon=nil, promoter=nil, templatetype=nil, available=nil, organizationid=nil, creatorid=nil, previewurl=nil, userflowtype=nil, templateversion=nil, published=nil, sharetemplateid=nil, templateseals=nil, seals=nil)
  @TemplateId = templateid
  @TemplateName = templatename
  @Recipients = recipients
  @Components = components
  @SignComponents = signcomponents
  @Description = description
  @DocumentResourceIds = documentresourceids
  @FileInfos = fileinfos
  @AttachmentResourceIds = attachmentresourceids
  @SignOrder = signorder
  @Status = status
  @Creator = creator
  @CreatedOn = createdon
  @Promoter = promoter
  @TemplateType = templatetype
  @Available = available
  @OrganizationId = organizationid
  @CreatorId = creatorid
  @PreviewUrl = previewurl
  @UserFlowType = userflowtype
  @TemplateVersion = templateversion
  @Published = published
  @ShareTemplateId = sharetemplateid
  @TemplateSeals = templateseals
  @Seals = seals
end

Instance Attribute Details

#AttachmentResourceIds ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def AttachmentResourceIds
  @AttachmentResourceIds
end

#Available ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def Available
  @Available
end

#Components ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def Components
  @Components
end

#CreatedOn ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def CreatedOn
  @CreatedOn
end

#Creator ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def Creator
  @Creator
end

#CreatorId ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def CreatorId
  @CreatorId
end

#Description ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def Description
  @Description
end

#DocumentResourceIds ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def DocumentResourceIds
  @DocumentResourceIds
end

#FileInfos ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def FileInfos
  @FileInfos
end

#OrganizationId ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def OrganizationId
  @OrganizationId
end

#PreviewUrl ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def PreviewUrl
  @PreviewUrl
end

#Promoter ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def Promoter
  @Promoter
end

#Published ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def Published
  @Published
end

#Recipients ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def Recipients
  @Recipients
end

#Seals ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def Seals
  @Seals
end

#ShareTemplateId ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def ShareTemplateId
  @ShareTemplateId
end

#SignComponents ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def SignComponents
  @SignComponents
end

#SignOrder ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def SignOrder
  @SignOrder
end

#Status ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def Status
  @Status
end

#TemplateId ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def TemplateId
  @TemplateId
end

#TemplateName ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def TemplateName
  @TemplateName
end

#TemplateSeals ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def TemplateSeals
  @TemplateSeals
end

#TemplateType ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def TemplateType
  @TemplateType
end

#TemplateVersion ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def TemplateVersion
  @TemplateVersion
end

#UserFlowType ⇒ Object

true：已发布状态，表示该模板已经发布并可以正常使用。 false：未发布状态，表示该模板还未发布，无法使用。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • ShareTemplateId: (b) —

    集体账号场景下： 集团账号分享给子企业的模板的来源模板ID。

  • TemplateSeals: —

    此模板配置的预填印章列表（包括自动签署指定的印章）

  • Seals: —

    模板内部指定的印章列表



17680
17681
17682
 
# File 'lib/v20201111/models.rb', line 17680

def UserFlowType
  @UserFlowType
end

Instance Method Details

#deserialize(params) ⇒ Object 



17713
17714
17715
17716
17717
17718
17719
17720
17721
17722
17723
17724
17725
17726
17727
17728
17729
17730
17731
17732
17733
17734
17735
17736
17737
17738
17739
17740
17741
17742
17743
17744
17745
17746
17747
17748
17749
17750
17751
17752
17753
17754
17755
17756
17757
17758
17759
17760
17761
17762
17763
17764
17765
17766
17767
17768
17769
17770
17771
17772
17773
17774
17775
17776
17777
17778
17779
17780
17781
17782
17783
17784
17785
17786
17787
 
# File 'lib/v20201111/models.rb', line 17713

def deserialize(params)
  @TemplateId = params['TemplateId']
  @TemplateName = params['TemplateName']
  unless params['Recipients'].nil?
    @Recipients = []
    params['Recipients'].each do |i|
      recipient_tmp = Recipient.new
      recipient_tmp.deserialize(i)
      @Recipients << recipient_tmp
    end
  end
  unless params['Components'].nil?
    @Components = []
    params['Components'].each do |i|
      component_tmp = Component.new
      component_tmp.deserialize(i)
      @Components << component_tmp
    end
  end
  unless params['SignComponents'].nil?
    @SignComponents = []
    params['SignComponents'].each do |i|
      component_tmp = Component.new
      component_tmp.deserialize(i)
      @SignComponents << component_tmp
    end
  end
  @Description = params['Description']
  @DocumentResourceIds = params['DocumentResourceIds']
  unless params['FileInfos'].nil?
    @FileInfos = []
    params['FileInfos'].each do |i|
      fileinfo_tmp = FileInfo.new
      fileinfo_tmp.deserialize(i)
      @FileInfos << fileinfo_tmp
    end
  end
  @AttachmentResourceIds = params['AttachmentResourceIds']
  @SignOrder = params['SignOrder']
  @Status = params['Status']
  @Creator = params['Creator']
  @CreatedOn = params['CreatedOn']
  unless params['Promoter'].nil?
    @Promoter = Recipient.new
    @Promoter.deserialize(params['Promoter'])
  end
  @TemplateType = params['TemplateType']
  @Available = params['Available']
  @OrganizationId = params['OrganizationId']
  @CreatorId = params['CreatorId']
  @PreviewUrl = params['PreviewUrl']
  unless params['UserFlowType'].nil?
    @UserFlowType = UserFlowType.new
    @UserFlowType.deserialize(params['UserFlowType'])
  end
  @TemplateVersion = params['TemplateVersion']
  @Published = params['Published']
  @ShareTemplateId = params['ShareTemplateId']
  unless params['TemplateSeals'].nil?
    @TemplateSeals = []
    params['TemplateSeals'].each do |i|
      sealinfo_tmp = SealInfo.new
      sealinfo_tmp.deserialize(i)
      @TemplateSeals << sealinfo_tmp
    end
  end
  unless params['Seals'].nil?
    @Seals = []
    params['Seals'].each do |i|
      sealinfo_tmp = SealInfo.new
      sealinfo_tmp.deserialize(i)
      @Seals << sealinfo_tmp
    end
  end
end