PowerFormRecipient (docusign-esign-java 3.2.0 API)

java.lang.Object
- com.docusign.esign.model.PowerFormRecipient

public class PowerFormRecipient
extends Object

PowerFormRecipient

Constructor Summary

Constructors
Constructor and Description

PowerFormRecipient()

Constructors
Constructor and Description
`PowerFormRecipient()`

Method Summary

Methods
Modifier and Type	Method and Description
`PowerFormRecipient`	`accessCode(String accessCode)`
`PowerFormRecipient`	`accessCodeLocked(String accessCodeLocked)`
`PowerFormRecipient`	`accessCodeRequired(String accessCodeRequired)`
`PowerFormRecipient`	`email(String email)`
`PowerFormRecipient`	`emailLocked(String emailLocked)`
`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()`
`PowerFormRecipient`	`idCheckConfigurationName(String idCheckConfigurationName)`
`PowerFormRecipient`	`idCheckRequired(String idCheckRequired)`
`PowerFormRecipient`	`name(String name)`
`PowerFormRecipient`	`recipientType(String recipientType)`
`PowerFormRecipient`	`roleName(String roleName)`
`PowerFormRecipient`	`routingOrder(String routingOrder)`
`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)`
`PowerFormRecipient`	`templateRequiresIdLookup(String templateRequiresIdLookup)`
`String`	`toString()`
`PowerFormRecipient`	`userNameLocked(String userNameLocked)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PowerFormRecipient
```
public PowerFormRecipient()
```
- Method Detail
  - accessCode
```
public PowerFormRecipient accessCode(String accessCode)
```
  - 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. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
    
    Returns:
    accessCode
  - setAccessCode
```
public void setAccessCode(String accessCode)
```
  - accessCodeLocked
```
public PowerFormRecipient accessCodeLocked(String accessCodeLocked)
```
  - getAccessCodeLocked
```
public String getAccessCodeLocked()
```
    Returns:
    accessCodeLocked
  - setAccessCodeLocked
```
public void setAccessCodeLocked(String accessCodeLocked)
```
  - accessCodeRequired
```
public PowerFormRecipient accessCodeRequired(String accessCodeRequired)
```
  - getAccessCodeRequired
```
public String getAccessCodeRequired()
```
    Returns:
    accessCodeRequired
  - setAccessCodeRequired
```
public void setAccessCodeRequired(String accessCodeRequired)
```
  - email
```
public PowerFormRecipient email(String email)
```
  - getEmail
```
public String getEmail()
```
    Returns:
    email
  - setEmail
```
public void setEmail(String email)
```
  - emailLocked
```
public PowerFormRecipient emailLocked(String emailLocked)
```
  - getEmailLocked
```
public String getEmailLocked()
```
    Returns:
    emailLocked
  - setEmailLocked
```
public void setEmailLocked(String emailLocked)
```
  - idCheckConfigurationName
```
public PowerFormRecipient idCheckConfigurationName(String idCheckConfigurationName)
```
  - 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. *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.
    
    Returns:
    idCheckConfigurationName
  - setIdCheckConfigurationName
```
public void setIdCheckConfigurationName(String idCheckConfigurationName)
```
  - idCheckRequired
```
public PowerFormRecipient idCheckRequired(String idCheckRequired)
```
  - getIdCheckRequired
```
public String getIdCheckRequired()
```
    Returns:
    idCheckRequired
  - setIdCheckRequired
```
public void setIdCheckRequired(String idCheckRequired)
```
  - name
```
public PowerFormRecipient name(String name)
```
  - getName
```
public String getName()
```
    Returns:
    name
  - setName
```
public void setName(String name)
```
  - recipientType
```
public PowerFormRecipient recipientType(String recipientType)
```
  - getRecipientType
```
public String getRecipientType()
```
    Returns:
    recipientType
  - setRecipientType
```
public void setRecipientType(String recipientType)
```
  - roleName
```
public PowerFormRecipient roleName(String roleName)
```
  - getRoleName
```
public String getRoleName()
```
    Optional element. Specifies the role name associated with the recipient.
    
    This is required when working with template recipients.
    
    Returns:
    roleName
  - setRoleName
```
public void setRoleName(String roleName)
```
  - routingOrder
```
public PowerFormRecipient routingOrder(String routingOrder)
```
  - getRoutingOrder
```
public String getRoutingOrder()
```
    Specifies the routing order of the recipient in the envelope.
    
    Returns:
    routingOrder
  - setRoutingOrder
```
public void setRoutingOrder(String routingOrder)
```
  - templateRequiresIdLookup
```
public PowerFormRecipient templateRequiresIdLookup(String templateRequiresIdLookup)
```
  - getTemplateRequiresIdLookup
```
public String getTemplateRequiresIdLookup()
```
    Returns:
    templateRequiresIdLookup
  - setTemplateRequiresIdLookup
```
public void setTemplateRequiresIdLookup(String templateRequiresIdLookup)
```
  - userNameLocked
```
public PowerFormRecipient userNameLocked(String userNameLocked)
```
  - getUserNameLocked
```
public String getUserNameLocked()
```
    Returns:
    userNameLocked
  - 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

Class PowerFormRecipient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PowerFormRecipient

Method Detail

accessCode

getAccessCode

setAccessCode

accessCodeLocked

getAccessCodeLocked

setAccessCodeLocked

accessCodeRequired

getAccessCodeRequired

setAccessCodeRequired

email

getEmail

setEmail

emailLocked

getEmailLocked

setEmailLocked

idCheckConfigurationName

getIdCheckConfigurationName

setIdCheckConfigurationName

idCheckRequired

getIdCheckRequired

setIdCheckRequired

name

getName

setName

recipientType

getRecipientType

setRecipientType

roleName

getRoleName

setRoleName

routingOrder

getRoutingOrder

setRoutingOrder

templateRequiresIdLookup

getTemplateRequiresIdLookup

setTemplateRequiresIdLookup

userNameLocked

getUserNameLocked

setUserNameLocked

equals

hashCode

toString