new module:model/CaptiveRecipient()
- Source:
Constructs a new CaptiveRecipient.
This object contains details about a captive (embedded) recipient.
Members
(inner) clientUserId :String
- Source:
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.
Type:
- String
(inner) email :String
- Source:
Specifies the email address associated with the captive recipient.
Type:
- String
(inner) errorDetails :module:model/ErrorDetails
- Source:
Array or errors.
Type:
(inner) userName :String
- Source:
Specifies the user name associated with the captive recipient.
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/CaptiveRecipient}
- Source:
Constructs a CaptiveRecipient 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/CaptiveRecipient | Optional instance to populate. |
Returns:
The populated CaptiveRecipient instance.