@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen", date="2016-07-18T18:11:15.675-07:00") public class Editor extends Object
| Constructor and Description |
|---|
Editor() |
| Modifier and Type | Method and Description |
|---|---|
Editor |
accessCode(String accessCode)
If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
|
Editor |
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.
|
Editor |
clientUserId(String clientUserId)
Specifies whether the recipient is embedded or remote.
|
Editor |
customFields(List<String> customFields)
An optional array of strings that allows the sender to provide custom data about the recipient.
|
Editor |
declinedDateTime(String declinedDateTime)
The date and time the recipient declined the document.
|
Editor |
declinedReason(String declinedReason)
The reason the recipient declined the document.
|
Editor |
deliveredDateTime(String deliveredDateTime)
Reserved: For DocuSign use only.
|
Editor |
deliveryMethod(String deliveryMethod)
Reserved: For DocuSign use only.
|
Editor |
email(String email)
Email id of the recipient.
|
Editor |
emailNotification(RecipientEmailNotification emailNotification) |
Editor |
emailRecipientPostSigningURL(String emailRecipientPostSigningURL) |
Editor |
embeddedRecipientStartURL(String embeddedRecipientStartURL)
Specifies a sender provided valid URL string for redirecting an embedded recipient.
|
boolean |
equals(Object o) |
Editor |
errorDetails(ErrorDetails errorDetails) |
Editor |
faxNumber(String faxNumber)
Reserved:
|
String |
getAccessCode() |
String |
getAddAccessCodeToEmail() |
String |
getClientUserId() |
List<String> |
getCustomFields() |
String |
getDeclinedDateTime() |
String |
getDeclinedReason() |
String |
getDeliveredDateTime() |
String |
getDeliveryMethod() |
String |
getEmail() |
RecipientEmailNotification |
getEmailNotification() |
String |
getEmailRecipientPostSigningURL() |
String |
getEmbeddedRecipientStartURL() |
ErrorDetails |
getErrorDetails() |
String |
getFaxNumber() |
String |
getIdCheckConfigurationName() |
IdCheckInformationInput |
getIdCheckInformationInput() |
String |
getInheritEmailNotificationConfiguration() |
String |
getName() |
String |
getNote() |
RecipientPhoneAuthentication |
getPhoneAuthentication() |
List<Attachment> |
getRecipientAttachments() |
AuthenticationStatus |
getRecipientAuthenticationStatus() |
String |
getRecipientId() |
String |
getRecipientIdGuid() |
String |
getRequireIdLookup() |
String |
getRoleName() |
String |
getRoutingOrder() |
RecipientSAMLAuthentication |
getSamlAuthentication() |
String |
getSentDateTime() |
String |
getSignedDateTime() |
String |
getSigningGroupId() |
String |
getSigningGroupName() |
List<UserInfo> |
getSigningGroupUsers() |
RecipientSMSAuthentication |
getSmsAuthentication() |
List<SocialAuthentication> |
getSocialAuthentications() |
String |
getStatus() |
String |
getTemplateLocked() |
String |
getTemplateRequired() |
String |
getTotalTabCount() |
String |
getUserId() |
int |
hashCode() |
Editor |
idCheckConfigurationName(String idCheckConfigurationName)
Specifies authentication check by name.
|
Editor |
idCheckInformationInput(IdCheckInformationInput idCheckInformationInput) |
Editor |
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.
|
Editor |
name(String name)
legal name of the recipient.\n\nMaximum Length: 100 characters.
|
Editor |
note(String note)
Specifies a note that is unique to this recipient.
|
Editor |
phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication) |
Editor |
recipientAttachments(List<Attachment> recipientAttachments)
Reserved:
|
Editor |
recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus) |
Editor |
recipientId(String recipientId)
Unique for the recipient.
|
Editor |
recipientIdGuid(String recipientIdGuid) |
Editor |
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.
|
Editor |
roleName(String roleName)
Optional element.
|
Editor |
routingOrder(String routingOrder)
Specifies the routing order of the recipient in the envelope.
|
Editor |
samlAuthentication(RecipientSAMLAuthentication samlAuthentication) |
Editor |
sentDateTime(String sentDateTime)
The date and time the envelope was sent.
|
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 |
setEmail(String email) |
void |
setEmailNotification(RecipientEmailNotification emailNotification) |
void |
setEmailRecipientPostSigningURL(String emailRecipientPostSigningURL) |
void |
setEmbeddedRecipientStartURL(String embeddedRecipientStartURL) |
void |
setErrorDetails(ErrorDetails errorDetails) |
void |
setFaxNumber(String faxNumber) |
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<Attachment> 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 |
setSigningGroupId(String signingGroupId) |
void |
setSigningGroupName(String signingGroupName) |
void |
setSigningGroupUsers(List<UserInfo> signingGroupUsers) |
void |
setSmsAuthentication(RecipientSMSAuthentication smsAuthentication) |
void |
setSocialAuthentications(List<SocialAuthentication> socialAuthentications) |
void |
setStatus(String status) |
void |
setTemplateLocked(String templateLocked) |
void |
setTemplateRequired(String templateRequired) |
void |
setTotalTabCount(String totalTabCount) |
void |
setUserId(String userId) |
Editor |
signedDateTime(String signedDateTime)
Reserved: For DocuSign use only.
|
Editor |
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).
|
Editor |
signingGroupName(String signingGroupName)
The display name for the signing group.
|
Editor |
signingGroupUsers(List<UserInfo> signingGroupUsers)
A complex type that contains information about users in the signing group.
|
Editor |
smsAuthentication(RecipientSMSAuthentication smsAuthentication) |
Editor |
socialAuthentications(List<SocialAuthentication> socialAuthentications)
Lists the social ID type that can be used for recipient authentication.
|
Editor |
status(String status)
Indicates the envelope status.
|
Editor |
templateLocked(String templateLocked)
When set to **true**, the sender cannot change any attributes of the recipient.
|
Editor |
templateRequired(String templateRequired)
When set to **true**, the sender may not remove the recipient.
|
String |
toString() |
Editor |
totalTabCount(String totalTabCount) |
Editor |
userId(String userId) |
public Editor name(String name)
public String getName()
public void setName(String name)
public Editor email(String email)
public String getEmail()
public void setEmail(String email)
public Editor emailRecipientPostSigningURL(String emailRecipientPostSigningURL)
public String getEmailRecipientPostSigningURL()
public void setEmailRecipientPostSigningURL(String emailRecipientPostSigningURL)
public Editor signingGroupId(String signingGroupId)
public String getSigningGroupId()
public void setSigningGroupId(String signingGroupId)
public Editor signingGroupName(String signingGroupName)
public String getSigningGroupName()
public void setSigningGroupName(String signingGroupName)
public Editor signingGroupUsers(List<UserInfo> signingGroupUsers)
public Editor recipientId(String recipientId)
public String getRecipientId()
public void setRecipientId(String recipientId)
public String getRecipientIdGuid()
public void setRecipientIdGuid(String recipientIdGuid)
public Editor accessCode(String accessCode)
public String getAccessCode()
public void setAccessCode(String accessCode)
public Editor addAccessCodeToEmail(String addAccessCodeToEmail)
public String getAddAccessCodeToEmail()
public void setAddAccessCodeToEmail(String addAccessCodeToEmail)
public Editor requireIdLookup(String requireIdLookup)
public String getRequireIdLookup()
public void setRequireIdLookup(String requireIdLookup)
public Editor idCheckConfigurationName(String idCheckConfigurationName)
public String getIdCheckConfigurationName()
public void setIdCheckConfigurationName(String idCheckConfigurationName)
public Editor socialAuthentications(List<SocialAuthentication> socialAuthentications)
public List<SocialAuthentication> getSocialAuthentications()
public void setSocialAuthentications(List<SocialAuthentication> socialAuthentications)
public Editor phoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
public RecipientPhoneAuthentication getPhoneAuthentication()
public void setPhoneAuthentication(RecipientPhoneAuthentication phoneAuthentication)
public Editor samlAuthentication(RecipientSAMLAuthentication samlAuthentication)
public RecipientSAMLAuthentication getSamlAuthentication()
public void setSamlAuthentication(RecipientSAMLAuthentication samlAuthentication)
public Editor smsAuthentication(RecipientSMSAuthentication smsAuthentication)
public RecipientSMSAuthentication getSmsAuthentication()
public void setSmsAuthentication(RecipientSMSAuthentication smsAuthentication)
public String getUserId()
public void setUserId(String userId)
public Editor clientUserId(String clientUserId)
public String getClientUserId()
public void setClientUserId(String clientUserId)
public Editor embeddedRecipientStartURL(String embeddedRecipientStartURL)
public String getEmbeddedRecipientStartURL()
public void setEmbeddedRecipientStartURL(String embeddedRecipientStartURL)
public Editor customFields(List<String> customFields)
public Editor routingOrder(String routingOrder)
public String getRoutingOrder()
public void setRoutingOrder(String routingOrder)
public Editor idCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
public IdCheckInformationInput getIdCheckInformationInput()
public void setIdCheckInformationInput(IdCheckInformationInput idCheckInformationInput)
public Editor recipientAttachments(List<Attachment> recipientAttachments)
public List<Attachment> getRecipientAttachments()
public void setRecipientAttachments(List<Attachment> recipientAttachments)
public Editor note(String note)
public String getNote()
public void setNote(String note)
public Editor roleName(String roleName)
public String getRoleName()
public void setRoleName(String roleName)
public Editor status(String status)
public String getStatus()
public void setStatus(String status)
public String getSignedDateTime()
public void setSignedDateTime(String signedDateTime)
public Editor deliveredDateTime(String deliveredDateTime)
public String getDeliveredDateTime()
public void setDeliveredDateTime(String deliveredDateTime)
public Editor declinedDateTime(String declinedDateTime)
public String getDeclinedDateTime()
public void setDeclinedDateTime(String declinedDateTime)
public Editor sentDateTime(String sentDateTime)
public String getSentDateTime()
public void setSentDateTime(String sentDateTime)
public Editor declinedReason(String declinedReason)
public String getDeclinedReason()
public void setDeclinedReason(String declinedReason)
public String getDeliveryMethod()
public void setDeliveryMethod(String deliveryMethod)
public String getFaxNumber()
public void setFaxNumber(String faxNumber)
public Editor templateLocked(String templateLocked)
public String getTemplateLocked()
public void setTemplateLocked(String templateLocked)
public Editor templateRequired(String templateRequired)
public String getTemplateRequired()
public void setTemplateRequired(String templateRequired)
public Editor emailNotification(RecipientEmailNotification emailNotification)
public RecipientEmailNotification getEmailNotification()
public void setEmailNotification(RecipientEmailNotification emailNotification)
public Editor inheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
public String getInheritEmailNotificationConfiguration()
public void setInheritEmailNotificationConfiguration(String inheritEmailNotificationConfiguration)
public Editor errorDetails(ErrorDetails errorDetails)
public ErrorDetails getErrorDetails()
public void setErrorDetails(ErrorDetails errorDetails)
public Editor recipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
public AuthenticationStatus getRecipientAuthenticationStatus()
public void setRecipientAuthenticationStatus(AuthenticationStatus recipientAuthenticationStatus)
public String getTotalTabCount()
public void setTotalTabCount(String totalTabCount)
Copyright © 2016. All rights reserved.