new module:model/Recipients()
- Source:
Constructs a new Recipients.
Specifies the envelope recipients.
Members
(inner) agents :Array.<module:model/Agent>
- Source:
A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document.
Type:
- Array.<module:model/Agent>
(inner) carbonCopies :Array.<module:model/CarbonCopy>
- Source:
A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it.
Type:
- Array.<module:model/CarbonCopy>
(inner) certifiedDeliveries :Array.<module:model/CertifiedDelivery>
- Source:
A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.
Type:
- Array.<module:model/CertifiedDelivery>
(inner) currentRoutingOrder :String
- Source:
Type:
- String
(inner) editors :Array.<module:model/Editor>
- Source:
A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document.
Type:
- Array.<module:model/Editor>
(inner) errorDetails :module:model/ErrorDetails
- Source:
Array or errors.
Type:
(inner) inPersonSigners :Array.<module:model/InPersonSigner>
- Source:
Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.
Type:
- Array.<module:model/InPersonSigner>
(inner) intermediaries :Array.<module:model/Intermediary>
- Source:
Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).
Type:
- Array.<module:model/Intermediary>
(inner) notaries :Array.<module:model/NotaryRecipient>
- Source:
Type:
- Array.<module:model/NotaryRecipient>
(inner) participants :Array.<module:model/Participant>
- Source:
Type:
- Array.<module:model/Participant>
(inner) recipientCount :String
- Source:
Type:
- String
(inner) seals :Array.<module:model/SealSign>
- Source:
Type:
- Array.<module:model/SealSign>
(inner) signers :Array.<module:model/Signer>
- Source:
A complex type containing information about the Signer recipient.
Type:
- Array.<module:model/Signer>
(inner) witnesses :Array.<module:model/Witness>
- Source:
Type:
- Array.<module:model/Witness>
Methods
(static) constructFromObject(data, obj) → {module:model/Recipients}
- Source:
Constructs a Recipients 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/Recipients | Optional instance to populate. |
Returns:
The populated Recipients instance.