Class MergeAndSendForSign

The merge and send for sign.

Inheritance

System.Object

MergeAndSendForSign

Namespace: BoldSign.Api.Model

Assembly: BoldSign.Api.dll

Syntax

public class MergeAndSendForSign : object

Constructors

| Improve this Doc View Source

MergeAndSendForSign(String[], String, String, List<Roles>, String, List<String>, Boolean, Nullable<Boolean>, ReminderSettings, IEnumerable<DocumentCC>, Int32, Int64, Nullable<ExpiryDateType>, Boolean, Boolean, Boolean, Nullable<Boolean>, IEnumerable<DocumentInfo>, String, Int32[])

Initializes a new instance of the MergeAndSendForSign class.

Declaration

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

Parameters

Type	Name	Description
System.String[]	templateIds	Gets or sets the template ids.
System.String	title	Gets or sets the title..
System.String	message	Gets or sets the message..
List<Roles>	roles	Gets or sets the roles..
System.String	brandId	Gets or sets the brandId..
List<System.String>	labels	Gets or sets the labels.
System.Boolean	disableEmails	Gets or sets the disableEmails.
System.Nullable<System.Boolean>	hideDocumentId	Gets or sets the hideDocumentId.
ReminderSettings	reminderSettings	Gets or sets the reminderSettings.
IEnumerable<DocumentCC>	cc	Gets or sets the cc.
System.Int32	expiryDays	Gets or sets the expiryDays.
System.Int64	expiryValue	Gets or sets the expiry value based on expiry date type.
System.Nullable<ExpiryDateType>	expiryDateType	Gets or sets the expiry date type.
System.Boolean	disableExpiryAlert	Gets or sets the disableExpiryAlert.
System.Boolean	enablePrintAndSign	Gets or sets the enablePrintAndSign.
System.Boolean	enableReassign	Gets or sets the enableReassign.
System.Nullable<System.Boolean>	enableSigningOrder	Gets or sets the enableSigningOrder.
IEnumerable<DocumentInfo>	documentInfo	Gets or sets the documentInfo.
System.String	onBehalfOf	Gets or sets the on behalf of email id.
System.Int32[]	roleRemovalIndices	Gets or sets the role removal indices.

Properties

| Improve this Doc View Source

BrandId

Gets or sets the brand id.

Declaration

public string BrandId { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

CC

Gets or sets document CC details.

Declaration

public IEnumerable<DocumentCC> CC { get; set; }

Property Value

Type	Description
IEnumerable<DocumentCC>

| Improve this Doc View Source

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.

Declaration

public bool DisableEmails { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

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.Boolean

| Improve this Doc View Source

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>

| Improve this Doc View Source

DocumentInfo

Gets or sets a documentInfo.

Declaration

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

Property Value

Type	Description
IEnumerable<DocumentInfo>

| Improve this Doc View Source

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

| Improve this Doc View Source

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

| Improve this Doc View Source

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.Nullable<System.Boolean>

| Improve this Doc View Source

ExpiryDateType

Gets or sets the expiry date type.

Declaration

public ExpiryDateType? ExpiryDateType { get; set; }

Property Value

Type	Description
System.Nullable<ExpiryDateType>

| Improve this Doc View Source

ExpiryDays

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

Declaration

public int ExpiryDays { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

ExpiryValue

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

Declaration

public long ExpiryValue { get; set; }

Property Value

Type	Description
System.Int64

| Improve this Doc View Source

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>

| Improve this Doc View Source

Labels

Gets or sets the labels.

Declaration

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

Property Value

Type	Description
List<System.String>

| Improve this Doc View Source

Message

Gets or sets common message for all the document recipients.

Declaration

public string Message { get; set; }

Property Value

Type	Description
System.String	Gets or sets the message.

| Improve this Doc View Source

OnBehalfOf

Gets or sets the on behalf of mail id.

Declaration

public string OnBehalfOf { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ReminderSettings

Gets or sets the reminder settings for the signature request.

Declaration

public ReminderSettings ReminderSettings { get; set; }

Property Value

Type	Description
ReminderSettings

| Improve this Doc View Source

RemoveFormFields

Gets or sets remove form fields id.

Declaration

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

Property Value

Type	Description
List<System.String>

| Improve this Doc View Source

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}.

Declaration

public int[] RoleRemovalIndices { get; set; }

Property Value

Type	Description
System.Int32[]

| Improve this Doc View Source

Roles

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

Declaration

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

Property Value

Type	Description
List<Roles>	Gets or sets the roles.

| Improve this Doc View Source

TemplateIds

Gets or sets the template Ids.

Declaration

public string[] TemplateIds { get; set; }

Property Value

Type	Description
System.String[]	Gets or sets the template ids.

| Improve this Doc View Source

Title

Gets or sets title for the signature request.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String	Gets or sets the title.

Methods

| Improve this Doc View Source

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.