Class TemplateSignerDetails

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.

Inheritance

System.Object

TemplateSignerDetails

Namespace: BoldSign.Model

Assembly: BoldSign.Api.dll

Syntax

public class TemplateSignerDetails : object

Constructors

| Improve this Doc View Source

TemplateSignerDetails(String, String, String, Nullable<SignerStatus>, Boolean, Boolean, String, Int32, Nullable<SignerType>, String, String, String, ImposeAuthentication)

Initializes a new instance of the TemplateSignerDetails class.

Declaration

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

Parameters

Type	Name	Description
System.String	signerName	Gets or sets name of the signer..
System.String	signerRole	Gets or sets role of the signer..
System.String	signerEmail	Gets or sets email address of the signer..
System.Nullable<SignerStatus>	status	status.
System.Boolean	enableAccessCode	Gets or sets a value indicating whether authentication is enabled for the signer..
System.Boolean	enableEmailOTP	Gets or sets a value indicating whether email OTP authentication is enabled..
System.String	userId	Gets or sets the user id..
System.Int32	order	Gets or sets the value is used to define the siging order of the signer..
System.Nullable<SignerType>	signerType	signerType.
System.String	hostEmail	Gets or sets the host user email..
System.String	hostName	Gets or sets the host user name..
System.String	hostUserId	Gets or sets the host user id..
ImposeAuthentication	imposeAuthentication	impose Authentication.

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

| Improve this Doc View Source

DeliveryMode

Gets or Sets a delivery mode.

Declaration

public DeliveryMode DeliveryMode { get; set; }

Property Value

Type	Description
DeliveryMode	Gets or sets the delivery mode.

| Improve this Doc View Source

EnableAccessCode

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

Declaration

public bool EnableAccessCode { get; set; }

Property Value

Type	Description
System.Boolean	Gets or sets 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.Boolean	Gets or sets a value indicating whether email OTP authentication is enabled.

| Improve this Doc View Source

HostEmail

Gets or sets the host user email.

Declaration

public string HostEmail { get; set; }

Property Value

Type	Description
System.String	Gets or sets the host user email.

| Improve this Doc View Source

HostName

Gets or sets the host user name.

Declaration

public string HostName { get; set; }

Property Value

Type	Description
System.String	Gets or sets the host user name.

| Improve this Doc View Source

HostUserId

Gets or sets the host user an ID.

Declaration

public string HostUserId { get; set; }

Property Value

Type	Description
System.String	Gets or sets the host user id.

| Improve this Doc View Source

ImposeAuthentication

Gets or sets a value of impose authentication.

Declaration

public ImposeAuthentication ImposeAuthentication { get; set; }

Property Value

Type	Description
ImposeAuthentication	Gets or sets the impose authentication.

| Improve this Doc View Source

Order

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

Declaration

public int Order { get; set; }

Property Value

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

| Improve this Doc View Source

SignerEmail

Gets or sets email address of the signer.

Declaration

public string SignerEmail { get; set; }

Property Value

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

| Improve this Doc View Source

SignerName

Gets or sets name of the signer.

Declaration

public string SignerName { get; set; }

Property Value

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

| Improve this Doc View Source

SignerRole

Gets or sets role of the signer.

Declaration

public string SignerRole { get; set; }

Property Value

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

| Improve this Doc View Source

SignerType

Gets or Sets SignerType.

Declaration

public SignerType? SignerType { get; set; }

Property Value

Type	Description
System.Nullable<SignerType>

| Improve this Doc View Source

Status

Gets or Sets Status of a signer.

Declaration

public SignerStatus? Status { get; set; }

Property Value

Type	Description
System.Nullable<SignerStatus>

| Improve this Doc View Source

UserId

Gets or sets the user Id.

Declaration

public string UserId { get; set; }

Property Value

Type	Description
System.String	Gets or sets the user id.

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