Package com.docusign.esign.model

Class PowerFormRecipient

  • public class PowerFormRecipient
extends Object
    **Note:** For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`..

    • 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. 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)
        setAccessCode.

      • accessCodeLocked

        public PowerFormRecipient accessCodeLocked​(String accessCodeLocked)
        accessCodeLocked.
        Returns:
        PowerFormRecipient

      • getAccessCodeLocked

        public String getAccessCodeLocked()
        .
        Returns:
        accessCodeLocked

      • setAccessCodeLocked

        public void setAccessCodeLocked​(String accessCodeLocked)
        setAccessCodeLocked.

      • accessCodeRequired

        public PowerFormRecipient accessCodeRequired​(String accessCodeRequired)
        accessCodeRequired.
        Returns:
        PowerFormRecipient

      • getAccessCodeRequired

        public String getAccessCodeRequired()
        .
        Returns:
        accessCodeRequired

      • setAccessCodeRequired

        public void setAccessCodeRequired​(String accessCodeRequired)
        setAccessCodeRequired.

      • getEmail

        public String getEmail()
        .
        Returns:
        email

      • setEmail

        public void setEmail​(String email)
        setEmail.

      • getEmailLocked

        public String getEmailLocked()
        .
        Returns:
        emailLocked

      • setEmailLocked

        public void setEmailLocked​(String emailLocked)
        setEmailLocked.

      • idCheckConfigurationName

        public PowerFormRecipient idCheckConfigurationName​(String idCheckConfigurationName)
        idCheckConfigurationName.
        Returns:
        PowerFormRecipient

      • 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)
        setIdCheckConfigurationName.

      • idCheckRequired

        public PowerFormRecipient idCheckRequired​(String idCheckRequired)
        idCheckRequired.
        Returns:
        PowerFormRecipient

      • getIdCheckRequired

        public String getIdCheckRequired()
        .
        Returns:
        idCheckRequired

      • setIdCheckRequired

        public void setIdCheckRequired​(String idCheckRequired)
        setIdCheckRequired.

      • getName

        public String getName()
        .
        Returns:
        name

      • setName

        public void setName​(String name)
        setName.

      • recipientType

        public PowerFormRecipient recipientType​(String recipientType)
        recipientType.
        Returns:
        PowerFormRecipient

      • getRecipientType

        public String getRecipientType()
        .
        Returns:
        recipientType

      • setRecipientType

        public void setRecipientType​(String recipientType)
        setRecipientType.

      • 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)
        setRoleName.

      • routingOrder

        public PowerFormRecipient routingOrder​(String routingOrder)
        routingOrder.
        Returns:
        PowerFormRecipient

      • getRoutingOrder

        public String getRoutingOrder()
        Specifies the routing order of the recipient in the envelope. .
        Returns:
        routingOrder

      • setRoutingOrder

        public void setRoutingOrder​(String routingOrder)
        setRoutingOrder.

      • templateRequiresIdLookup

        public PowerFormRecipient templateRequiresIdLookup​(String templateRequiresIdLookup)
        templateRequiresIdLookup.
        Returns:
        PowerFormRecipient

      • getTemplateRequiresIdLookup

        public String getTemplateRequiresIdLookup()
        .
        Returns:
        templateRequiresIdLookup

      • setTemplateRequiresIdLookup

        public void setTemplateRequiresIdLookup​(String templateRequiresIdLookup)
        setTemplateRequiresIdLookup.

      • userNameLocked

        public PowerFormRecipient userNameLocked​(String userNameLocked)
        userNameLocked.
        Returns:
        PowerFormRecipient

      • getUserNameLocked

        public String getUserNameLocked()
        .
        Returns:
        userNameLocked

      • setUserNameLocked

        public void setUserNameLocked​(String userNameLocked)
        setUserNameLocked.

      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object