Class Template
Template Document DTO.
Inheritance
Namespace: BoldSign.Model
Assembly: BoldSign.Api.dll
Syntax
public class Template : object
Constructors
| Improve this Doc View SourceTemplate(String, TemplateSenderDetails, List<TemplateCC>, Int64, Nullable<Int64>, String, String, Nullable<DocumentStatus>, List<TemplateSignerDetails>, Boolean, String, String, Nullable<TemplateAccessType>, String, Boolean, BehalfOf, List<String>, List<String>)
Initializes a new instance of the Template class.
Declaration
public Template(string documentId = null, TemplateSenderDetails senderDetail = null, List<TemplateCC> ccDetails = null, long createdDate = null, long? activityDate = null, string activityBy = null, string messageTitle = null, DocumentStatus? status = null, List<TemplateSignerDetails> signerDetails = null, bool enableSigningOrder = null, string templateName = null, string templateDescription = null, TemplateAccessType? accessType = null, string accessTid = null, bool isTemplate = false, BehalfOf behalfOf = null, List<string> templateLabels = null, List<string> labels = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | documentId | Gets or sets documentId.. |
TemplateSenderDetails | senderDetail | senderDetail. |
List<TemplateCC> | ccDetails | Gets or sets the CC details.. |
System.Int64 | createdDate | Gets or sets the createdDate.. |
System.Nullable<System.Int64> | activityDate | Gets or sets the activityDate.. |
System.String | activityBy | Gets or sets the activityBy.. |
System.String | messageTitle | Gets or sets the messageTitle.. |
System.Nullable<DocumentStatus> | status | status. |
List<TemplateSignerDetails> | signerDetails | Gets or sets the signerDetails.. |
System.Boolean | enableSigningOrder | Gets or sets a value indicating whether the SigningOrder is enabled.. |
System.String | templateName | Gets or sets the templateName.. |
System.String | templateDescription | Gets or sets the templateDescription.. |
System.Nullable<TemplateAccessType> | accessType | accessType. |
System.String | accessTid | <br> Gets or sets the shared Team ID. <br>The value represents the Team ID of the template shared to.. |
System.Boolean | isTemplate | Gets or sets a value indicating whether get or Set the isTemplate. (default to false). |
BehalfOf | behalfOf | Gets or sets the behalf of details.. |
List<System.String> | templateLabels | Gets or sets the template labels. |
List<System.String> | labels | Gets or sets the labels. |
Properties
| Improve this Doc View SourceAccessTid
<br> Gets or sets the shared Team ID. <br>The value represents the Team ID of the template shared to.
Declaration
public string AccessTid { get; set; }
Property Value
Type | Description |
---|---|
System.String | <br> Gets or sets the shared Team ID. <br>The value represents the Team ID of the template shared to. |
AccessType
Gets or sets template access type.
Declaration
public TemplateAccessType? AccessType { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<TemplateAccessType> |
ActivityBy
Gets or sets the name of the user who performed an action on a document.
Declaration
public string ActivityBy { get; set; }
Property Value
Type | Description |
---|---|
System.String | Gets or sets the activityBy. |
ActivityDate
Gets or sets the activity date which is the date of any particular action by user on a document.
Declaration
public long? ActivityDate { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int64> | Gets or sets the activityDate. |
BehalfOf
Gets or sets the behalf of details.
Declaration
public BehalfOf BehalfOf { get; set; }
Property Value
Type | Description |
---|---|
BehalfOf |
CcDetails
Gets or sets the CC details.
Declaration
public List<TemplateCC> CcDetails { get; set; }
Property Value
Type | Description |
---|---|
List<TemplateCC> | Gets or sets the CC details. |
CreatedDate
Gets or sets the created date.
Declaration
public long CreatedDate { get; set; }
Property Value
Type | Description |
---|---|
System.Int64 | Gets or sets the createdDate. |
DocumentId
Gets or sets document Id.
Declaration
public string DocumentId { get; set; }
Property Value
Type | Description |
---|---|
System.String | Gets or sets documentId. |
EnableSigningOrder
Gets or sets a value indicating whether signing order is enabled.
Declaration
public bool EnableSigningOrder { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | Gets or sets a value indicating whether the SigningOrder is enabled. |
IsTemplate
Gets or sets a value indicating whether it is a template.
Declaration
public bool IsTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | Gets or sets a value indicating whether get or Set the isTemplate. |
Labels
Gets or sets the labels.
Declaration
public List<string> Labels { get; set; }
Property Value
Type | Description |
---|---|
List<System.String> |
MessageTitle
Gets or sets the message title.
Declaration
public string MessageTitle { get; set; }
Property Value
Type | Description |
---|---|
System.String | Gets or sets the messageTitle. |
SenderDetail
Gets or sets sender details.
Declaration
public TemplateSenderDetails SenderDetail { get; set; }
Property Value
Type | Description |
---|---|
TemplateSenderDetails |
SignerDetails
Gets or sets the signer details.
Declaration
public List<TemplateSignerDetails> SignerDetails { get; set; }
Property Value
Type | Description |
---|---|
List<TemplateSignerDetails> | Gets or sets the signerDetails. |
Status
Gets or sets the document status.
Declaration
public DocumentStatus? Status { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<DocumentStatus> |
TemplateDescription
Gets or sets the template description.
Declaration
public string TemplateDescription { get; set; }
Property Value
Type | Description |
---|---|
System.String | Gets or sets the templateDescription. |
TemplateLabels
Gets or sets the template labels.
Declaration
public List<string> TemplateLabels { get; set; }
Property Value
Type | Description |
---|---|
List<System.String> |
TemplateName
Gets or sets the template name.
Declaration
public string TemplateName { get; set; }
Property Value
Type | Description |
---|---|
System.String | Gets or sets the templateName. |
Methods
| Improve this Doc View SourceToJson()
Returns the JSON string presentation of the object
Declaration
public virtual string ToJson()
Returns
Type | Description |
---|---|
System.String | JSON string presentation of the object |