Note: For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`. More...

Inheritance diagram for DocuSign.eSign.Model.PowerFormRecipient:

Public Member Functions
	PowerFormRecipient (string AccessCode=default(string), string AccessCodeLocked=default(string), string AccessCodeRequired=default(string), string Email=default(string), string EmailLocked=default(string), string IdCheckConfigurationName=default(string), string IdCheckRequired=default(string), string Name=default(string), string RecipientType=default(string), string RoleName=default(string), string RoutingOrder=default(string), string TemplateRequiresIdLookup=default(string), string UserNameLocked=default(string))
	Initializes a new instance of the PowerFormRecipient 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 (PowerFormRecipient other)
	Returns true if PowerFormRecipient instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	AccessCode `[get, set]`
	If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. More...

string	AccessCodeLocked `[get, set]`
	Gets or Sets AccessCodeLocked More...

string	AccessCodeRequired `[get, set]`
	Gets or Sets AccessCodeRequired More...

string	Email `[get, set]`
	Gets or Sets Email More...

string	EmailLocked `[get, set]`
	Gets or Sets EmailLocked More...

string	IdCheckConfigurationName `[get, set]`
	Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. More...

string	IdCheckRequired `[get, set]`
	Gets or Sets IdCheckRequired More...

string	Name `[get, set]`
	Gets or Sets Name More...

string	RecipientType `[get, set]`
	Gets or Sets RecipientType More...

string	RoleName `[get, set]`
	Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. More...

string	RoutingOrder `[get, set]`
	Specifies the routing order of the recipient in the envelope. More...

string	TemplateRequiresIdLookup `[get, set]`
	Gets or Sets TemplateRequiresIdLookup More...

string	UserNameLocked `[get, set]`
	Gets or Sets UserNameLocked More...

Detailed Description

Note: For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`.

Constructor & Destructor Documentation

◆ PowerFormRecipient()

DocuSign.eSign.Model.PowerFormRecipient.PowerFormRecipient	(	string	AccessCode = `default(string)`,
		string	AccessCodeLocked = `default(string)`,
		string	AccessCodeRequired = `default(string)`,
		string	Email = `default(string)`,
		string	EmailLocked = `default(string)`,
		string	IdCheckConfigurationName = `default(string)`,
		string	IdCheckRequired = `default(string)`,
		string	Name = `default(string)`,
		string	RecipientType = `default(string)`,
		string	RoleName = `default(string)`,
		string	RoutingOrder = `default(string)`,
		string	TemplateRequiresIdLookup = `default(string)`,
		string	UserNameLocked = `default(string)`
	)

inline

Initializes a new instance of the PowerFormRecipient class.

Parameters

AccessCode	If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required..
AccessCodeLocked	AccessCodeLocked.
AccessCodeRequired	AccessCodeRequired.
Email	Email.
EmailLocked	EmailLocked.
IdCheckConfigurationName	Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node..
IdCheckRequired	IdCheckRequired.
Name	Name.
RecipientType	RecipientType.
RoleName	Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients..
RoutingOrder	Specifies the routing order of the recipient in the envelope. .
TemplateRequiresIdLookup	TemplateRequiresIdLookup.
UserNameLocked	UserNameLocked.

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if PowerFormRecipient instances are equal

Parameters

other Instance of PowerFormRecipient to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AccessCode

string DocuSign.eSign.Model.PowerFormRecipient.AccessCode

getset

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.

◆ AccessCodeLocked

string DocuSign.eSign.Model.PowerFormRecipient.AccessCodeLocked

getset

Gets or Sets AccessCodeLocked

◆ AccessCodeRequired

string DocuSign.eSign.Model.PowerFormRecipient.AccessCodeRequired

getset

Gets or Sets AccessCodeRequired

◆ Email

string DocuSign.eSign.Model.PowerFormRecipient.Email

getset

Gets or Sets Email

◆ EmailLocked

string DocuSign.eSign.Model.PowerFormRecipient.EmailLocked

getset

Gets or Sets EmailLocked

◆ IdCheckConfigurationName

string DocuSign.eSign.Model.PowerFormRecipient.IdCheckConfigurationName

getset

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node.

◆ IdCheckRequired

string DocuSign.eSign.Model.PowerFormRecipient.IdCheckRequired

getset

Gets or Sets IdCheckRequired

◆ Name

string DocuSign.eSign.Model.PowerFormRecipient.Name

getset

Gets or Sets Name

◆ RecipientType

string DocuSign.eSign.Model.PowerFormRecipient.RecipientType

getset

Gets or Sets RecipientType

◆ RoleName

string DocuSign.eSign.Model.PowerFormRecipient.RoleName

getset

Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.

◆ RoutingOrder

string DocuSign.eSign.Model.PowerFormRecipient.RoutingOrder

getset

Specifies the routing order of the recipient in the envelope.

◆ TemplateRequiresIdLookup

string DocuSign.eSign.Model.PowerFormRecipient.TemplateRequiresIdLookup

getset

Gets or Sets TemplateRequiresIdLookup

◆ UserNameLocked

string DocuSign.eSign.Model.PowerFormRecipient.UserNameLocked

getset

Gets or Sets UserNameLocked

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

sdk/src/DocuSign.eSign/Model/PowerFormRecipient.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PowerFormRecipient()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AccessCode

◆ AccessCodeLocked

◆ AccessCodeRequired

◆ Email

◆ EmailLocked

◆ IdCheckConfigurationName

◆ IdCheckRequired

◆ Name

◆ RecipientType

◆ RoleName

◆ RoutingOrder

◆ TemplateRequiresIdLookup

◆ UserNameLocked