Class DocumentSignerProperties

Namespace

BoldSign.Model

Assembly

BoldSign.Api.dll

The document signer properties include authentication, order of signers, signer status, and so on.

[DataContract]
public class DocumentSignerProperties

Inheritance

object

DocumentSignerProperties

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DocumentSignerProperties(string, string, SignerStatus?, bool?, int, string)

Initializes a new instance of the DocumentSignerProperties class.

public DocumentSignerProperties(string signerEmail = null, string signerName = null, SignerStatus? status = null, bool? isAuthenticationFailed = false, int order = 0, string privateMessage = null)

Parameters

signerEmail string

Gets or sets the signer email..

signerName string

Gets or sets the signer name..

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

order int

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

privateMessage string

<br>Gets or sets the private message. <br>Available only when the user is document sender or sender admin..

Properties

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 = true)]
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.

Order

Gets or sets the signer order for a document or a template.

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

Property Value

int

Gets or sets the signer order.

PrivateMessage

<br>Gets or sets the private message. <br>Available only when the user is document sender or sender admin.

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

Property Value

string

<br>Gets or sets the private message. <br>Available only when the user is document sender or sender admin.

SignerEmail

Gets or sets the signer email.

[DataMember(Name = "signerEmail", EmitDefaultValue = true)]
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 = true)]
public string SignerName { get; set; }

Property Value

string

Gets or sets the signer name.

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