Skip to navigation
Apex Toolkit reference

RecipientService

View as Markdown
global with sharing class RecipientService
Description
This class is the entry point for Docusign eSignature envelope recipient management. It provides methods to retrieve Salesforce source recipients.

Methods

global static List<Recipient.Role> getDefaultRoles()
Description
Retrieves a list of default recipient roles. These map to automatic anchor tags. For example, role 1 will map to \s1\, \d1\, etc.
Returns
A list of default recipient roles.
global static List<Recipient> getRecipients(final SObjectType type, final Set<Id> ids)
Description
Retrieves a list of Docusign envelope recipients from Salesforce source objects.

By default, the Salesforce Account, Case, Contact, Lead, and Opportunity types are supported. More types may be supported via plugins.

Returns
A list of envelope recipients.
Parameters
type
final SObjectType type
The Salesforce object type.
ids
final Set<Id> ids
The Salesforce object IDs.
global static List<Recipient> searchRecipients(final SObjectType type, final String firstName, final String lastName)
Description
Searches for Docusign envelope recipients from Salesforce source objects.

By default, the Salesforce Contact, Lead, and User types are supported. More types may be supported via plugins.

Search behavior is defined and stored in account settings. See dfsle.Recipient.SearchBehavior and dfsle.AccountService.Settings for more details.

Returns
A list of envelope recipients.
Parameters
type
final SObjectType type
The Salesforce object type.
firstName
final String firstName
The first name to match.
lastName
final String lastName
The last name to match. Ignored for compound search behaviors.
See
Recipient.SearchBehavior for more details on search options.