Class DocumentSigner

The signer properties include the authentication code for the singer, email address, name, role, and so on.

Inheritance

System.Object

DocumentSigner

Namespace: BoldSign.Model

Assembly: BoldSign.Api.dll

Syntax

public class DocumentSigner : object

Constructors

DocumentSigner()

Initializes a new instance of the DocumentSigner class.

Declaration

public DocumentSigner()

DocumentSigner(String, SignerType, String, String, String, Int32, Boolean, List<FormField>, String, Locales, AuthenticationType, PhoneNumber)

Initializes a new instance of the DocumentSigner class.

Declaration

public DocumentSigner(string signerName, SignerType signerType = default(SignerType), string signerEmail = null, string privateMessage = null, string authenticationCode = null, int signerOrder = null, bool enableEmailOTP = null, List<FormField> formFields = null, string hostEmail = null, Locales locale = Locales.EN, AuthenticationType authenticationType = default(AuthenticationType), PhoneNumber phoneNumber = null)

Parameters

Type	Name	Description
System.String	signerName	Gets or sets the signer Name. (required).
SignerType	signerType	signerType.
System.String	signerEmail	Gets or sets the signer Email.
System.String	privateMessage	Gets or sets the private message.
System.String	authenticationCode	Gets or sets the authentication code.
System.Int32	signerOrder	Gets or sets the signer order.
System.Boolean	enableEmailOTP	Gets or sets a value indicating whether to enable email OTP.
List<FormField>	formFields	Gets or sets the formFields.
System.String	hostEmail	Gets or sets the hostEmail.
Locales	locale	Gets or sets the locale.
AuthenticationType	authenticationType	Gets or sets the authentication type.
PhoneNumber	phoneNumber	Gets or sets the phone number.

DocumentSigner(String, String, String, String, Int32, Boolean, SignerType, List<FormField>, String, Languages, AuthenticationType, PhoneNumber)

Initializes a new instance of the DocumentSigner class.

Declaration

public DocumentSigner(string name, string emailAddress, string privateMessage = null, string authenticationCode = null, int signerOrder = null, bool enableEmailOTP = null, SignerType signerType = default(SignerType), List<FormField> formFields = null, string hostEmail = null, Languages language = default(Languages), AuthenticationType authenticationType = default(AuthenticationType), PhoneNumber phoneNumber = null)

Parameters

Type	Name	Description
System.String	name	Gets or sets the name. (required).
System.String	emailAddress	Gets or sets the email address. (required).
System.String	privateMessage	Gets or sets the private message..
System.String	authenticationCode	Gets or sets the authentication code..
System.Int32	signerOrder	Gets or sets the signer order..
System.Boolean	enableEmailOTP	Gets or sets a value indicating whether to enable email OTP..
SignerType	signerType	signerType.
List<FormField>	formFields	Gets or sets the formFields..
System.String	hostEmail	Gets or sets the hostEmail.
Languages	language	Gets or sets the Language.
AuthenticationType	authenticationType	Gets or sets the authentication type.
PhoneNumber	phoneNumber	Gets or sets the phone number.

Properties

AllowFieldConfiguration

Gets or sets a value indicating whether gets or sets the allow field configuration.

Declaration

public bool AllowFieldConfiguration { get; set; }

Property Value

Type	Description
System.Boolean

AuthenticationCode

Gets or sets the authentication code.

Declaration

public string AuthenticationCode { get; set; }

Property Value

Type	Description
System.String	Gets or sets the authentication code.

AuthenticationType

Gets or sets the authentication type. Defaults to None.

Declaration

public AuthenticationType AuthenticationType { get; set; }

Property Value

Type	Description
AuthenticationType

DeliveryMode

Gets or Sets the delivery mode of the signer.

Declaration

public DeliveryMode DeliveryMode { get; set; }

Property Value

Type	Description
DeliveryMode

EmailAddress

Gets or sets the email address of the signer.

Declaration

public string EmailAddress { get; set; }

Property Value

Type	Description
System.String	Gets or sets the email address.

EnableEmailOTP

Gets or sets a value indicating whether to enable email OTP for signing.

Declaration

public bool EnableEmailOTP { get; set; }

Property Value

Type	Description
System.Boolean	Gets or sets a value indicating whether to enable email OTP.

FormFields

Gets or sets form fields assigned to signer.

Declaration

public List<FormField> FormFields { get; set; }

Property Value

Type	Description
List<FormField>	Gets or sets document Form fields such as Sign, Checkbox, Radio buttons etc.

HostEmail

Gets or sets the Host email address of the Host.

Declaration

public string HostEmail { get; set; }

Property Value

Type	Description
System.String	Gets or sets the Host email address.

Language

Gets or sets the signer language.

Declaration

public Languages Language { get; set; }

Property Value

Type	Description
Languages	Gets or sets the language of the signer.

Locale

Gets or sets signer locale. Gets or sets the locale of the signer.

Declaration

public Locales Locale { get; set; }

Property Value

Type	Description
Locales

Name

Gets or sets the signer name.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String	Gets or sets the name.

PhoneNumber

Gets or sets the phone number.

Declaration

public PhoneNumber PhoneNumber { get; set; }

Property Value

Type	Description
PhoneNumber

PrivateMessage

Gets or sets the private message.

Declaration

public string PrivateMessage { get; set; }

Property Value

Type	Description
System.String	Gets or sets the private message.

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.

SignerOrder

Gets or sets the order in which the signers needs to sign the document.

Declaration

public int SignerOrder { get; set; }

Property Value

Type	Description
System.Int32	Gets or sets the signer order.

SignerType

Gets or sets the type of signer.

Declaration

public SignerType? SignerType { get; set; }

Property Value

Type	Description
System.Nullable<SignerType>

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