Table of Contents

Class TemplateProperties

Namespace
BoldSign.Model
Assembly
BoldSign.Api.dll

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.

[DataContract]
public class TemplateProperties
Inheritance
TemplateProperties
Inherited Members

Constructors

TemplateProperties(string, string, string, string, string, List<TemplateFiles>, List<RoleProperties>, List<TemplateFormField>, List<string>, string, bool, bool, bool, bool, bool, bool, bool, long?, TemplateSenderDetail, List<SharedTemplateDetail>, IEnumerable<DocumentInfo>, DocumentDownloadOption, List<string>, List<string>, BehalfOf)

Initializes a new instance of the TemplateProperties class.

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

Parameters

templateId string

Gets or sets the template id..

title string

Gets or sets the title..

description string

Gets or Sets description..

documentTitle string

Gets or Sets documentTitle..

documentMessage string

Gets or Sets documentMessage..

files List<TemplateFiles>

Gets or Sets document uploaded file information..

roles List<RoleProperties>

Gets or sets the roles..

commonFields List<TemplateFormField>

Gets or sets the common fields..

cCDetails List<string>

Gets or sets the CC details..

brandId string

Gets or sets the brand id..

allowMessageEditing bool

Gets or sets the allowMessageEditing..

allowNewRoles bool

Gets or sets the allowNewRoles..

allowNewFiles bool

Gets or sets the allowNewFiles..

allowModifyFiles bool

Gets or sets the allowModifyFiles..

enableReassign bool

Gets or sets a value indicating whether to Enable Reassign.By Default True..

enablePrintAndSign bool

Gets or sets a value indicating whether to Enable Print And Sign.

enableSigningOrder bool

Gets or sets a value indicating whether to enable signing order..

createdDate long?

Gets or sets the createdDate..

createdBy TemplateSenderDetail

createdBy.

sharedTemplateDetail List<SharedTemplateDetail>

sharedTemplateDetail..

documentInfo IEnumerable<DocumentInfo>

Gets or sets the documentInfo..

documentDownloadOption DocumentDownloadOption

Gets or sets the documentDownloadOption.

labels List<string>

Gets or sets the documentLabels.

templateLabels List<string>

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.

[DataMember(Name = "allowMessageEditing", EmitDefaultValue = false)]
public bool? AllowMessageEditing { get; set; }

Property Value

bool?

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.

[DataMember(Name = "allowModifyFiles", EmitDefaultValue = false)]
public bool? AllowModifyFiles { get; set; }

Property Value

bool?

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.

[DataMember(Name = "allowNewFiles", EmitDefaultValue = false)]
public bool? AllowNewFiles { get; set; }

Property Value

bool?

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.

[DataMember(Name = "allowNewRoles", EmitDefaultValue = false)]
public bool? AllowNewRoles { get; set; }

Property Value

bool?

Gets or sets a value of indicating whether to enable signing order.

BehalfOf

Gets or sets the behalf of details.

[DataMember(Name = "behalfOf", EmitDefaultValue = false)]
public BehalfOf BehalfOf { get; set; }

Property Value

BehalfOf

Gets the value of behalf of details.

BrandId

Gets or sets the Brand Id.

[DataMember(Name = "brandId", EmitDefaultValue = false)]
public string BrandId { get; set; }

Property Value

string

Gets or sets the brand id.

CCDetails

Gets or sets the CC details.

[DataMember(Name = "cCDetails", EmitDefaultValue = false)]
public List<string> CCDetails { get; set; }

Property Value

List<string>

Gets the value of CC details.

CommonFields

Gets or sets common fields.

[DataMember(Name = "commonFields", EmitDefaultValue = true)]
public IEnumerable<TemplateFormField> CommonFields { get; set; }

Property Value

IEnumerable<TemplateFormField>

CreatedBy

Gets or sets the template createdBy details.

[DataMember(Name = "createdBy", EmitDefaultValue = false)]
public TemplateSenderDetail CreatedBy { get; set; }

Property Value

TemplateSenderDetail

Gets the value of template createdBy details.

CreatedDate

Gets or sets the created date of a document.

[DataMember(Name = "createdDate", EmitDefaultValue = false)]
public long? CreatedDate { get; set; }

Property Value

long?

Gets or sets the createdDate.

DocumentDescription

Gets or sets template description.

[DataMember(Name = "documentDescription", EmitDefaultValue = false)]
public string DocumentDescription { get; set; }

Property Value

string

Gets or Sets template description.

DocumentDownloadOption

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

[DataMember(Name = "documentDownloadOption", EmitDefaultValue = true)]
public DocumentDownloadOption DocumentDownloadOption { get; set; }

Property Value

DocumentDownloadOption

DocumentInfo

Gets or sets a documentInfo.

[JsonProperty("documentInfo")]
public IEnumerable<DocumentInfo> DocumentInfo { get; set; }

Property Value

IEnumerable<DocumentInfo>

DocumentMessage

Gets or sets template message.

[DataMember(Name = "documentMessage", EmitDefaultValue = false)]
public string DocumentMessage { get; set; }

Property Value

string

Gets or Sets template message.

DocumentTitle

Gets or sets document title.

[DataMember(Name = "documentTitle", EmitDefaultValue = false)]
public string DocumentTitle { get; set; }

Property Value

string

EnablePrintAndSign

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

[DataMember(Name = "enablePrintAndSign", EmitDefaultValue = false)]
public bool EnablePrintAndSign { get; set; }

Property Value

bool

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.

[DataMember(Name = "enableReassign", EmitDefaultValue = false)]
public bool EnableReassign { get; set; }

Property Value

bool

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.

[DataMember(Name = "enableSigningOrder", EmitDefaultValue = false)]
public bool EnableSigningOrder { get; set; }

Property Value

bool

Gets or sets a value of indicating whether to enable signing order.

Files

Gets or sets document uploaded file information.

[DataMember(Name = "files", EmitDefaultValue = false)]
public List<TemplateFiles> Files { get; set; }

Property Value

List<TemplateFiles>

Gets or Sets document uploaded file information.

FormGroups

Gets or sets the form groups.

[DataMember(Name = "formGroups", EmitDefaultValue = false)]
public List<FormGroup> FormGroups { get; set; }

Property Value

List<FormGroup>

Gets or sets the form groups.

Labels

Gets or sets the Tag's Name.

[DataMember(Name = "labels", EmitDefaultValue = false)]
[JsonProperty("labels")]
public List<string> Labels { get; set; }

Property Value

List<string>

MessageTitle

Gets or sets the message title.

[DataMember(Name = "messageTitle", EmitDefaultValue = false)]
public string MessageTitle { get; set; }

Property Value

string

Gets or sets the messageTitle.

RecipientNotificationSettings

Gets or sets the Recipient Notification Settings.

[DataMember(Name = "recipientNotificationSettings", EmitDefaultValue = false)]
public RecipientNotificationSettings RecipientNotificationSettings { get; set; }

Property Value

RecipientNotificationSettings

Gets or sets the Recipient Notification Settings of the signer.

Roles

Gets or sets roles details.

[DataMember(Name = "roles", EmitDefaultValue = false)]
public List<RoleProperties> Roles { get; set; }

Property Value

List<RoleProperties>

SharedTemplateDetail

Gets or sets the shared template detail.

[DataMember(Name = "sharedTemplateDetail", EmitDefaultValue = false)]
public List<SharedTemplateDetail> SharedTemplateDetail { get; set; }

Property Value

List<SharedTemplateDetail>

Gets the value of shared template detail.

TemplateId

Gets or sets the template ID.

[DataMember(Name = "templateId", EmitDefaultValue = false)]
public string TemplateId { get; set; }

Property Value

string

Gets or sets the document id.

TemplateLabels

Gets or sets the Tag's Name.

[DataMember(Name = "templateLabels", EmitDefaultValue = false)]
[JsonProperty("templateLabels")]
public List<string> TemplateLabels { get; set; }

Property Value

List<string>

Methods

ToJson()

Returns the JSON string presentation of the object.

public virtual string ToJson()

Returns

string

JSON string presentation of the object.