Skip to navigation
Apex Toolkit reference

Recipient

View as Markdown
global virtual class Recipient implements Comparable
Description
Representation of a Docusign envelope recipient.
authentication
@AuraEnabled global Authentication authentication
The recipient authentication options.
email
@AuraEnabled global String email
The email of the recipient.
emailSettings
@AuraEnabled global EmailSettings emailSettings
The email settings for the recipient.
hostEmail
@AuraEnabled global String hostEmail
The host email of the recipient. Used only for in-person signing.
hostName
@AuraEnabled global String hostName
The host name of the recipient. Used only for in-person signing.
id
@AuraEnabled global Id id
The ID of the associated dfsle__Recipient__c record.
isSigningGroup
@AuraEnabled global Boolean isSigningGroup
Read-only property indicating whether the recipient is a signing group.
name
@AuraEnabled global String name
The name of the recipient.
note
@AuraEnabled global String note
The private note sent to the recipient.
phone
@AuraEnabled global String phone
The phone number of the recipient. Can be used for SMS authentication.
readOnly
@AuraEnabled global Boolean readOnly
Whether this recipient may be modified. Used with Docusign templates.
required
@AuraEnabled global Boolean required
Whether this recipient is required. Used with Docusign templates.
role
@AuraEnabled global Role role
The role of the recipient. Used to tie the recipient to Docusign template roles or for use with automatic anchor tags.
routingOrder
@AuraEnabled global Integer routingOrder
The routing order of the recipient. This is distinct from sequence and need not be unique across an envelope's recipients.
sequence
@AuraEnabled global Integer sequence
The ordinal sequence of the recipient as displayed on the Docusign envelope.
signatureProviders
@AuraEnabled global List<SignatureProvider> signatureProviders
signingGroup
@AuraEnabled global SigningGroup signingGroup
The Docusign signing group.
signNow
@AuraEnabled global Boolean signNow
Whether the recipient should sign now. Honored only for in-person signing or when the first signer is the current user.
source
@AuraEnabled global Entity source
The Salesforce source object for the recipient (Contact, Lead, or User).
type
@AuraEnabled global String type
The type of the recipient.
TYPE_SIGNER
global static final String TYPE_SIGNER
Signer (Needs to Sign) recipient type constant.
'Signer'
TYPE_IN_PERSON_SIGNER
global static final String TYPE_IN_PERSON_SIGNER
In person signer recipient type constant.
'InPersonSigner'
TYPE_EMBEDDED_SIGNER
global static final String TYPE_EMBEDDED_SIGNER
Embedded signer recipient type constant.
'EmbeddedSigner'
TYPE_CARBON_COPY
global static final String TYPE_CARBON_COPY
Carbon copy (Receives a Copy) recipient type constant.
'CarbonCopy'
TYPE_CERTIFIED_DELIVERY
global static final String TYPE_CERTIFIED_DELIVERY
Certified delivery (Needs to View) recipient type constant.
'CertifiedDelivery'
TYPE_AGENT
global static final String TYPE_AGENT
Agent (Specify Recipients) recipient type constant.
'Agent'
TYPE_EDITOR
global static final String TYPE_EDITOR
Editor (Allow to Edit) recipient type constant.
'Editor'
TYPE_INTERMEDIARY
global static final String TYPE_INTERMEDIARY
Intermediary (Update Recipients) recipient type constant.
'Intermediary'
STATUS_CREATED
global static final String STATUS_CREATED
Created status constant.
'created'
STATUS_SENT
global static final String STATUS_SENT
Sent status constant.
'sent'
STATUS_DELIVERED
global static final String STATUS_DELIVERED
Delivered status constant.
'delivered'
STATUS_DECLINED
global static final String STATUS_DECLINED
Declined status constant.
'declined'
STATUS_COMPLETED
global static final String STATUS_COMPLETED
Completed status constant.
'completed'
STATUS_SIGNED
global static final String STATUS_SIGNED
Signed status constant.
'signed'
STATUS_CANCELED
global static final String STATUS_CANCELED
Canceled status constant.
'canceled'

Methods

global static Recipient fromSource(final String name, final String email, final String phone, final String role, final Entity source)
Description
Factory method to construct a recipient from a Salesforce source.
Returns
The recipient based on the Salesforce source entity.
Parameters
name
final String name
The recipient name.
email
final String email
The recipient email.
phone
final String phone
The recipient phone that may be used for SMS authentication.
role
final String role
The recipient role.
source
final Entity source
The source Salesforce entity.
global static Recipient newBulkRecipient(final String name, final String email, final Entity source)
Description
Factory method to create a bulk recipient suitable for bulk envelope copies.
Returns
The new Docusign bulk envelope copy recipient.
Parameters
name
final String name
The recipient name.
email
final String email
The recipient email.
source
final Entity source
The Salesforce source object.
global static Recipient newEmbeddedSigner()
Description
Creates an embedded signer recipient for the current user. This recipient is expected to sign an envelope immediately, and will not receive an email requesting signature.
Returns
The newly-created embedded signer.
global static Recipient newEmbeddedSigner(final String name, final String email, final Id sourceId)
Description
Creates an embedded signer recipient. This recipient is expected to sign an envelope within a custom application and will not receive an email requesting signature. The name, email, and ID must match the logged-in user's during signing.
Returns
The newly-created embedded signer.
Parameters
name
final String name
The signer's Salesforce user name.
email
final String email
The signer's Salesforce user email.
sourceId
final Id sourceId
The signer's Salesforce user ID.
global Recipient( final Id id, final String type, final Integer sequence, final Integer routingOrder, final Role role, final String name, final String email, final SigningGroup signingGroup, final String phone, final Authentication authentication, final String note, final EmailSettings emailSettings, final String hostName, final String hostEmail, final Boolean signNow, final Entity source, final Boolean readOnly, final Boolean required )
Description
Constructs a Docusign envelope recipient.
Parameters
id
final Id id
The ID of the associated dfsle__Recipient__c record.
type
final String type
The type of recipient.
sequence
final Integer sequence
The ordinal sequence of the recipient.
routingOrder
final Integer routingOrder
The routing order of the recipient.
role
final Role role
The recipient role.
name
final String name
The name of the recipient.
email
final String email
The email of the recipient.
signingGroup
final SigningGroup signingGroup
The Docusign signing group.
phone
final String phone
The phone number of the recipient.
authentication
final Authentication authentication
Optional authentication method for the recipient.
note
final String note
Optional private note sent to the recipient.
emailSettings
final EmailSettings emailSettings
The email settings for the recipient.
hostName
final String hostName
The host name of the recipient, used for in-person signing.
hostEmail
final String hostEmail
The host email of the recipient, used for in-person signing.
signNow
final Boolean signNow
Whether the recipient should sign now.
source
final Entity source
The Salesforce source object for the recipient.
readOnly
final Boolean readOnly
Whether this recipient may be modified. Used with Docusign templates.
required
final Boolean required
Whether this recipient is required. Used with Docusign templates.
global Recipient withAuthentication(final Authentication authentication)
Description
Sets the recipient authentication property.
Returns
The recipient with updated authentication.
Parameters
authentication
final Authentication authentication
The new recipient authentication.
global Recipient withEmailSettings(final EmailSettings emailSettings)
Description
Sets the recipient emailSettings property.
Returns
The recipient with updated emailSettings.
Parameters
emailSettings
final EmailSettings emailSettings
The new recipient email settings.
global virtual Recipient withEmbeddedRecipientStartURL(final String embeddedRecipientStartURL)
Description
Sets the Recipient's embeddedRecipientStartURL property.
Returns
The recipient with updated embeddedRecipientStartURL.
Parameters
embeddedRecipientStartURL
final String embeddedRecipientStartURL
The valid URL string for redirecting an embedded recipient. If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at Docusign.
global Recipient withNote(final String note)
Description
Sets the recipient note property.
Returns
The recipient with updated note.
Parameters
note
final String note
The new recipient note.
global virtual Recipient withRole(final Role role)
Description
Sets the recipient role property.
Returns
The recipient with updated role.
Parameters
role
final Role role
The new recipient role.
global virtual Recipient withRole(final String role)
Description
Sets the recipient role property.
Returns
The recipient with updated role.
Parameters
role
final String role
The new recipient role.
global Recipient withRoutingOrder(final Integer routingOrder)
Description
Sets the recipient routingOrder property.
Returns
The recipient with updated routingOrder.
Parameters
routingOrder
final Integer routingOrder
The new recipient routing order.
global virtual Recipient withSignatureProviders(final List<SignatureProvider> signatureProviders)
Description
Sets the Recipient's signatureProviders property.
Returns
The Recipient with an updated signatureProviders property.
Parameters
signatureProviders
final List<SignatureProvider> signatureProviders
One or more Standards-Based Signature (digital signature) providers for the signer to use. By default, signers will use electronic signatures without certificates.
global virtual Recipient withSmsDelivery(final String phone)
Description
Enables SMS delivery for a recipient to the specified phone number.
Returns
The recipient with updated phone and deliverBySms.
Parameters
phone
final String phone
The phone number where the envelope will be delivered via SMS.
global virtual Recipient withTabs(final List<Tab> tabs)
Description
Sets the recipient tabs property.
Returns
The recipient with updated tabs.
Parameters
tabs
final List<Tab> tabs
Tabs (e.g. merge fields) associated with the recipient.
global virtual Recipient withType(final String type)
Description
Sets the recipient type property.
Returns
The recipient with updated type.
Parameters
type
final String type
The new recipient type.

Recipient.Role

global class Role implements Comparable
Description
Representation of a Docusign envelope recipient role used for automatic anchor tags or template role matching.
name
@AuraEnabled global String name
The role name.
value
@AuraEnabled global Integer value
The role ordinal used for mapping to automatic anchor tags.

Methods

global Role(final String name, final Integer value)
Description
Constructs a Docusign envelope recipient role.
Parameters
name
final String name
The role name.
value
final Integer value
The role ordinal used for mapping to automatic anchor tags.

Recipient.Authentication

global class Authentication
Description
Representation of Docusign envelope recipient authentication methods.
accessCode
@AuraEnabled global String accessCode
Access code a recipient must enter before opening an envelope.
idCheckRequired
@AuraEnabled global Boolean idCheckRequired
Whether the recipient's ID should be checked.
smsPhoneNumbers
@AuraEnabled global List<String> smsPhoneNumbers
A list of phone numbers to which a SMS authentication code may be sent. Currently only one phone number is supported.

Methods

global Authentication(final String accessCode, final Boolean idCheckRequired, final List<String> smsPhoneNumbers)
Description
Constructs recipient authentication.
Parameters
accessCode
final String accessCode
Access code a recipient must enter before opening an envelope.
idCheckRequired
final Boolean idCheckRequired
Whether the recipient's ID should be checked.
smsPhoneNumbers
final List<String> smsPhoneNumbers
A list of phone numbers to which a SMS authentication code may be sent.

Recipient.EmailSettings

global class EmailSettings
Description
Represents localized Docusign envelope recipient email settings.
language
@AuraEnabled global String language
The language code for the localized emails (e.g 'en', 'pt_BR').
languageLabel
@AuraEnabled global String languageLabel
The localized language label.
message
@AuraEnabled global String message
The localized email message.
subject
@AuraEnabled global String subject
The localized email subject.

Methods

global EmailSettings(final String language, final String languageLabel, final String subject, final String message)
Description
Constructs localized Docusign envelope recipient email settings.
Parameters
language
final String language
The language code for the localized emails.
languageLabel
final String languageLabel
The localized language label.
subject
final String subject
The localized email subject.
message
final String message
The localized email message.

Recipient.Status

global class Status implements Comparable
Description
Docusign recipient status.
completed
@AuraEnabled global Datetime completed
Date and time when the recipient completed signing the envelope.
email
@AuraEnabled global String email
The email address of the recipient.
id
@AuraEnabled global Id id
The ID of the underlying dfsle__RecipientStatus__c record.
lastStatusUpdate
@AuraEnabled global Datetime lastStatusUpdate
Date and time when the status was last updated.
name
@AuraEnabled global String name
The name of the recipient.
reason
@AuraEnabled global String reason
The reason the recipient declined signing the envelope.
routingOrder
@AuraEnabled global Integer routingOrder
The routing order of the recipient.
sent
@AuraEnabled global Datetime sent
Date and time when the recipient received the envelope.
sequence
@AuraEnabled global Integer sequence
The recipient sequence.
source
@AuraEnabled global Entity source
The Salesforce source entity.
status
@AuraEnabled global String status
The current status.
type
@AuraEnabled global String type
The Docusign recipient type.

Methods

global Status( final Id id, final Entity source, final String type, final Integer sequence, final String status, final String name, final String email, final Integer routingOrder, final Datetime sent, final Datetime completed, final String reason, final Datetime lastStatusUpdate )
Description
Constructs a Docusign recipient status.
Parameters
id
final Id id
The ID of the underlying dfsle__RecipientStatus__c record.
source
final Entity source
The Salesforce source entity.
type
final String type
The Docusign recipient type.
sequence
final Integer sequence
The recipient sequence.
status
final String status
The current status.
name
final String name
The name of the recipient.
email
final String email
The email address of the recipient.
routingOrder
final Integer routingOrder
The routing order of the recipient.
sent
final Datetime sent
Date and time when the recipient received the envelope.
completed
final Datetime completed
Date and time when the recipient completed signing the envelope.
reason
final String reason
The reason the recipient declined signing the envelope.
lastStatusUpdate
final Datetime lastStatusUpdate
Date and time when the status was last updated.

Recipient.ResendResult

global class ResendResult
Description
Recipient resend result.
email
@AuraEnabled global String email
The recipient email address.
error
@AuraEnabled global APIError error
The error encountered during update, if any.
routingOrder
@AuraEnabled global Integer routingOrder
The recipient routing order.
sequence
@AuraEnabled global Integer sequence
The recipient sequence.