Class Roles

Namespace

BoldSign.Model

Assembly

BoldSign.Api.dll

Return roles details for a particular document or template.

[DataContract]
public class Roles

Inheritance

object

Roles

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Roles()

Initializes a new instance of the Roles class.

public Roles()

Roles(int, string, string, int, string, string, string, SignerType?, string, bool, List<FormField>, List<ExistingFormField>, Languages, AuthenticationType, PhoneNumber)

Initializes a new instance of the Roles class.

[Obsolete("The language-based constructor is deprecated. Please use the new constructor: Roles(string roleSignerName = default, string roleSignerEmailAddress = default, int roleSignerIndex = default, int signerOrder = default(int), string signerRole = default, string privateMessage = default, string authenticationCode = default, SignerType? signerType = default, string hostEmail = default, bool enableEmailOTP = default, List<FormField> formFields = default(List<FormField>), List<ExistingFormField> existingFormFields = default(List<ExistingFormField>), Locales locale = Locales.EN)")]
public Roles(int roleIndex = 0, string signerName = null, string signerEmail = null, int signerOrder = 0, string signerRole = null, string privateMessage = null, string authenticationCode = null, SignerType? signerType = null, string hostEmail = null, bool enableEmailOTP = false, List<FormField> formFields = null, List<ExistingFormField> existingFormFields = null, Languages language = Languages.None, AuthenticationType authenticationType = AuthenticationType.None, PhoneNumber phoneNumber = null)

Parameters

roleIndex int

Gets or sets the roleIndex..

signerName string

Gets or sets the signerName..

signerEmail string

Gets or sets the signerEmail..

signerOrder int

Gets or sets the signer order..

signerRole string

Gets or sets the role..

privateMessage string

Gets or sets the private message..

authenticationCode string

Gets or sets the authentication code..

signerType SignerType?

signerType.

hostEmail string

Gets or sets the hostEmail..

enableEmailOTP bool

Gets or sets a value indicating whether to enable email OTP. <br>Email OTP takes higher precedence over AuthenticationCode..

formFields List<FormField>

Gets or sets document Form fields such as Sign, Checkbox, Radio buttons etc..

existingFormFields List<ExistingFormField>

Gets or sets value for the existing Form fields..

language Languages

Gets or sets the Language.

authenticationType AuthenticationType

Gets or sets the authentication Type.

phoneNumber PhoneNumber

Gets or sets the phone number.

Roles(string, string, int, int, string, string, string, SignerType?, string, bool, List<FormField>, List<ExistingFormField>, Locales, AuthenticationType, PhoneNumber)

Initializes a new instance of the Roles class.

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

Parameters

roleSignerName string

Gets or sets the roleSignerName.

roleSignerEmailAddress string

Gets or sets the roleSignerEmailAddress.

roleSignerIndex int

Gets or sets the roleSignerIndex.

signerOrder int

Gets or sets the signer order.

signerRole string

Gets or sets the role.

privateMessage string

Gets or sets the private message.

authenticationCode string

Gets or sets the authentication code.

signerType SignerType?

signerType.

hostEmail string

Gets or sets the hostEmail.

enableEmailOTP bool

Gets or sets a value indicating whether to enable email OTP. <br>Email OTP takes higher precedence over AuthenticationCode..

formFields List<FormField>

Gets or sets document Form fields such as Sign, Checkbox, Radio buttons etc..

existingFormFields List<ExistingFormField>

Gets or sets value for the existing Form fields..

locale Locales

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.

[DataMember(Name = "allowFieldConfiguration", EmitDefaultValue = true)]
public bool? AllowFieldConfiguration { get; set; }

Property Value

bool?

AuthenticationCode

Gets or sets the authentication code.

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

Property Value

string

Gets or sets the signerEmail.

AuthenticationRetryCount

Gets or sets the authentication retry count.

[DataMember(Name = "authenticationRetryCount", EmitDefaultValue = false)]
public int? AuthenticationRetryCount { get; set; }

Property Value

int?

AuthenticationType

Gets or sets the authentication type. Defaults to None.

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

Property Value

AuthenticationType

DeliveryMode

Gets or Sets the delivery mode of the signer.

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

Property Value

DeliveryMode

EnableEmailOTP

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

[DataMember(Name = "enableEmailOTP", EmitDefaultValue = true)]
public bool EnableEmailOTP { get; set; }

Property Value

bool

Gets or sets the signerEmail.

ExistingFormFields

Gets or sets value for the existing Form fields.

[DataMember(Name = "existingFormFields", EmitDefaultValue = false)]
public List<ExistingFormField> ExistingFormFields { get; set; }

Property Value

List<ExistingFormField>

Gets or sets value for the existing Form fields.

FormFields

Gets or sets form fields assigned to signer.

[DataMember(Name = "formFields", EmitDefaultValue = false)]
public List<FormField> FormFields { get; set; }

Property Value

List<FormField>

Gets or sets document Form fields such as Sign, Checkbox, Radio buttons etc.

HostEmail

Gets or sets the host email address.

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

Property Value

string

Gets or sets the hostEmail.

Language

Gets or sets the signer language.

[DataMember(Name = "language", EmitDefaultValue = true)]
[Obsolete("language is deprecated, please use locale instead")]
public Languages Language { get; set; }

Property Value

Languages

Gets or sets the language of the signer.

Locale

Gets or sets the Locale.

[DataMember(Name = "locale", EmitDefaultValue = true)]
public Locales Locale { get; set; }

Property Value

Locales

Gets or sets the Locale of the signer.

PhoneNumber

Gets or sets the phone number.

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

Property Value

PhoneNumber

PrivateMessage

Gets or sets the private message.

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

Property Value

string

Gets or sets the signerEmail.

RecipientNotificationSettings

Gets or sets the Recipient Notification Settings.

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

Property Value

RecipientNotificationSettings

Gets or sets the Recipient Notification Settings of the signer.

RoleIndex

Gets or sets the role index of the signer.

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

Property Value

int

Gets or sets the roleIndex.

SignerEmail

Gets or sets the signer email address.

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

Property Value

string

Gets or sets the signerEmail.

SignerName

Gets or sets the signer name.

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

Property Value

string

Gets or sets the signerName.

SignerOrder

Gets or sets the signer order.

[DataMember(Name = "signerOrder", EmitDefaultValue = false)]
public int? SignerOrder { get; set; }

Property Value

int?

Gets or sets the signer order.

SignerRole

Gets or sets the signer role in the document.

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

Property Value

string

Gets or sets the role.

SignerType

Gets or sets the signer type.

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

Property Value

SignerType?

Gets or sets the signerEmail.

Methods

ToJson()

Returns the JSON string presentation of the object

public virtual string ToJson()

Returns

string

JSON string presentation of the object