Class TemplateProperties

The template properties includes any activity taken on the template, the user who acts on it, date of action, description of template, and so on.

Inheritance

System.Object

TemplateProperties

Namespace: BoldSign.Model

Assembly: BoldSign.Api.dll

Syntax

public class TemplateProperties : object

Constructors

TemplateProperties(String, String, String, String, String, List<DocumentFiles>, List<RoleProperties>, List<TemplateFormField>, List<String>, String, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Nullable<Int64>, TemplateSenderDetail, List<SharedTemplateDetail>, IEnumerable<DocumentInfo>, DocumentDownloadOption, List<String>, List<String>, BehalfOf)

Initializes a new instance of the TemplateProperties class.

Declaration

public TemplateProperties(string templateId = null, string title = null, string description = null, string documentTitle = null, string documentMessage = null, List<DocumentFiles> files = null, List<RoleProperties> roles = null, List<TemplateFormField> commonFields = null, List<string> cCDetails = null, string brandId = null, bool allowMessageEditing = null, bool allowNewRoles = null, bool allowNewFiles = null, bool allowModifyFiles = null, bool enableReassign = null, bool enablePrintAndSign = null, bool enableSigningOrder = null, long? createdDate = null, TemplateSenderDetail createdBy = null, List<SharedTemplateDetail> sharedTemplateDetail = null, IEnumerable<DocumentInfo> documentInfo = null, DocumentDownloadOption documentDownloadOption = (DocumentDownloadOption)0, List<string> labels = null, List<string> templateLabels = null, BehalfOf behalfOf = null)

Parameters

Type	Name	Description
System.String	templateId	Gets or sets the template id..
System.String	title	Gets or sets the title..
System.String	description	Gets or Sets description..
System.String	documentTitle	Gets or Sets documentTitle..
System.String	documentMessage	Gets or Sets documentMessage..
List<DocumentFiles>	files	Gets or Sets document uploaded file information..
List<RoleProperties>	roles	Gets or sets the roles..
List<TemplateFormField>	commonFields	Gets or sets the common fields..
List<System.String>	cCDetails	Gets or sets the CC details..
System.String	brandId	Gets or sets the brand id..
System.Boolean	allowMessageEditing	Gets or sets the allowMessageEditing..
System.Boolean	allowNewRoles	Gets or sets the allowNewRoles..
System.Boolean	allowNewFiles	Gets or sets the allowNewFiles..
System.Boolean	allowModifyFiles	Gets or sets the allowModifyFiles..
System.Boolean	enableReassign	Gets or sets a value indicating whether to Enable Reassign.By Default True..
System.Boolean	enablePrintAndSign	Gets or sets a value indicating whether to Enable Print And Sign.
System.Boolean	enableSigningOrder	Gets or sets a value indicating whether to enable signing order..
System.Nullable<System.Int64>	createdDate	Gets or sets the createdDate..
TemplateSenderDetail	createdBy	createdBy.
List<SharedTemplateDetail>	sharedTemplateDetail	sharedTemplateDetail..
IEnumerable<DocumentInfo>	documentInfo	Gets or sets the documentInfo..
DocumentDownloadOption	documentDownloadOption	Gets or sets the documentDownloadOption.
List<System.String>	labels	Gets or sets the documentLabels.
List<System.String>	templateLabels	Gets or sets the templateLabels.
BehalfOf	behalfOf	Gets or sets the behalf of details..

Properties

AllowMessageEditing

Gets or sets a value indicating whether signing order is enabled.

Declaration

public bool? AllowMessageEditing { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	Gets or sets a value of indicating whether to enable signing order.

AllowModifyFiles

Gets or sets a value indicating whether allow modify files is enabled.

Declaration

public bool? AllowModifyFiles { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	Gets or sets a value of indicating whether to enable modify files.

AllowNewFiles

Gets or sets a value indicating whether allow new files is enabled.

Declaration

public bool? AllowNewFiles { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	Gets or sets a value of indicating whether to enable allow new files.

AllowNewRoles

Gets or sets a value indicating whether signing order is enabled.

Declaration

public bool? AllowNewRoles { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	Gets or sets a value of indicating whether to enable signing order.

BehalfOf

Gets or sets the behalf of details.

Declaration

public BehalfOf BehalfOf { get; set; }

Property Value

Type	Description
BehalfOf	Gets the value of behalf of details.

BrandId

Gets or sets the Brand Id.

Declaration

public string BrandId { get; set; }

Property Value

Type	Description
System.String	Gets or sets the brand id.

CCDetails

Gets or sets the CC details.

Declaration

public List<string> CCDetails { get; set; }

Property Value

Type	Description
List<System.String>	Gets the value of CC details.

CommonFields

Gets or sets common fields.

Declaration

public IEnumerable<TemplateFormField> CommonFields { get; set; }

Property Value

Type	Description
IEnumerable<TemplateFormField>

CreatedBy

Gets or sets the template createdBy details.

Declaration

public TemplateSenderDetail CreatedBy { get; set; }

Property Value

Type	Description
TemplateSenderDetail	Gets the value of template createdBy details.

CreatedDate

Gets or sets the created date of a document.

Declaration

public long? CreatedDate { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>	Gets or sets the createdDate.

DocumentDescription

Gets or sets template description.

Declaration

public string DocumentDescription { get; set; }

Property Value

Type	Description
System.String	Gets or Sets template description.

DocumentDownloadOption

Gets or sets a value indicating whether to enable individual document downloads.

Declaration

public DocumentDownloadOption DocumentDownloadOption { get; set; }

Property Value

Type	Description
DocumentDownloadOption

DocumentInfo

Gets or sets a documentInfo.

Declaration

public IEnumerable<DocumentInfo> DocumentInfo { get; set; }

Property Value

Type	Description
IEnumerable<DocumentInfo>

DocumentMessage

Gets or sets template message.

Declaration

public string DocumentMessage { get; set; }

Property Value

Type	Description
System.String	Gets or Sets template message.

DocumentTitle

Gets or sets document title.

Declaration

public string DocumentTitle { get; set; }

Property Value

Type	Description
System.String

EnablePrintAndSign

Gets or sets a value indicating whether print and sign is enabled.

Declaration

public bool EnablePrintAndSign { get; set; }

Property Value

Type	Description
System.Boolean	Gets or sets a value of indicating whether to enable print and sign mode.

EnableReassign

Gets or sets a value indicating whether reassign is enabled.

Declaration

public bool EnableReassign { get; set; }

Property Value

Type	Description
System.Boolean	Gets or sets a value of indicating whether to enable reassign mode.By Default True.

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 of indicating whether to enable signing order.

Files

Gets or sets document uploaded file information.

Declaration

public List<DocumentFiles> Files { get; set; }

Property Value

Type	Description
List<DocumentFiles>	Gets or Sets document uploaded file information.

Labels

Gets or sets the Tag's Name.

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.

RecipientNotificationSettings

Gets or sets the Recipient Notification Settings.

Declaration

public RecipientNotificationSettings RecipientNotificationSettings { get; set; }

Property Value

Type	Description
RecipientNotificationSettings	Gets or sets the Recipient Notification Settings of the signer.

Roles

Gets or sets roles details.

Declaration

public List<RoleProperties> Roles { get; set; }

Property Value

Type	Description
List<RoleProperties>

SharedTemplateDetail

Gets or sets the shared template detail.

Declaration

public List<SharedTemplateDetail> SharedTemplateDetail { get; set; }

Property Value

Type	Description
List<SharedTemplateDetail>	Gets the value of shared template detail.

TemplateId

Gets or sets the template ID.

Declaration

public string TemplateId { get; set; }

Property Value

Type	Description
System.String	Gets or sets the document id.

TemplateLabels

Gets or sets the Tag's Name.

Declaration

public List<string> TemplateLabels { get; set; }

Property Value

Type	Description
List<System.String>

Methods

ToJson()

Returns the JSON string presentation of the object.

Declaration

public virtual string ToJson()

Returns

Type	Description
System.String	JSON string presentation of the object.