Table of Contents

Class DocumentSignerDetails

Namespace
BoldSign.Model
Assembly
BoldSign.Api.dll

The document signer details have properties that shows if the document delivery failed, reassigned, viewed, and so on.

[DataContract]
public class DocumentSignerDetails
Inheritance
DocumentSignerDetails
Inherited Members

Constructors

DocumentSignerDetails(string, string, string, SignerStatus, bool?, bool?, bool?, bool?, int?, SignerType, bool?, string, List<DocumentFormFields>, string, string, Languages, string, AuthenticationType, PhoneNumber, IdVerification)

Initializes a new instance of the DocumentSignerDetails class.

public DocumentSignerDetails(string signerName = null, string signerRole = null, string signerEmail = null, SignerStatus status = (SignerStatus)0, bool? isAuthenticationFailed = false, bool? enableEmailOTP = null, bool? isDeliveryFailed = false, bool? isViewed = false, int? order = 0, SignerType signerType = (SignerType)0, bool? isReassigned = null, string privateMessage = null, List<DocumentFormFields> formFields = null, string hostEmail = null, string hostName = null, Languages language = Languages.English, string locale = null, AuthenticationType authenticationType = AuthenticationType.None, PhoneNumber phoneNumber = null, IdVerification idVerification = null)

Parameters

signerName string

Gets or sets the signer name..

signerRole string

Gets or sets the signer role..

signerEmail string

Gets or sets the signer email..

status SignerStatus

status.

isAuthenticationFailed bool?

<br>Gets or sets a value indicating whether authentication is failed. <br>When value is null, Authentication is not enabled for the signer. <br>When value is true, Authentication is failed by the signer. <br>When value is false, Authentication is enabled for the signer. (default to false).

enableEmailOTP bool?

Gets or sets a value indicating whether email OTP authentication is enabled..

isDeliveryFailed bool?

Gets or sets a value indicating whether delivery is failed. (default to false).

isViewed bool?

Gets or sets a value indicating whether is viewed. (default to false).

order int?

Gets or sets the order of the signer. (default to 0).

signerType SignerType

signerType.

isReassigned bool?

Gets or sets a value indicating whether is reassigned..

privateMessage string

<br>Gets or sets private message for the current signer. <br>Available only when the user is signer and have a privateMessage from sender..

formFields List<DocumentFormFields>

Gets or sets the form fields..

hostEmail string

Gets or sets the host email.

hostName string

Gets or sets the host name.

language Languages

Gets or sets the Language.

locale string

Gets or sets the locale.

authenticationType AuthenticationType

Authentication type.

phoneNumber PhoneNumber

The phone number.

idVerification IdVerification

Gets or sets id verification details.

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

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

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 a value of authentication type.

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

Property Value

AuthenticationType

Gets or sets the authentication type.

DeliveryMode

Gets or Sets a delivery mode.

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

Property Value

DeliveryMode

EnableAccessCode

Gets a value indicating whether authentication is enabled for the signer.

[DataMember(Name = "enableAccessCode", EmitDefaultValue = false)]
public bool? EnableAccessCode { get; }

Property Value

bool?

Gets a value indicating whether authentication is enabled for the signer.

EnableEmailOTP

Gets or sets a value indicating whether email OTP authentication is enabled.

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

Property Value

bool?

Gets or sets a value indicating whether email OTP authentication is enabled.

EnableQes

Gets or sets the enableQes.

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

Property Value

bool

FormFields

Gets or sets the form fields in the document.

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

Property Value

List<DocumentFormFields>

Gets or sets the form fields.

HostEmail

Gets or sets the host email.

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

Property Value

string

Gets the value of host email.

HostName

Gets or sets the host name.

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

Property Value

string

Gets the value of host name.

IdVerification

Gets or sets the id verification details.

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

Property Value

IdVerification

Gets or sets id verification details.

IsAuthenticationFailed

<br>Gets or sets a value indicating whether authentication is failed. <br>When value is null, Authentication is not enabled for the signer. <br>When value is true, Authentication is failed by the signer. <br>When value is false, Authentication is enabled for the signer.

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

Property Value

bool?

<br>Gets or sets a value indicating whether authentication is failed. <br>When value is null, Authentication is not enabled for the signer. <br>When value is true, Authentication is failed by the signer. <br>When value is false, Authentication is enabled for the signer.

IsDeliveryFailed

Gets or sets a value indicating whether delivery is failed.

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

Property Value

bool?

Gets or sets a value indicating whether delivery is failed.

IsReassigned

Gets or sets a value indicating whether document signer is reassigned.

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

Property Value

bool?

Gets or sets a value indicating whether is reassigned.

IsViewed

Gets or sets a value indicating whether document is viewed.

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

Property Value

bool?

Gets or sets a value indicating whether is viewed.

Language

Gets or sets Languages such as English, French, Spanish, German.

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

Property Value

Languages

Locale

Gets or sets the locale.

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

Property Value

string

Gets the value of locale.

Order

Gets or sets the order of the signers.

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

Property Value

int?

Gets or sets the order of the signer.

PhoneNumber

Gets or sets the phone number.

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

Property Value

PhoneNumber

Gets or sets phone number.

PrivateMessage

<br>Gets or sets private message for the current signer. <br>Available only when the user is signer and has a privateMessage from sender.

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

Property Value

string

<br>Gets or sets private message for the current signer. <br>Available only when the user is signer and have a private message from sender.

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.

SignerAuthenticationSettings

Gets or sets the authentication settings for the signer.

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

Property Value

SignerAuthenticationSettings

SignerEmail

Gets or sets the signer email.

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

Property Value

string

Gets or sets the signer email.

SignerName

Gets or sets the signer name.

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

Property Value

string

Gets or sets the signer name.

SignerRole

Gets or sets the signer role.

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

Property Value

string

Gets or sets the signer role.

SignerType

Gets or Sets SignerType.

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

Property Value

SignerType

Status

Gets or Sets signer status.

[DataMember(Name = "status", EmitDefaultValue = false)]
public SignerStatus Status { get; set; }

Property Value

SignerStatus

Methods

ToJson()

Returns the JSON string presentation of the object

public virtual string ToJson()

Returns

string

JSON string presentation of the object