Class DocumentSignerProperties

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

Inheritance
System.Object
DocumentSignerProperties
Namespace: BoldSign.Model
Assembly: BoldSign.Api.dll
Syntax
public class DocumentSignerProperties : object

Constructors

| Improve this Doc View Source

DocumentSignerProperties(String, String, Nullable<SignerStatus>, Nullable<Boolean>, Int32, String)

Initializes a new instance of the DocumentSignerProperties class.

Declaration
public DocumentSignerProperties(string signerEmail = null, string signerName = null, SignerStatus? status = null, bool? isAuthenticationFailed, int order = 0, string privateMessage = null)
Parameters
Type Name Description
System.String signerEmail

Gets or sets the signer email..
System.String signerName

Gets or sets the signer name..
System.Nullable<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.Int32 order

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

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

Properties

| Improve this Doc View Source

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.

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

Order

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

Declaration
public int Order { get; set; }
Property Value
Type Description
System.Int32

Gets or sets the signer order.
| Improve this Doc View Source

PrivateMessage

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

Declaration
public string PrivateMessage { get; set; }
Property Value
Type Description
System.String

<br>Gets or sets the private message. <br>Available only when the user is document sender or sender admin.
| 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

Status

Gets or Sets signer status.

Declaration
public SignerStatus? Status { get; set; }
Property Value
Type Description
System.Nullable<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