Uses of Class
com.docusign.esign.model.Agent

Packages that use Agent

Package	Description
com.docusign.esign.model

Uses of Agent in com.docusign.esign.model

Methods in com.docusign.esign.model that return Agent

Modifier and Type	Method and Description
Agent	Agent.accessCode(String accessCode) If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
Agent	Agent.addAccessCodeToEmail(String addAccessCodeToEmail) This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
Agent	Agent.clientUserId(String clientUserId) Specifies whether the recipient is embedded or remote.
Agent	Agent.customFields(List<String> customFields) An optional array of strings that allows the sender to provide custom data about the recipient.
Agent	Agent.declinedDateTime(String declinedDateTime) The date and time the recipient declined the document.
Agent	Agent.declinedReason(String declinedReason) The reason the recipient declined the document.
Agent	Agent.deliveredDateTime(String deliveredDateTime) Reserved: For DocuSign use only.
Agent	Agent.deliveryMethod(String deliveryMethod) Reserved: For DocuSign use only.
Agent	Agent.email(String email) Email id of the recipient.
Agent	Agent.emailNotification(RecipientEmailNotification emailNotification)
Agent	Agent.emailRecipientPostSigningURL(String emailRecipientPostSigningURL)
Agent	Agent.embeddedRecipientStartURL(String embeddedRecipientStartURL) Specifies a sender provided valid URL string for redirecting an embedded recipient.
Agent	Agent.errorDetails(ErrorDetails errorDetails)
Agent	Agent.excludedDocuments(List<String> excludedDocuments) Specifies the documents that are not visible to this recipient.
Agent	Agent.faxNumber(String faxNumber) Reserved:
Agent	Agent.idCheckConfigurationName(String idCheckConfigurationName) Specifies authentication check by name.
Agent	Agent.idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
Agent	Agent.inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration) When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
Agent	Agent.name(String name)
Agent	Agent.note(String note) Specifies a note that is unique to this recipient.
Agent	Agent.phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
Agent	Agent.recipientAttachments(List<Attachment> recipientAttachments) Reserved:
Agent	Agent.recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
Agent	Agent.recipientId(String recipientId) Unique for the recipient.
Agent	Agent.recipientIdGuid(String recipientIdGuid)
Agent	Agent.requireIdLookup(String requireIdLookup) When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
Agent	Agent.roleName(String roleName) Optional element.
Agent	Agent.routingOrder(String routingOrder) Specifies the routing order of the recipient in the envelope.
Agent	Agent.samlAuthentication(RecipientSAMLAuthentication samlAuthentication)
Agent	Agent.sentDateTime(String sentDateTime) The date and time the envelope was sent.
Agent	Agent.signedDateTime(String signedDateTime) Reserved: For DocuSign use only.
Agent	Agent.signingGroupId(String signingGroupId) When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
Agent	Agent.signingGroupName(String signingGroupName) The display name for the signing group.
Agent	Agent.signingGroupUsers(List<UserInfo> signingGroupUsers) A complex type that contains information about users in the signing group.
Agent	Agent.smsAuthentication(RecipientSMSAuthentication smsAuthentication)
Agent	Agent.socialAuthentications(List<SocialAuthentication> socialAuthentications) Lists the social ID type that can be used for recipient authentication.
Agent	Agent.status(String status) Indicates the envelope status.
Agent	Agent.templateLocked(String templateLocked) When set to **true**, the sender cannot change any attributes of the recipient.
Agent	Agent.templateRequired(String templateRequired) When set to **true**, the sender may not remove the recipient.
Agent	Agent.totalTabCount(String totalTabCount)
Agent	Agent.userId(String userId)

Methods in com.docusign.esign.model that return types with arguments of type Agent

Modifier and Type	Method and Description
List<Agent>	TemplateRecipients.getAgents()
List<Agent>	Recipients.getAgents()

Method parameters in com.docusign.esign.model with type arguments of type Agent

Modifier and Type	Method and Description
TemplateRecipients	TemplateRecipients.agents(List<Agent> agents) A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document.
Recipients	Recipients.agents(List<Agent> agents) A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document.
void	TemplateRecipients.setAgents(List<Agent> agents)
void	Recipients.setAgents(List<Agent> agents)