Package com.docusign.esign.model

Class RecipientOption

  • public class RecipientOption
extends java.lang.Object
    RecipientOption.

    • Constructor Summary

      Constructors 
      Constructor Description
      RecipientOption()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      RecipientOption email​(java.lang.String email)
      email.
      boolean equals​(java.lang.Object o)
      Compares objects.
      java.lang.String getEmail()
      .
      java.lang.String getName()
      .
      java.lang.String getRecipientLabel()
      .
      java.lang.String getRoleName()
      Optional element.
      java.lang.String getSigningGroupId()
      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)..
      int hashCode()
      Returns the HashCode.
      RecipientOption name​(java.lang.String name)
      name.
      RecipientOption recipientLabel​(java.lang.String recipientLabel)
      recipientLabel.
      RecipientOption roleName​(java.lang.String roleName)
      roleName.
      void setEmail​(java.lang.String email)
      setEmail.
      void setName​(java.lang.String name)
      setName.
      void setRecipientLabel​(java.lang.String recipientLabel)
      setRecipientLabel.
      void setRoleName​(java.lang.String roleName)
      setRoleName.
      void setSigningGroupId​(java.lang.String signingGroupId)
      setSigningGroupId.
      RecipientOption signingGroupId​(java.lang.String signingGroupId)
      signingGroupId.
      java.lang.String toString()
      Converts the given object to string.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RecipientOption

        public RecipientOption()

    • Method Detail

      • email

        public RecipientOption email​(java.lang.String email)
        email.
        Returns:
        RecipientOption

      • getEmail

        public java.lang.String getEmail()
        .
        Returns:
        email

      • setEmail

        public void setEmail​(java.lang.String email)
        setEmail.

      • name

        public RecipientOption name​(java.lang.String name)
        name.
        Returns:
        RecipientOption

      • getName

        public java.lang.String getName()
        .
        Returns:
        name

      • setName

        public void setName​(java.lang.String name)
        setName.

      • recipientLabel

        public RecipientOption recipientLabel​(java.lang.String recipientLabel)
        recipientLabel.
        Returns:
        RecipientOption

      • getRecipientLabel

        public java.lang.String getRecipientLabel()
        .
        Returns:
        recipientLabel

      • setRecipientLabel

        public void setRecipientLabel​(java.lang.String recipientLabel)
        setRecipientLabel.

      • roleName

        public RecipientOption roleName​(java.lang.String roleName)
        roleName.
        Returns:
        RecipientOption

      • getRoleName

        public java.lang.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​(java.lang.String roleName)
        setRoleName.

      • signingGroupId

        public RecipientOption signingGroupId​(java.lang.String signingGroupId)
        signingGroupId.
        Returns:
        RecipientOption

      • getSigningGroupId

        public java.lang.String getSigningGroupId()
        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)..
        Returns:
        signingGroupId

      • setSigningGroupId

        public void setSigningGroupId​(java.lang.String signingGroupId)
        setSigningGroupId.

      • equals

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

      • hashCode

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

      • toString

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