Class Roles

Return roles details for a particular document or template.

Inheritance

System.Object

Roles

Namespace: BoldSign.Model

Assembly: BoldSign.Api.dll

Syntax

public class Roles : object

Constructors

Roles()

Initializes a new instance of the Roles class.

Declaration

public Roles()

Roles(Int32, String, String, Int32, String, String, String, Nullable<SignerType>, String, Boolean, List<FormField>, List<ExistingFormField>, Languages, AuthenticationType, PhoneNumber)

Initializes a new instance of the Roles class.

Declaration

public Roles(int roleIndex = null, string signerName = null, string signerEmail = null, int signerOrder = null, string signerRole = null, string privateMessage = null, string authenticationCode = null, SignerType? signerType = null, string hostEmail = null, bool enableEmailOTP = null, List<FormField> formFields = null, List<ExistingFormField> existingFormFields = null, Languages language = default(Languages), AuthenticationType authenticationType = default(AuthenticationType), PhoneNumber phoneNumber = null)

Parameters

Type	Name	Description
System.Int32	roleIndex	Gets or sets the roleIndex..
System.String	signerName	Gets or sets the signerName..
System.String	signerEmail	Gets or sets the signerEmail..
System.Int32	signerOrder	Gets or sets the signer order..
System.String	signerRole	Gets or sets the role..
System.String	privateMessage	Gets or sets the private message..
System.String	authenticationCode	Gets or sets the authentication code..
System.Nullable<SignerType>	signerType	signerType.
System.String	hostEmail	Gets or sets the hostEmail..
System.Boolean	enableEmailOTP	Gets or sets a value indicating whether to enable email OTP. <br>Email OTP takes higher precedence over AuthenticationCode..
List<FormField>	formFields	Gets or sets document Form fields such as Sign, Checkbox, Radio buttons etc..
List<ExistingFormField>	existingFormFields	Gets or sets value for the existing Form fields..
Languages	language	Gets or sets the Language.
AuthenticationType	authenticationType	Gets or sets the authentication Type.
PhoneNumber	phoneNumber	Gets or sets the phone number.

Roles(String, String, Int32, Int32, String, String, String, Nullable<SignerType>, String, Boolean, List<FormField>, List<ExistingFormField>, Locales, AuthenticationType, PhoneNumber)

Initializes a new instance of the Roles class.

Declaration

public Roles(string roleSignerName = null, string roleSignerEmailAddress = null, int roleSignerIndex = null, int signerOrder = null, string signerRole = null, string privateMessage = null, string authenticationCode = null, SignerType? signerType = null, string hostEmail = null, bool enableEmailOTP = null, List<FormField> formFields = null, List<ExistingFormField> existingFormFields = null, Locales locale = Locales.Default, AuthenticationType authenticationType = default(AuthenticationType), PhoneNumber phoneNumber = null)

Parameters

Type	Name	Description
System.String	roleSignerName	Gets or sets the roleSignerName.
System.String	roleSignerEmailAddress	Gets or sets the roleSignerEmailAddress.
System.Int32	roleSignerIndex	Gets or sets the roleSignerIndex.
System.Int32	signerOrder	Gets or sets the signer order.
System.String	signerRole	Gets or sets the role.
System.String	privateMessage	Gets or sets the private message.
System.String	authenticationCode	Gets or sets the authentication code.
System.Nullable<SignerType>	signerType	signerType.
System.String	hostEmail	Gets or sets the hostEmail.
System.Boolean	enableEmailOTP	Gets or sets a value indicating whether to enable email OTP. <br>Email OTP takes higher precedence over AuthenticationCode..
List<FormField>	formFields	Gets or sets document Form fields such as Sign, Checkbox, Radio buttons etc..
List<ExistingFormField>	existingFormFields	Gets or sets value for the existing Form fields..
Locales	locale	Gets or sets the locale.
AuthenticationType	authenticationType	Gets or sets the authentication Type.
PhoneNumber	phoneNumber	Gets or sets the phone number.

Properties

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

AuthenticationCode

Gets or sets the authentication code.

Declaration

public string AuthenticationCode { get; set; }

Property Value

Type	Description
System.String	Gets or sets the signerEmail.

AuthenticationType

Gets or sets the authentication type. Defaults to None.

Declaration

public AuthenticationType AuthenticationType { get; set; }

Property Value

Type	Description
AuthenticationType

DeliveryMode

Gets or Sets the delivery mode of the signer.

Declaration

public DeliveryMode DeliveryMode { get; set; }

Property Value

Type	Description
DeliveryMode

EnableEmailOTP

Gets or sets a value indicating whether to enable email OTP for signing.

Declaration

public bool EnableEmailOTP { get; set; }

Property Value

Type	Description
System.Boolean	Gets or sets the signerEmail.

ExistingFormFields

Gets or sets value for the existing Form fields.

Declaration

public List<ExistingFormField> ExistingFormFields { get; set; }

Property Value

Type	Description
List<ExistingFormField>	Gets or sets value for the existing Form fields.

FormFields

Gets or sets form fields assigned to signer.

Declaration

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

Property Value

Type	Description
List<FormField>	Gets or sets document Form fields such as Sign, Checkbox, Radio buttons etc.

HostEmail

Gets or sets the host email address.

Declaration

public string HostEmail { get; set; }

Property Value

Type	Description
System.String	Gets or sets the hostEmail.

Language

Gets or sets the signer language.

Declaration

public Languages Language { get; set; }

Property Value

Type	Description
Languages	Gets or sets the language of the signer.

Locale

Gets or sets the Locale.

Declaration

public Locales Locale { get; set; }

Property Value

Type	Description
Locales	Gets or sets the Locale of the signer.

PhoneNumber

Gets or sets the phone number.

Declaration

public PhoneNumber PhoneNumber { get; set; }

Property Value

Type	Description
PhoneNumber

PrivateMessage

Gets or sets the private message.

Declaration

public string PrivateMessage { get; set; }

Property Value

Type	Description
System.String	Gets or sets the signerEmail.

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.

RoleIndex

Gets or sets the role index of the signer.

Declaration

public int RoleIndex { get; set; }

Property Value

Type	Description
System.Int32	Gets or sets the roleIndex.

SignerEmail

Gets or sets the signer email address.

Declaration

public string SignerEmail { get; set; }

Property Value

Type	Description
System.String	Gets or sets the signerEmail.

SignerName

Gets or sets the signer name.

Declaration

public string SignerName { get; set; }

Property Value

Type	Description
System.String	Gets or sets the signerName.

SignerOrder

Gets or sets the signer order.

Declaration

public int? SignerOrder { get; set; }

Property Value

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

SignerRole

Gets or sets the signer role in the document.

Declaration

public string SignerRole { get; set; }

Property Value

Type	Description
System.String	Gets or sets the role.

SignerType

Gets or sets the signer type.

Declaration

public SignerType? SignerType { get; set; }

Property Value

Type	Description
System.Nullable<SignerType>	Gets or sets the signerEmail.

Methods

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