DocuSign.eSign.Model.RecipientSignatureProviderOptions Class Reference

Option settings for the signature provider. Different providers require or use different options. The current provider list and the options they require. More...

Inheritance diagram for DocuSign.eSign.Model.RecipientSignatureProviderOptions:

Public Member Functions
	RecipientSignatureProviderOptions (string CpfNumber=default(string), PropertyMetadata CpfNumberMetadata=default(PropertyMetadata), string OneTimePassword=default(string), PropertyMetadata OneTimePasswordMetadata=default(PropertyMetadata), string SignerRole=default(string), PropertyMetadata SignerRoleMetadata=default(PropertyMetadata), string Sms=default(string), PropertyMetadata SmsMetadata=default(PropertyMetadata))
	Initializes a new instance of the RecipientSignatureProviderOptions class. More...
override string	ToString ()
	Returns the string presentation of the object More...
string	ToJson ()
	Returns the JSON string presentation of the object More...
override bool	Equals (object obj)
	Returns true if objects are equal More...
bool	Equals (RecipientSignatureProviderOptions other)
	Returns true if RecipientSignatureProviderOptions instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...
IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	CpfNumber [get, set]
	Gets or Sets CpfNumber More...
PropertyMetadata	CpfNumberMetadata [get, set]
	Reserved for DocuSign. More...
string	OneTimePassword [get, set]
	Gets or Sets OneTimePassword More...
PropertyMetadata	OneTimePasswordMetadata [get, set]
	Metadata that indicates whether the `oneTimePassword` property is editable. More...
string	SignerRole [get, set]
	Gets or Sets SignerRole More...
PropertyMetadata	SignerRoleMetadata [get, set]
	Metadata that indicates whether the `signerRole` property is editable. More...
string	Sms [get, set]
	Gets or Sets Sms More...
PropertyMetadata	SmsMetadata [get, set]
	Metadata that indicates whether the `sms` property is editable. More...

Detailed Description

Option settings for the signature provider. Different providers require or use different options. The current provider list and the options they require.

Constructor & Destructor Documentation

RecipientSignatureProviderOptions()

DocuSign.eSign.Model.RecipientSignatureProviderOptions.RecipientSignatureProviderOptions ( string  CpfNumber = default(string), PropertyMetadata  CpfNumberMetadata = default(PropertyMetadata), string  OneTimePassword = default(string), PropertyMetadata  OneTimePasswordMetadata = default(PropertyMetadata), string  SignerRole = default(string), PropertyMetadata  SignerRoleMetadata = default(PropertyMetadata), string  Sms = default(string), PropertyMetadata  SmsMetadata = default(PropertyMetadata)  )

inline

Initializes a new instance of the RecipientSignatureProviderOptions class.

Parameters

CpfNumber	CpfNumber.
CpfNumberMetadata	Reserved for DocuSign..
OneTimePassword	OneTimePassword.
OneTimePasswordMetadata	Metadata that indicates whether the `oneTimePassword` property is editable..
SignerRole	SignerRole.
SignerRoleMetadata	Metadata that indicates whether the `signerRole` property is editable..
Sms	Sms.
SmsMetadata	Metadata that indicates whether the `sms` property is editable..

Member Function Documentation

Equals() [1/2]

override bool DocuSign.eSign.Model.RecipientSignatureProviderOptions.Equals ( object  obj )

inline

Returns true if objects are equal

Parameters

obj	Object to be compared

Returns

Boolean

Equals() [2/2]

bool DocuSign.eSign.Model.RecipientSignatureProviderOptions.Equals ( RecipientSignatureProviderOptions  other )

inline

Returns true if RecipientSignatureProviderOptions instances are equal

Parameters

other

Instance of RecipientSignatureProviderOptions to be compared

Returns

Boolean

GetHashCode()

override int DocuSign.eSign.Model.RecipientSignatureProviderOptions.GetHashCode ( )

inline

Gets the hash code

Returns

Hash code

ToJson()

string DocuSign.eSign.Model.RecipientSignatureProviderOptions.ToJson ( )

inline

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

override string DocuSign.eSign.Model.RecipientSignatureProviderOptions.ToString ( )

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

CpfNumber

string DocuSign.eSign.Model.RecipientSignatureProviderOptions.CpfNumber

getset

Gets or Sets CpfNumber

CpfNumberMetadata

PropertyMetadata DocuSign.eSign.Model.RecipientSignatureProviderOptions.CpfNumberMetadata

getset

Reserved for DocuSign.

Reserved for DocuSign.

OneTimePassword

string DocuSign.eSign.Model.RecipientSignatureProviderOptions.OneTimePassword

getset

Gets or Sets OneTimePassword

OneTimePasswordMetadata

PropertyMetadata DocuSign.eSign.Model.RecipientSignatureProviderOptions.OneTimePasswordMetadata

getset

Metadata that indicates whether the `oneTimePassword` property is editable.

Metadata that indicates whether the `oneTimePassword` property is editable.

SignerRole

string DocuSign.eSign.Model.RecipientSignatureProviderOptions.SignerRole

getset

Gets or Sets SignerRole

SignerRoleMetadata

PropertyMetadata DocuSign.eSign.Model.RecipientSignatureProviderOptions.SignerRoleMetadata

getset

Metadata that indicates whether the `signerRole` property is editable.

Metadata that indicates whether the `signerRole` property is editable.

Sms

string DocuSign.eSign.Model.RecipientSignatureProviderOptions.Sms

getset

Gets or Sets Sms

SmsMetadata

PropertyMetadata DocuSign.eSign.Model.RecipientSignatureProviderOptions.SmsMetadata

getset

Metadata that indicates whether the `sms` property is editable.

Metadata that indicates whether the `sms` property is editable.

---

The documentation for this class was generated from the following file:

• sdk/src/DocuSign.eSign/Model/RecipientSignatureProviderOptions.cs