Class DocumentSigner

Namespace

BoldSign.Model

Assembly

BoldSign.Api.dll

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

[DataContract]
public class DocumentSigner

Inheritance

object

DocumentSigner

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DocumentSigner()

Initializes a new instance of the DocumentSigner class.

public DocumentSigner()

DocumentSigner(string, SignerType, string, string, string, int, bool, List<FormField>, string, Locales, AuthenticationType, PhoneNumber)

Initializes a new instance of the DocumentSigner class.

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

Parameters

signerName string

Gets or sets the signer Name. (required).

signerType SignerType

signerType.

signerEmail string

Gets or sets the signer Email.

privateMessage string

Gets or sets the private message.

authenticationCode string

Gets or sets the authentication code.

signerOrder int

Gets or sets the signer order.

enableEmailOTP bool

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

formFields List<FormField>

Gets or sets the formFields.

hostEmail string

Gets or sets the hostEmail.

locale Locales

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, int, bool, SignerType, List<FormField>, string, Languages, AuthenticationType, PhoneNumber)

Initializes a new instance of the DocumentSigner class.

[Obsolete("The language-based constructor is deprecated. Please use the new constructor: DocumentSigner(string signerName, SignerType signerType = BoldSign.Model.SignerType.Signer, string signerEmail = default, string privateMessage = default, string authenticationCode = default, int signerOrder = default, bool enableEmailOTP = default, List<FormField> formFields = default(List<FormField>), string hostEmail = default, Locales locale = Locales.EN)")]
public DocumentSigner(string name, string emailAddress, string privateMessage = null, string authenticationCode = null, int signerOrder = 0, bool enableEmailOTP = false, SignerType signerType = SignerType.Signer, List<FormField> formFields = null, string hostEmail = null, Languages language = Languages.None, AuthenticationType authenticationType = AuthenticationType.None, PhoneNumber phoneNumber = null)

Parameters

name string

Gets or sets the name. (required).

emailAddress string

Gets or sets the email address. (required).

privateMessage string

Gets or sets the private message..

authenticationCode string

Gets or sets the authentication code..

signerOrder int

Gets or sets the signer order..

enableEmailOTP bool

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

signerType SignerType

signerType.

formFields List<FormField>

Gets or sets the formFields..

hostEmail string

Gets or sets the hostEmail.

language Languages

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.

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

Property Value

bool

AuthenticationCode

Gets or sets the authentication code.

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

Property Value

string

Gets or sets the authentication code.

AuthenticationRetryCount

Gets or sets the authentication retry count.

[DataMember(Name = "authenticationRetryCount", EmitDefaultValue = false)]
public int? AuthenticationRetryCount { get; set; }

Property Value

int?

AuthenticationType

Gets or sets the authentication type. Defaults to None.

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

Property Value

AuthenticationType

DeliveryMode

Gets or Sets the delivery mode of the signer.

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

Property Value

DeliveryMode

EmailAddress

Gets or sets the email address of the signer.

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

Property Value

string

Gets or sets the email address.

EnableEmailOTP

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

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

Property Value

bool

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

FormFields

Gets or sets form fields assigned to signer.

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

Property Value

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.

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

Property Value

string

Gets or sets the Host email address.

Language

Gets or sets the signer language.

[DataMember(Name = "language", EmitDefaultValue = true)]
[Obsolete("Language is deprecated, please use Locale instead.")]
public Languages Language { get; set; }

Property Value

Languages

Gets or sets the language of the signer.

Locale

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

[DataMember(Name = "locale", EmitDefaultValue = false)]
public Locales Locale { get; set; }

Property Value

Locales

Name

Gets or sets the signer name.

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

Property Value

string

Gets or sets the name.

PhoneNumber

Gets or sets the phone number.

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

Property Value

PhoneNumber

PrivateMessage

Gets or sets the private message.

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

Property Value

string

Gets or sets the private message.

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.

SignerOrder

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

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

Property Value

int

Gets or sets the signer order.

SignerType

Gets or sets the type of signer.

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

Property Value

SignerType?

Methods

ToJson()

Returns the JSON string presentation of the object

public virtual string ToJson()

Returns

string

JSON string presentation of the object