Class SendForSign
Send for Sign request DTO.
Implements
Namespace: BoldSign.Model
Assembly: BoldSign.Api.dll
Syntax
public class SendForSign : object, IDocumentUpload
Properties
| Improve this Doc View SourceAutoDetectFields
Gets or sets a value indicating whether to AutoDetect Fields for the document signer.
Declaration
public bool AutoDetectFields { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
BrandId
Gets or sets the brand id.
Declaration
public string BrandId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CC
Gets or sets document CC details.
Declaration
public IEnumerable<DocumentCC> CC { get; set; }
Property Value
Type | Description |
---|---|
IEnumerable<DocumentCC> |
DisableEmails
Gets or sets a value indicating whether to enable DisableEmails. When DisableEmails is enabled, Reminder is automatically ignored.
Declaration
public bool DisableEmails { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
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.
Declaration
public bool? DisableExpiryAlert { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
DisableSMS
Gets or sets a value indicating whether to enable SMS notification. When DisableSMS is enabled, Reminder is automatically ignored.
Declaration
public bool DisableSMS { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
DocumentDownloadOption
Gets or sets a value to customize how the documents are downloaded.
Declaration
public DocumentDownloadOption? DocumentDownloadOption { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<DocumentDownloadOption> |
DocumentInfo
Gets or sets a documentInfo.
Declaration
public IEnumerable<DocumentInfo> DocumentInfo { get; set; }
Property Value
Type | Description |
---|---|
IEnumerable<DocumentInfo> |
EnableEmbeddedSigning
Gets or sets a value indicating whether to enable EnableEmbeddedSigning. When EnableEmbeddedSigning is enabled, Reminder is automatically ignored.
Declaration
public bool EnableEmbeddedSigning { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnablePrintAndSign
Gets or sets a value indicating whether to enable print and sign mode.
Declaration
public bool EnablePrintAndSign { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnableReassign
Gets or sets a value indicating whether to enable reassign mode. By Default True.
Declaration
public bool EnableReassign { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnableSigningOrder
Gets or sets a value indicating whether to enable signing order for the document signer.
Declaration
public bool EnableSigningOrder { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ExpiryDateType
Gets or sets the expiry date type.
Declaration
public ExpiryDateType? ExpiryDateType { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<ExpiryDateType> |
ExpiryDays
Number of days after which the document will expire.
Declaration
public int ExpiryDays { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
ExpiryValue
Gets or sets the expiry value based on expiry date type.
Declaration
public long ExpiryValue { get; set; }
Property Value
Type | Description |
---|---|
System.Int64 |
Files
Gets or sets the files to be uploaded.
Declaration
public List<IDocumentFile> Files { get; set; }
Property Value
Type | Description |
---|---|
List<IDocumentFile> |
FileUrls
Gets or sets the File URLs to be uploaded.
Declaration
public List<Uri> FileUrls { get; set; }
Property Value
Type | Description |
---|---|
List<Uri> |
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.
Declaration
public bool? HideDocumentId { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
Labels
Gets or sets the labels.
Declaration
public List<string> Labels { get; set; }
Property Value
Type | Description |
---|---|
List<System.String> |
Message
Gets or sets common message for all the document recipients.
Declaration
public string Message { get; set; }
Property Value
Type | Description |
---|---|
System.String |
OnBehalfOf
Gets or sets the on behalf of email address.
Declaration
public string OnBehalfOf { get; set; }
Property Value
Type | Description |
---|---|
System.String |
RecipientNotificationSettings
Gets or sets the Recipient Notification Settings.
Declaration
public RecipientNotificationSettings RecipientNotificationSettings { get; set; }
Property Value
Type | Description |
---|---|
RecipientNotificationSettings |
ReminderSettings
Gets or sets the reminder settings for the signature request.
Declaration
public ReminderSettings ReminderSettings { get; set; }
Property Value
Type | Description |
---|---|
ReminderSettings |
Signers
Gets or sets document Signers details.
Declaration
public IEnumerable<DocumentSigner> Signers { get; set; }
Property Value
Type | Description |
---|---|
IEnumerable<DocumentSigner> |
TextTagDefinitions
Gets or sets the text tags definitions declared in the list can be used in the document by using the definition ID.
Declaration
public List<TextTagDefinition> TextTagDefinitions { get; set; }
Property Value
Type | Description |
---|---|
List<TextTagDefinition> |
Title
Gets or sets title for the signature request.
Declaration
public string Title { get; set; }
Property Value
Type | Description |
---|---|
System.String |
UseTextTags
Gets or sets a value indicating whether to convert the text tags to form fields.
Declaration
public bool UseTextTags { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |