Class RoleProperties

Role properties.

Inheritance

System.Object

RoleProperties

Namespace: BoldSign.Api.Model

Assembly: BoldSign.Api.dll

Syntax

public class RoleProperties : object

Constructors

RoleProperties(String, Int32, String, String, Int32, SignerType, List<TemplateFormField>, String, Languages, Boolean, Boolean, ImposeAuthentication, Boolean, Boolean, Locales)

Initializes a new instance of the RoleProperties class.

Declaration

public RoleProperties(string name, int index, string defaultSignerName = null, string defaultSignerEmail = null, int signerOrder = null, SignerType signerType = default(SignerType), List<TemplateFormField> formFields = null, string hostEmail = null, Languages language = default(Languages), bool enableAccessCode = null, bool enableEmailOTP = null, ImposeAuthentication imposeAuthentication = default(ImposeAuthentication), bool allowRoleEdit = true, bool allowRoleDelete = true, Locales locale = Locales.EN)

Parameters

Type	Name	Description
System.String	name	Gets or sets the name. (required).
System.Int32	index	Gets or sets the role index. (required).
System.String	defaultSignerName	Gets or sets the role signer name. (required).
System.String	defaultSignerEmail	Gets or sets the role signer email address. (required).
System.Int32	signerOrder	Gets or sets the signer order..
SignerType	signerType	signerType.
List<TemplateFormField>	formFields	Gets or sets the formFields..
System.String	hostEmail	Gets or sets the hostEmail.
Languages	language	Gets or sets the Language.
System.Boolean	enableAccessCode	Gets or sets indicating whether enable access code recipients.
System.Boolean	enableEmailOTP	Gets or sets a value indicating whether enable email otp recipients..
ImposeAuthentication	imposeAuthentication	Gets or sets the authentication type of template.
System.Boolean	allowRoleEdit	Gets or sets the allow permission to role edit option of template.
System.Boolean	allowRoleDelete	Gets or sets the allow permission to role delete option of template.
Locales	locale	Gets or sets the locale.

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

AllowRoleDelete

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

Declaration

public bool AllowRoleDelete { get; set; }

Property Value

Type	Description
System.Boolean

AllowRoleEdit

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

Declaration

public bool AllowRoleEdit { get; set; }

Property Value

Type	Description
System.Boolean

DefaultSignerEmail

Gets or sets the Default signer Email.

Declaration

public string DefaultSignerEmail { get; set; }

Property Value

Type	Description
System.String

DefaultSignerName

Gets or sets the Default Signer Name.

Declaration

public string DefaultSignerName { get; set; }

Property Value

Type	Description
System.String

DeliveryMode

Gets or Sets a delivery mode.

Declaration

public DeliveryMode DeliveryMode { get; set; }

Property Value

Type	Description
DeliveryMode	Gets or sets the delivery mode.

EnableAccessCode

Gets or sets a value indicating whether enable access code recipients.

Declaration

public bool EnableAccessCode { get; set; }

Property Value

Type	Description
System.Boolean

EnableEmailOTP

Gets or sets a value indicating whether enable email otp recipients.

Declaration

public bool EnableEmailOTP { get; set; }

Property Value

Type	Description
System.Boolean

FormFields

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

Declaration

public IEnumerable<TemplateFormField> FormFields { get; set; }

Property Value

Type	Description
IEnumerable<TemplateFormField>

HostEmail

Gets or sets the default Host Email.

Declaration

public string HostEmail { get; set; }

Property Value

Type	Description
System.String

ImposeAuthentication

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

Declaration

public ImposeAuthentication ImposeAuthentication { get; set; }

Property Value

Type	Description
ImposeAuthentication

Index

Gets or sets the Index value.

Declaration

public int Index { get; set; }

Property Value

Type	Description
System.Int32

Language

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

Declaration

public Languages Language { get; set; }

Property Value

Type	Description
Languages

Locale

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

Declaration

public Locales Locale { get; set; }

Property Value

Type	Description
Locales

Name

Gets or sets the role Name.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

PhoneNumber

Gets or sets the phone number.

Declaration

public PhoneNumber PhoneNumber { get; set; }

Property Value

Type	Description
PhoneNumber

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.

SignerOrder

Gets or sets the signer order value.

Declaration

public int SignerOrder { get; set; }

Property Value

Type	Description
System.Int32

SignerType

Gets or sets the signer type.

Defaults to Signer.

Declaration

public SignerType SignerType { get; set; }

Property Value

Type	Description
SignerType

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.