Table of Contents

Class SendForSignFromTemplate

Namespace
BoldSign.Model
Assembly
BoldSign.Api.dll

Return send for signature template details in which the document is in the form of.

[DataContract]
public class SendForSignFromTemplate : IDocumentUpload
Inheritance
SendForSignFromTemplate
Implements
Derived
Inherited Members

Constructors

SendForSignFromTemplate(string, string, string, List<Roles>, string, List<string>, bool, bool?, ReminderSettings, IEnumerable<DocumentCC>, int, long, ExpiryDateType?, bool?, bool, bool?, bool?, IEnumerable<DocumentInfo>, string, int[], DocumentDownloadOption?)

Initializes a new instance of the SendForSignFromTemplate class.

public SendForSignFromTemplate(string templateId = null, string title = null, string message = null, List<Roles> roles = null, string brandId = null, List<string> labels = null, bool disableEmails = false, bool? hideDocumentId = null, ReminderSettings reminderSettings = null, IEnumerable<DocumentCC> cc = null, int expiryDays = 0, long expiryValue = 60, ExpiryDateType? expiryDateType = null, bool? disableExpiryAlert = null, bool enablePrintAndSign = false, bool? enableReassign = null, bool? enableSigningOrder = null, IEnumerable<DocumentInfo> documentInfo = null, string onBehalfOf = null, int[] roleRemovalIndices = null, DocumentDownloadOption? documentDownloadOption = null)

Parameters

templateId string

Gets or sets the document id..

title string

Gets or sets the title..

message string

Gets or sets the message..

roles List<Roles>

Gets or sets the roles..

brandId string

Gets or sets the brandId..

labels List<string>

Gets or sets the labels.

disableEmails bool

Gets or sets the disableEmails.

hideDocumentId bool?

Gets or sets the hideDocumentId.

reminderSettings ReminderSettings

Gets or sets the reminderSettings.

cc IEnumerable<DocumentCC>

Gets or sets the cc.

expiryDays int

Gets or sets the expiryDays.

expiryValue long

Gets or sets the expiry value based on expiry date type.

expiryDateType ExpiryDateType?

Gets or sets the expiry date type.

disableExpiryAlert bool?

Gets or sets the disableExpiryAlert.

enablePrintAndSign bool

Gets or sets the enablePrintAndSign.

enableReassign bool?

Gets or sets the enableReassign.

enableSigningOrder bool?

Gets or sets the enableSigningOrder.

documentInfo IEnumerable<DocumentInfo>

Gets or sets the documentInfo.

onBehalfOf string
roleRemovalIndices int[]

Gets or sets the role removal indices.

documentDownloadOption DocumentDownloadOption?

Gets or sets the document download option.

Properties

AllowScheduledSend

Gets or sets a value indicating whether to show send later option in embedded page.

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

Property Value

bool

BrandId

Gets or sets the brand id.

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

Property Value

string

CC

Gets or sets document CC details.

[DataMember(Name = "cc", EmitDefaultValue = true)]
public IEnumerable<DocumentCC> CC { get; set; }

Property Value

IEnumerable<DocumentCC>

DisableEmails

Gets or sets a value indicating whether to enable or disable emails.When disable emails is set to true, all the status emails and completed document email will be stopped, and reminder is also automatically ignored.

[DataMember(Name = "disableEmails", EmitDefaultValue = true)]
public bool DisableEmails { get; set; }

Property Value

bool

DisableExpiryAlert

Gets or sets a value indicating whether Disableexpiryalert is true or false. This property will send the expiry alert email before the day of expiry for the pending signers. If the document expires in one day, the email will be sent before 2 hours of the expiry.

[DataMember(Name = "disableExpiryAlert", EmitDefaultValue = true)]
public bool? DisableExpiryAlert { get; set; }

Property Value

bool?

DisableSMS

Gets or sets a value indicating whether to enable SMS notification.When disable sms is set to true, all the status sms and completed document sms will be stopped, and reminder is also automatically ignored.

[DataMember(Name = "disableSMS", EmitDefaultValue = true)]
public bool DisableSMS { get; set; }

Property Value

bool

DocumentDownloadOption

Gets or sets a value to customize how the documents are downloaded.

[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>

DownloadFileName

Gets or sets the download file name.

[DataMember(Name = "downloadFileName", EmitDefaultValue = true)]
public string DownloadFileName { get; set; }

Property Value

string

EnableAuditTrailLocalization

Gets or sets a value indicating whether to enable a localization support for audit trail.

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

Property Value

bool?

EnablePrintAndSign

Gets or sets a value indicating whether to enable print and sign mode.

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

Property Value

bool

EnableReassign

Gets or sets a value indicating whether to enable reassign mode. By Default True.

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

Property Value

bool?

EnableSigningOrder

Gets or sets a value indicating whether to enable signing order for the document signer.

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

Property Value

bool?

ExpiryDateType

Gets or sets the expiry date type.

[DataMember(Name = "expiryDateType", EmitDefaultValue = false)]
public ExpiryDateType? ExpiryDateType { get; set; }

Property Value

ExpiryDateType?

ExpiryDays

Gets or sets number of days after which the document will expire.

[Obsolete("ExpiryDays is deprecated, please use ExpiryValue instead.")]
[DataMember(Name = "expiryDays", EmitDefaultValue = true)]
public int ExpiryDays { get; set; }

Property Value

int

ExpiryValue

Gets or sets the value when the document should get expired.

[DataMember(Name = "expiryValue", EmitDefaultValue = false)]
public long ExpiryValue { get; set; }

Property Value

long

FileUrls

Gets or sets the file urls.

[JsonProperty("fileUrls")]
public List<Uri> FileUrls { get; set; }

Property Value

List<Uri>

Files

Gets or sets the files.

[JsonIgnore]
public List<IDocumentFile> Files { get; set; }

Property Value

List<IDocumentFile>

FormGroups

Gets or sets form group values for grouped form fields.

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

Property Value

List<FormGroup>

HideDocumentId

Gets or sets a value indicating whether to remove the document ID watermark from all the PDF pages of the document. Default is false.

[DataMember(Name = "hideDocumentId", EmitDefaultValue = true)]
public bool? HideDocumentId { get; set; }

Property Value

bool?

Labels

Gets or sets the labels.

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

Property Value

List<string>

Message

Gets or sets common message for all the document recipients.

[DataMember(Name = "message", EmitDefaultValue = true)]
public string Message { get; set; }

Property Value

string

Gets or sets the message.

MetaData

Gets or sets the metadata of the document.

[DataMember(Name = "metaData", EmitDefaultValue = true)]
public Dictionary<string, string> MetaData { get; set; }

Property Value

Dictionary<string, string>

OnBehalfOf

Gets or sets the on behalf of mail id.

[DataMember(Name = "onBehalfOf", EmitDefaultValue = true)]
public string OnBehalfOf { get; set; }

Property Value

string

RecipientNotificationSettings

Gets or sets the Recipient Notification Settings.

[JsonProperty("recipientNotificationSettings")]
[Display(Description = "Recipient Notification Settings of the Template.")]
public RecipientNotificationSettings RecipientNotificationSettings { get; set; }

Property Value

RecipientNotificationSettings

ReminderSettings

Gets or sets the reminder settings for the signature request.

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

Property Value

ReminderSettings

RemoveFormFields

Gets or sets remove form fields id.

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

Property Value

List<string>

RoleRemovalIndices

Gets or sets the role removal indices which starts from 1. For example, if you want to remove role 2 and 3 the input should be new []{2,3}.

[DataMember(Name = "roleRemovalIndices", EmitDefaultValue = false)]
public int[] RoleRemovalIndices { get; set; }

Property Value

int[]

Roles

Gets or sets the signer roles in a template of the document.

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

Property Value

List<Roles>

Gets or sets the roles.

ScheduledSendTime

Gets or sets the document scheduled date value.

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

Property Value

long?

TemplateId

Gets or sets the template Id.

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

Property Value

string

Gets or sets the document id.

Title

Gets or sets title for the signature request.

[DataMember(Name = "title", EmitDefaultValue = true)]
public string Title { get; set; }

Property Value

string

Gets or sets the title.

Methods

ToJson()

Returns the JSON string presentation of the object.

public virtual string ToJson()

Returns

string

JSON string presentation of the object