DocuSign.eSign.Model.CaptiveRecipient Class Reference

This object contains details about a captive (embedded) recipient. More...

Inheritance diagram for DocuSign.eSign.Model.CaptiveRecipient:

Public Member Functions
	CaptiveRecipient (string ClientUserId=default(string), string Email=default(string), ErrorDetails ErrorDetails=default(ErrorDetails), string UserName=default(string))
	Initializes a new instance of the CaptiveRecipient 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 (CaptiveRecipient other)
	Returns true if CaptiveRecipient instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...
IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	ClientUserId [get, set]
	Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters. More...
string	Email [get, set]
	Specifies the email address associated with the captive recipient. More...
ErrorDetails	ErrorDetails [get, set]
	Array or errors. More...
string	UserName [get, set]
	Specifies the user name associated with the captive recipient. More...

Detailed Description

This object contains details about a captive (embedded) recipient.

Constructor & Destructor Documentation

CaptiveRecipient()

DocuSign.eSign.Model.CaptiveRecipient.CaptiveRecipient ( string  ClientUserId = default(string), string  Email = default(string), ErrorDetails  ErrorDetails = default(ErrorDetails), string  UserName = default(string)  )

inline

Initializes a new instance of the CaptiveRecipient class.

Parameters

ClientUserId	Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters. .
Email	Specifies the email address associated with the captive recipient..
ErrorDetails	Array or errors..
UserName	Specifies the user name associated with the captive recipient..

Member Function Documentation

Equals() [1/2]

override bool DocuSign.eSign.Model.CaptiveRecipient.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.CaptiveRecipient.Equals ( CaptiveRecipient  other )

inline

Returns true if CaptiveRecipient instances are equal

Parameters

other

Instance of CaptiveRecipient to be compared

Returns

Boolean

GetHashCode()

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

inline

Gets the hash code

Returns

Hash code

ToJson()

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

inline

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

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

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

ClientUserId

string DocuSign.eSign.Model.CaptiveRecipient.ClientUserId

getset

Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters.

Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters.

Email

string DocuSign.eSign.Model.CaptiveRecipient.Email

getset

Specifies the email address associated with the captive recipient.

Specifies the email address associated with the captive recipient.

ErrorDetails

ErrorDetails DocuSign.eSign.Model.CaptiveRecipient.ErrorDetails

getset

Array or errors.

Array or errors.

UserName

string DocuSign.eSign.Model.CaptiveRecipient.UserName

getset

Specifies the user name associated with the captive recipient.

Specifies the user name associated with the captive recipient.

---

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

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