new module:model/PowerFormRecipient()
- Source:
Constructs a new PowerFormRecipient.
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.
Members
(inner) accessCode :String
- Source:
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.
Type:
- String
(inner) accessCodeLocked :String
- Source:
Type:
- String
(inner) accessCodeRequired :String
- Source:
Type:
- String
(inner) email :String
- Source:
Type:
- String
(inner) emailLocked :String
- Source:
Type:
- String
(inner) idCheckConfigurationName :String
- Source:
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.
Type:
- String
(inner) idCheckRequired :String
- Source:
Type:
- String
(inner) name :String
- Source:
Type:
- String
(inner) recipientType :String
- Source:
Type:
- String
(inner) roleName :String
- Source:
Optional element. Specifies the role name associated with the recipient.
This is required when working with template recipients.
Type:
- String
(inner) routingOrder :String
- Source:
Specifies the routing order of the recipient in the envelope.
Type:
- String
(inner) templateRequiresIdLookup :String
- Source:
Type:
- String
(inner) userNameLocked :String
- Source:
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/PowerFormRecipient}
- Source:
Constructs a PowerFormRecipient from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:model/PowerFormRecipient | Optional instance to populate. |
Returns:
The populated PowerFormRecipient instance.