Class DocumentSignerDetails

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

Inheritance

System.Object

DocumentSignerDetails

Namespace: BoldSign.Model

Assembly: BoldSign.Api.dll

Syntax

public class DocumentSignerDetails : object

Constructors

| Improve this Doc View Source

DocumentSignerDetails(String, String, String, SignerStatus, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, SignerType, Nullable<Boolean>, String, List<DocumentFormFields>, String, String, Languages, String, AuthenticationType, PhoneNumber)

Initializes a new instance of the DocumentSignerDetails class.

Declaration

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

Parameters

Type	Name	Description
System.String	signerName	Gets or sets the signer name..
System.String	signerRole	Gets or sets the signer role..
System.String	signerEmail	Gets or sets the signer email..
SignerStatus	status	status.
System.Nullable<System.Boolean>	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. (default to false).
System.Nullable<System.Boolean>	enableEmailOTP	Gets or sets a value indicating whether email OTP authentication is enabled..
System.Nullable<System.Boolean>	isDeliveryFailed	Gets or sets a value indicating whether delivery is failed. (default to false).
System.Nullable<System.Boolean>	isViewed	Gets or sets a value indicating whether is viewed. (default to false).
System.Nullable<System.Int32>	order	Gets or sets the order of the signer. (default to 0).
SignerType	signerType	signerType.
System.Nullable<System.Boolean>	isReassigned	Gets or sets a value indicating whether is reassigned..
System.String	privateMessage	<br>Gets or sets private message for the current signer. <br>Available only when the user is signer and have a privateMessage from sender..
List<DocumentFormFields>	formFields	Gets or sets the form fields..
System.String	hostEmail	Gets or sets the host email.
System.String	hostName	Gets or sets the host name.
Languages	language	Gets or sets the Language.
System.String	locale	Gets or sets the locale.
AuthenticationType	authenticationType	Authentication type.
PhoneNumber	phoneNumber	The phone number.

Properties

| Improve this Doc View Source

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	Gets or sets a value indicating whether gets or sets the allow field configuration.

| Improve this Doc View Source

AuthenticationType

Gets or sets a value of authentication type.

Declaration

public AuthenticationType AuthenticationType { get; set; }

Property Value

Type	Description
AuthenticationType	Gets or sets the authentication type.

| Improve this Doc View Source

EnableAccessCode

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

Declaration

public bool? EnableAccessCode { get; }

Property Value

Type	Description
System.Nullable<System.Boolean>	Gets a value indicating whether authentication is enabled for the signer.

| Improve this Doc View Source

EnableEmailOTP

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

Declaration

public bool? EnableEmailOTP { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	Gets or sets a value indicating whether email OTP authentication is enabled.

| Improve this Doc View Source

FormFields

Gets or sets the form fields in the document.

Declaration

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

Property Value

Type	Description
List<DocumentFormFields>	Gets or sets the form fields.

| Improve this Doc View Source

HostEmail

Gets or sets the host email.

Declaration

public string HostEmail { get; set; }

Property Value

Type	Description
System.String	Gets the value of host email.

| Improve this Doc View Source

HostName

Gets or sets the host name.

Declaration

public string HostName { get; set; }

Property Value

Type	Description
System.String	Gets the value of host name.

| Improve this Doc View Source

IsAuthenticationFailed

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

Declaration

public bool? IsAuthenticationFailed { get; set; }

Property Value

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

| Improve this Doc View Source

IsDeliveryFailed

Gets or sets a value indicating whether delivery is failed.

Declaration

public bool? IsDeliveryFailed { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	Gets or sets a value indicating whether delivery is failed.

| Improve this Doc View Source

IsReassigned

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

Declaration

public bool? IsReassigned { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	Gets or sets a value indicating whether is reassigned.

| Improve this Doc View Source

IsViewed

Gets or sets a value indicating whether document is viewed.

Declaration

public bool? IsViewed { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	Gets or sets a value indicating whether is viewed.

| Improve this Doc View Source

Language

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

Declaration

public Languages Language { get; set; }

Property Value

Type	Description
Languages

| Improve this Doc View Source

Locale

Gets or sets the locale.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String	Gets the value of locale.

| Improve this Doc View Source

Order

Gets or sets the order of the signers.

Declaration

public int? Order { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	Gets or sets the order of the signer.

| Improve this Doc View Source

PhoneNumber

Gets or sets the phone number.

Declaration

public PhoneNumber PhoneNumber { get; set; }

Property Value

Type	Description
PhoneNumber	Gets or sets phone number.

| Improve this Doc View Source

PrivateMessage

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

Declaration

public string PrivateMessage { get; set; }

Property Value

Type	Description
System.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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

SignerEmail

Gets or sets the signer email.

Declaration

public string SignerEmail { get; set; }

Property Value

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

| Improve this Doc View Source

SignerName

Gets or sets the signer name.

Declaration

public string SignerName { get; set; }

Property Value

Type	Description
System.String	Gets or sets the signer name.

| Improve this Doc View Source

SignerRole

Gets or sets the signer role.

Declaration

public string SignerRole { get; set; }

Property Value

Type	Description
System.String	Gets or sets the signer role.

| Improve this Doc View Source

SignerType

Gets or Sets SignerType.

Declaration

public SignerType SignerType { get; set; }

Property Value

Type	Description
SignerType

| Improve this Doc View Source

Status

Gets or Sets signer status.

Declaration

public SignerStatus Status { get; set; }

Property Value

Type	Description
SignerStatus

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