new module:model/RecipientEvent()
- Source:
Constructs a new RecipientEvent
.
Members
(inner) includeDocuments :String
- Source:
When set to true, the PDF documents are included in the message along with the updated XML.
Type:
- String
(inner) recipientEventStatusCode :String
- Source:
The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/RecipientEvent}
- Source:
Constructs a RecipientEvent
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/RecipientEvent | Optional instance to populate. |
Returns:
The populated RecipientEvent
instance.