Class TemplateSignerDetails

Namespace

BoldSign.Model

Assembly

BoldSign.Api.dll

The template signer details have functions to perform actions like enabling access code for the signer, setting up the host’s email, name and user ID, defining the value for the order of the signers, and so on.

[DataContract]
public class TemplateSignerDetails

Inheritance

object

TemplateSignerDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TemplateSignerDetails(string, string, string, SignerStatus?, bool, bool, string, int, SignerType?, string, string, string, ImposeAuthentication)

Initializes a new instance of the TemplateSignerDetails class.

public TemplateSignerDetails(string signerName = null, string signerRole = null, string signerEmail = null, SignerStatus? status = null, bool enableAccessCode = false, bool enableEmailOTP = false, string userId = null, int order = 0, SignerType? signerType = null, string hostEmail = null, string hostName = null, string hostUserId = null, ImposeAuthentication imposeAuthentication = ImposeAuthentication.None)

Parameters

signerName string

Gets or sets name of the signer..

signerRole string

Gets or sets role of the signer..

signerEmail string

Gets or sets email address of the signer..

status SignerStatus?

status.

enableAccessCode bool

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

enableEmailOTP bool

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

userId string

Gets or sets the user id..

order int

Gets or sets the value is used to define the siging order of the signer..

signerType SignerType?

signerType.

hostEmail string

Gets or sets the host user email..

hostName string

Gets or sets the host user name..

hostUserId string

Gets or sets the host user id..

imposeAuthentication ImposeAuthentication

impose Authentication.

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

DeliveryMode

Gets or Sets a delivery mode.

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

Property Value

DeliveryMode

Gets or sets the delivery mode.

EnableAccessCode

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

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

Property Value

bool

Gets or sets 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.

HostEmail

Gets or sets the host user email.

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

Property Value

string

Gets or sets the host user email.

HostName

Gets or sets the host user name.

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

Property Value

string

Gets or sets the host user name.

HostUserId

Gets or sets the host user an ID.

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

Property Value

string

Gets or sets the host user id.

ImposeAuthentication

Gets or sets a value of impose authentication.

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

Property Value

ImposeAuthentication

Gets or sets the impose authentication.

Order

Gets or sets the value is used to define the siging order of the signers.

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

Property Value

int

Gets or sets the value is used to define the signing 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 a phone number.

SignerEmail

Gets or sets email address of the signer.

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

Property Value

string

Gets or sets email address of the signer.

SignerName

Gets or sets name of the signer.

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

Property Value

string

Gets or sets name of the signer.

SignerRole

Gets or sets role of the signer.

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

Property Value

string

Gets or sets role of the signer.

SignerType

Gets or Sets SignerType.

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

Property Value

SignerType?

Status

Gets or Sets Status of a signer.

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

Property Value

SignerStatus?

UserId

Gets or sets the user Id.

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

Property Value

string

Gets or sets the user id.

Methods

ToJson()

Returns the JSON string presentation of the object

public virtual string ToJson()

Returns

string

JSON string presentation of the object