com.docusign.esign.model

Class PowerFormRecipient

java.lang.Object

com.docusign.esign.model.PowerFormRecipient

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-03-06T16:42:36.211-08:00")
public class PowerFormRecipient
extends Object

Constructor Summary

Constructors

Constructor and Description
PowerFormRecipient()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAccessCode() If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
String	getAccessCodeLocked()
String	getAccessCodeRequired()
String	getEmail()
String	getEmailLocked()
String	getIdCheckConfigurationName() Specifies authentication check by name.
String	getIdCheckRequired()
String	getName()
String	getRecipientType()
String	getRoleName() Optional element.
String	getRoutingOrder() Specifies the routing order of the recipient in the envelope.
String	getTemplateRequiresIdLookup()
String	getUserNameLocked()
int	hashCode()
void	setAccessCode(String accessCode)
void	setAccessCodeLocked(String accessCodeLocked)
void	setAccessCodeRequired(String accessCodeRequired)
void	setEmail(String email)
void	setEmailLocked(String emailLocked)
void	setIdCheckConfigurationName(String idCheckConfigurationName)
void	setIdCheckRequired(String idCheckRequired)
void	setName(String name)
void	setRecipientType(String recipientType)
void	setRoleName(String roleName)
void	setRoutingOrder(String routingOrder)
void	setTemplateRequiresIdLookup(String templateRequiresIdLookup)
void	setUserNameLocked(String userNameLocked)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PowerFormRecipient

public PowerFormRecipient()

Method Detail

getAccessCode

public String getAccessCode()

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account’s access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.

setAccessCode

public void setAccessCode(String accessCode)

getAccessCodeLocked

public String getAccessCodeLocked()

setAccessCodeLocked

public void setAccessCodeLocked(String accessCodeLocked)

getAccessCodeRequired

public String getAccessCodeRequired()

setAccessCodeRequired

public void setAccessCodeRequired(String accessCodeRequired)

getEmail

public String getEmail()

setEmail

public void setEmail(String email)

getEmailLocked

public String getEmailLocked()

setEmailLocked

public void setEmailLocked(String emailLocked)

getIdCheckConfigurationName

public String getIdCheckConfigurationName()

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting.\n\n*Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node.

setIdCheckConfigurationName

public void setIdCheckConfigurationName(String idCheckConfigurationName)

getIdCheckRequired

public String getIdCheckRequired()

setIdCheckRequired

public void setIdCheckRequired(String idCheckRequired)

getName

public String getName()

setName

public void setName(String name)

getRecipientType

public String getRecipientType()

setRecipientType

public void setRecipientType(String recipientType)

getRoleName

public String getRoleName()

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

setRoleName

public void setRoleName(String roleName)

getRoutingOrder

public String getRoutingOrder()

Specifies the routing order of the recipient in the envelope.

setRoutingOrder

public void setRoutingOrder(String routingOrder)

getTemplateRequiresIdLookup

public String getTemplateRequiresIdLookup()

setTemplateRequiresIdLookup

public void setTemplateRequiresIdLookup(String templateRequiresIdLookup)

getUserNameLocked

public String getUserNameLocked()

setUserNameLocked

public void setUserNameLocked(String userNameLocked)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object