Class TemplateRole

Namespace

BoldSign.Api.Model

Assembly

BoldSign.Api.dll

Template role DTO.

[DataContract]
public class TemplateRole

Inheritance

object

TemplateRole

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TemplateRole()

Initializes a new instance of the TemplateRole class.

public TemplateRole()

TemplateRole(int, string, string, string, int, SignerType, List<FormField>, string, ImposeAuthentication, bool, bool, Locales)

Initializes a new instance of the TemplateRole class.

public TemplateRole(int roleIndex, string name, string defaultSignerName = null, string defaultSignerEmail = null, int signerOrder = 0, SignerType signerType = SignerType.Signer, List<FormField> formFields = null, string hostEmail = null, ImposeAuthentication imposeAuthentication = ImposeAuthentication.None, bool allowRoleEdit = true, bool allowRoleDelete = true, Locales locale = Locales.EN)

Parameters

roleIndex int

Gets or sets the role index. (required).

name string

Gets or sets the name. (required).

defaultSignerName string

Gets or sets the role signer name.

defaultSignerEmail string

Gets or sets the role signer email address.

signerOrder int

Gets or sets the signer order.

signerType SignerType

signerType.

formFields List<FormField>

Gets or sets the formFields.

hostEmail string

Gets or sets the hostEmail.

imposeAuthentication ImposeAuthentication

Gets or sets the authentication type of template.

allowRoleEdit bool

Gets or sets the allow permission to role edit option of template.

allowRoleDelete bool

Gets or sets the allow permission to role delete option of template.

locale Locales

Gets or sets the locale.

TemplateRole(string, int, string, string, int, SignerType, List<FormField>, string, Languages, ImposeAuthentication, bool, bool)

Initializes a new instance of the TemplateRole class.

[Obsolete("The language-based constructor is deprecated. Please use the new constructor: TemplateRole(int roleIndex, string name, string defaultSignerName = default, string defaultSignerEmail = default, int signerOrder = default, SignerType signerType = SignerType.Signer, List<FormField> formFields = default, string hostEmail = default, ImposeAuthentication imposeAuthentication = ImposeAuthentication.None, bool allowRoleEdit = true, bool allowRoleDelete = true, Locales locale = Locales.EN)")]
public TemplateRole(string name, int index, string defaultSignerName = null, string defaultSignerEmail = null, int signerOrder = 0, SignerType signerType = SignerType.Signer, List<FormField> formFields = null, string hostEmail = null, Languages language = Languages.None, ImposeAuthentication imposeAuthentication = ImposeAuthentication.None, bool allowRoleEdit = true, bool allowRoleDelete = true)

Parameters

name string

Gets or sets the name. (required).

index int

Gets or sets the role index. (required).

defaultSignerName string

Gets or sets the role signer name. (required).

defaultSignerEmail string

Gets or sets the role signer email address. (required).

signerOrder int

Gets or sets the signer order..

signerType SignerType

signerType.

formFields List<FormField>

Gets or sets the formFields..

hostEmail string

Gets or sets the hostEmail.

language Languages

Gets or sets the Language.

imposeAuthentication ImposeAuthentication

Gets or sets the authentication type of template.

allowRoleEdit bool

Gets or sets the allow permission to role edit option of template.

allowRoleDelete bool

Gets or sets the allow permission to role delete option of template.

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

AllowRoleDelete

Gets or sets a value indicating whether the enable allow role delete option is enabled or disabled.

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

Property Value

bool

AllowRoleEdit

Gets or sets a value indicating whether the allow role edit option is enabled or disabled.

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

Property Value

bool

DefaultSignerEmail

Gets or sets the Default signer Email.

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

Property Value

string

DefaultSignerName

Gets or sets the Default Signer Name.

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

Property Value

string

DeliveryMode

Gets or Sets the delivery mode of the signer.

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

Property Value

DeliveryMode

EnableQes

Gets or sets a value indicating whether to enable qualified electronic signature the document signer.

[DataMember(Name = "enableQes", EmitDefaultValue = false)]
public bool? EnableQes { get; set; }

Property Value

bool?

FormFields

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

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

Property Value

IEnumerable<FormField>

HostEmail

Gets or sets the default Host Email.

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

Property Value

string

ImposeAuthentication

Gets or sets the Authentication Type such as None ,Access Code, EmailOTP.

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

Property Value

ImposeAuthentication

Index

Gets or sets the Index value.

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

Property Value

int

Language

Gets or sets Languages such as English, French, Spanish, German.

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

Property Value

Languages

Locale

Gets or sets locale such as EN, FR, ES.

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

Property Value

Locales

Name

Gets or sets the role Name.

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

Property Value

string

PhoneNumber

Gets or sets the phone number.

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

Property Value

PhoneNumber

RecipientNotificationSettings

Gets or sets the Recipient Notification Settings.

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

Property Value

RecipientNotificationSettings

SignerOrder

Gets or sets the signer order value.

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

Property Value

int

SignerType

Gets or sets the signer type.

Defaults to Signer.

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

Property Value

SignerType

Methods

ToJson()

Returns the JSON string presentation of the object.

public virtual string ToJson()

Returns

string

JSON string presentation of the object.