public class NotaryHost extends Object
Constructor and Description |
---|
NotaryHost() |
Modifier and Type | Method and Description |
---|---|
NotaryHost |
accessCode(String accessCode) |
NotaryHost |
addAccessCodeToEmail(String addAccessCodeToEmail) |
NotaryHost |
addCustomFieldsItem(String customFieldsItem) |
NotaryHost |
addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem) |
NotaryHost |
addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem) |
NotaryHost |
addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem) |
NotaryHost |
clientUserId(String clientUserId) |
NotaryHost |
customFields(List<String> customFields) |
NotaryHost |
declinedDateTime(String declinedDateTime) |
NotaryHost |
declinedReason(String declinedReason) |
NotaryHost |
deliveredDateTime(String deliveredDateTime) |
NotaryHost |
deliveryMethod(String deliveryMethod) |
NotaryHost |
documentVisibility(List<DocumentVisibility> documentVisibility) |
NotaryHost |
email(String email) |
NotaryHost |
emailNotification(RecipientEmailNotification emailNotification) |
NotaryHost |
embeddedRecipientStartURL(String embeddedRecipientStartURL) |
boolean |
equals(Object o) |
NotaryHost |
errorDetails(ErrorDetails errorDetails) |
NotaryHost |
faxNumber(String faxNumber) |
String |
getAccessCode()
If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
|
String |
getAddAccessCodeToEmail()
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.
|
String |
getClientUserId()
Specifies whether the recipient is embedded or remote.
|
List<String> |
getCustomFields()
An optional array of strings that allows the sender to provide custom data about the recipient.
|
String |
getDeclinedDateTime()
The date and time the recipient declined the document.
|
String |
getDeclinedReason()
The reason the recipient declined the document.
|
String |
getDeliveredDateTime()
Reserved: For DocuSign use only.
|
String |
getDeliveryMethod()
Reserved: For DocuSign use only.
|
List<DocumentVisibility> |
getDocumentVisibility() |
String |
getEmail() |
RecipientEmailNotification |
getEmailNotification()
Get emailNotification
|
String |
getEmbeddedRecipientStartURL()
Specifies a sender provided valid URL string for redirecting an embedded recipient.
|
ErrorDetails |
getErrorDetails()
Get errorDetails
|
String |
getFaxNumber()
Reserved:
|
String |
getHostRecipientId() |
String |
getIdCheckConfigurationName()
Specifies authentication check by name.
|
IdCheckInformationInput |
getIdCheckInformationInput()
Get idCheckInformationInput
|
String |
getInheritEmailNotificationConfiguration()
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.
|
String |
getName() |
String |
getNote()
Specifies a note that is unique to this recipient.
|
RecipientPhoneAuthentication |
getPhoneAuthentication()
Get phoneAuthentication
|
List<RecipientAttachment> |
getRecipientAttachments()
Reserved:
|
AuthenticationStatus |
getRecipientAuthenticationStatus()
Get recipientAuthenticationStatus
|
String |
getRecipientId()
Unique for the recipient.
|
String |
getRecipientIdGuid() |
String |
getRequireIdLookup()
When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
|
String |
getRoleName()
Optional element.
|
String |
getRoutingOrder()
Specifies the routing order of the recipient in the envelope.
|
RecipientSAMLAuthentication |
getSamlAuthentication()
Get samlAuthentication
|
String |
getSentDateTime()
The date and time the envelope was sent.
|
String |
getSignedDateTime()
Reserved: For DocuSign use only.
|
RecipientSMSAuthentication |
getSmsAuthentication()
Get smsAuthentication
|
List<SocialAuthentication> |
getSocialAuthentications()
Lists the social ID type that can be used for recipient authentication.
|
String |
getStatus()
Indicates the envelope status.
|
Tabs |
getTabs()
Get tabs
|
String |
getTemplateLocked()
When set to **true**, the sender cannot change any attributes of the recipient.
|
String |
getTemplateRequired()
When set to **true**, the sender may not remove the recipient.
|
String |
getTotalTabCount() |
String |
getUserId() |
int |
hashCode() |
NotaryHost |
hostRecipientId(String hostRecipientId) |
NotaryHost |
idCheckConfigurationName(String idCheckConfigurationName) |
NotaryHost |
idCheckInformationInput(IdCheckInformationInput idCheckInformationInput) |
NotaryHost |
inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration) |
NotaryHost |
name(String name) |
NotaryHost |
note(String note) |
NotaryHost |
phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication) |
NotaryHost |
recipientAttachments(List<RecipientAttachment> recipientAttachments) |
NotaryHost |
recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus) |
NotaryHost |
recipientId(String recipientId) |
NotaryHost |
recipientIdGuid(String recipientIdGuid) |
NotaryHost |
requireIdLookup(String requireIdLookup) |
NotaryHost |
roleName(String roleName) |
NotaryHost |
routingOrder(String routingOrder) |
NotaryHost |
samlAuthentication(RecipientSAMLAuthentication samlAuthentication) |
NotaryHost |
sentDateTime(String sentDateTime) |
void |
setAccessCode(String accessCode) |
void |
setAddAccessCodeToEmail(String addAccessCodeToEmail) |
void |
setClientUserId(String clientUserId) |
void |
setCustomFields(List<String> customFields) |
void |
setDeclinedDateTime(String declinedDateTime) |
void |
setDeclinedReason(String declinedReason) |
void |
setDeliveredDateTime(String deliveredDateTime) |
void |
setDeliveryMethod(String deliveryMethod) |
void |
setDocumentVisibility(List<DocumentVisibility> documentVisibility) |
void |
setEmail(String email) |
void |
setEmailNotification(RecipientEmailNotification emailNotification) |
void |
setEmbeddedRecipientStartURL(String embeddedRecipientStartURL) |
void |
setErrorDetails(ErrorDetails errorDetails) |
void |
setFaxNumber(String faxNumber) |
void |
setHostRecipientId(String hostRecipientId) |
void |
setIdCheckConfigurationName(String idCheckConfigurationName) |
void |
setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput) |
void |
setInheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration) |
void |
setName(String name) |
void |
setNote(String note) |
void |
setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication) |
void |
setRecipientAttachments(List<RecipientAttachment> recipientAttachments) |
void |
setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus) |
void |
setRecipientId(String recipientId) |
void |
setRecipientIdGuid(String recipientIdGuid) |
void |
setRequireIdLookup(String requireIdLookup) |
void |
setRoleName(String roleName) |
void |
setRoutingOrder(String routingOrder) |
void |
setSamlAuthentication(RecipientSAMLAuthentication samlAuthentication) |
void |
setSentDateTime(String sentDateTime) |
void |
setSignedDateTime(String signedDateTime) |
void |
setSmsAuthentication(RecipientSMSAuthentication smsAuthentication) |
void |
setSocialAuthentications(List<SocialAuthentication> socialAuthentications) |
void |
setStatus(String status) |
void |
setTabs(Tabs tabs) |
void |
setTemplateLocked(String templateLocked) |
void |
setTemplateRequired(String templateRequired) |
void |
setTotalTabCount(String totalTabCount) |
void |
setUserId(String userId) |
NotaryHost |
signedDateTime(String signedDateTime) |
NotaryHost |
smsAuthentication(RecipientSMSAuthentication smsAuthentication) |
NotaryHost |
socialAuthentications(List<SocialAuthentication> socialAuthentications) |
NotaryHost |
status(String status) |
NotaryHost |
tabs(Tabs tabs) |
NotaryHost |
templateLocked(String templateLocked) |
NotaryHost |
templateRequired(String templateRequired) |
String |
toString() |
NotaryHost |
totalTabCount(String totalTabCount) |
NotaryHost |
userId(String userId) |
public NotaryHost accessCode(String accessCode)
public String getAccessCode()
public void setAccessCode(String accessCode)
public NotaryHost addAccessCodeToEmail(String addAccessCodeToEmail)
public String getAddAccessCodeToEmail()
public void setAddAccessCodeToEmail(String addAccessCodeToEmail)
public NotaryHost clientUserId(String clientUserId)
public String getClientUserId()
public void setClientUserId(String clientUserId)
public NotaryHost customFields(List<String> customFields)
public NotaryHost addCustomFieldsItem(String customFieldsItem)
public List<String> getCustomFields()
public NotaryHost declinedDateTime(String declinedDateTime)
public String getDeclinedDateTime()
public void setDeclinedDateTime(String declinedDateTime)
public NotaryHost declinedReason(String declinedReason)
public String getDeclinedReason()
public void setDeclinedReason(String declinedReason)
public NotaryHost deliveredDateTime(String deliveredDateTime)
public String getDeliveredDateTime()
public void setDeliveredDateTime(String deliveredDateTime)
public NotaryHost deliveryMethod(String deliveryMethod)
public String getDeliveryMethod()
public void setDeliveryMethod(String deliveryMethod)
public NotaryHost documentVisibility(List<DocumentVisibility> documentVisibility)
public NotaryHost addDocumentVisibilityItem(DocumentVisibility documentVisibilityItem)
public List<DocumentVisibility> getDocumentVisibility()
public void setDocumentVisibility(List<DocumentVisibility> documentVisibility)
public NotaryHost email(String email)
public String getEmail()
public void setEmail(String email)
public NotaryHost emailNotification(RecipientEmailNotification emailNotification)
public RecipientEmailNotification getEmailNotification()
public void setEmailNotification(RecipientEmailNotification emailNotification)
public NotaryHost embeddedRecipientStartURL(String embeddedRecipientStartURL)
public String getEmbeddedRecipientStartURL()
public void setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)
public NotaryHost errorDetails(ErrorDetails errorDetails)
public ErrorDetails getErrorDetails()
public void setErrorDetails(ErrorDetails errorDetails)
public NotaryHost faxNumber(String faxNumber)
public String getFaxNumber()
public void setFaxNumber(String faxNumber)
public NotaryHost hostRecipientId(String hostRecipientId)
public String getHostRecipientId()
public void setHostRecipientId(String hostRecipientId)
public NotaryHost idCheckConfigurationName(String idCheckConfigurationName)
public String getIdCheckConfigurationName()
public void setIdCheckConfigurationName(String idCheckConfigurationName)
public NotaryHost idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
public IdCheckInformationInput getIdCheckInformationInput()
public void setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
public NotaryHost inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
public String getInheritEmailNotificationConfiguration()
public void setInheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
public NotaryHost name(String name)
public String getName()
public void setName(String name)
public NotaryHost note(String note)
public String getNote()
public void setNote(String note)
public NotaryHost phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
public RecipientPhoneAuthentication getPhoneAuthentication()
public void setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
public NotaryHost recipientAttachments(List<RecipientAttachment> recipientAttachments)
public NotaryHost addRecipientAttachmentsItem(RecipientAttachment recipientAttachmentsItem)
public List<RecipientAttachment> getRecipientAttachments()
public void setRecipientAttachments(List<RecipientAttachment> recipientAttachments)
public NotaryHost recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
public AuthenticationStatus getRecipientAuthenticationStatus()
public void setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
public NotaryHost recipientId(String recipientId)
public String getRecipientId()
public void setRecipientId(String recipientId)
public NotaryHost recipientIdGuid(String recipientIdGuid)
public String getRecipientIdGuid()
public void setRecipientIdGuid(String recipientIdGuid)
public NotaryHost requireIdLookup(String requireIdLookup)
public String getRequireIdLookup()
public void setRequireIdLookup(String requireIdLookup)
public NotaryHost roleName(String roleName)
public String getRoleName()
public void setRoleName(String roleName)
public NotaryHost routingOrder(String routingOrder)
public String getRoutingOrder()
public void setRoutingOrder(String routingOrder)
public NotaryHost samlAuthentication(RecipientSAMLAuthentication samlAuthentication)
public RecipientSAMLAuthentication getSamlAuthentication()
public void setSamlAuthentication(RecipientSAMLAuthentication samlAuthentication)
public NotaryHost sentDateTime(String sentDateTime)
public String getSentDateTime()
public void setSentDateTime(String sentDateTime)
public NotaryHost signedDateTime(String signedDateTime)
public String getSignedDateTime()
public void setSignedDateTime(String signedDateTime)
public NotaryHost smsAuthentication(RecipientSMSAuthentication smsAuthentication)
public RecipientSMSAuthentication getSmsAuthentication()
public void setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)
public NotaryHost socialAuthentications(List<SocialAuthentication> socialAuthentications)
public NotaryHost addSocialAuthenticationsItem(SocialAuthentication socialAuthenticationsItem)
public List<SocialAuthentication> getSocialAuthentications()
public void setSocialAuthentications(List<SocialAuthentication> socialAuthentications)
public NotaryHost status(String status)
public String getStatus()
public void setStatus(String status)
public NotaryHost tabs(Tabs tabs)
public Tabs getTabs()
public void setTabs(Tabs tabs)
public NotaryHost templateLocked(String templateLocked)
public String getTemplateLocked()
public void setTemplateLocked(String templateLocked)
public NotaryHost templateRequired(String templateRequired)
public String getTemplateRequired()
public void setTemplateRequired(String templateRequired)
public NotaryHost totalTabCount(String totalTabCount)
public String getTotalTabCount()
public void setTotalTabCount(String totalTabCount)
public NotaryHost userId(String userId)
public String getUserId()
public void setUserId(String userId)
Copyright © 2018. All rights reserved.