Package com.docusign.esign.model

Class BulkRecipient

  • public class BulkRecipient
extends Object
    BulkRecipient.

    • Constructor Detail

      • BulkRecipient

        public BulkRecipient()

    • Method Detail

      • accessCode

        public BulkRecipient accessCode​(String accessCode)
        accessCode.
        Returns:
        BulkRecipient

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

      • getEmail

        public String getEmail()
        Specifies the recipient's email address. Maximum length: 100 characters..
        Returns:
        email

      • setEmail

        public void setEmail​(String email)
        setEmail.

      • addErrorDetailsItem

        public BulkRecipient addErrorDetailsItem​(ErrorDetails errorDetailsItem)
        addErrorDetailsItem.
        Returns:
        BulkRecipient

      • getErrorDetails

        public List<ErrorDetails> getErrorDetails()
        Array or errors..
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(List<ErrorDetails> errorDetails)
        setErrorDetails.

      • identification

        public BulkRecipient identification​(String identification)
        identification.
        Returns:
        BulkRecipient

      • getIdentification

        public String getIdentification()
        Specifies the authentication check used for the signer. If blank then no authentication check is required for the signer. Only one value can be used in this field. The acceptable values are: * KBA: Enables the normal ID check authentication set up for your account. * Phone: Enables phone authentication. * SMS: Enables SMS authentication..
        Returns:
        identification

      • setIdentification

        public void setIdentification​(String identification)
        setIdentification.

      • getName

        public String getName()
        Specifies the recipient's name. Maximum length: 50 characters..
        Returns:
        name

      • setName

        public void setName​(String name)
        setName.

      • getNote

        public String getNote()
        Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters..
        Returns:
        note

      • setNote

        public void setNote​(String note)
        setNote.

      • phoneNumber

        public BulkRecipient phoneNumber​(String phoneNumber)
        phoneNumber.
        Returns:
        BulkRecipient

      • getPhoneNumber

        public String getPhoneNumber()
        This is only used if the Identification field value is Phone or SMS. The value for this field can be a valid telephone number or, if Phone, usersupplied (SMS authentication cannot use a user supplied number). Parenthesis and dashes can be used in the telephone number. If `usersupplied` is used, the signer supplies his or her own telephone number..
        Returns:
        phoneNumber

      • setPhoneNumber

        public void setPhoneNumber​(String phoneNumber)
        setPhoneNumber.

      • addRecipientSignatureProviderInfoItem

        public BulkRecipient addRecipientSignatureProviderInfoItem​(BulkRecipientSignatureProvider recipientSignatureProviderInfoItem)
        addRecipientSignatureProviderInfoItem.
        Returns:
        BulkRecipient

      • setRecipientSignatureProviderInfo

        public void setRecipientSignatureProviderInfo​(List<BulkRecipientSignatureProvider> recipientSignatureProviderInfo)
        setRecipientSignatureProviderInfo.

      • rowNumber

        public BulkRecipient rowNumber​(String rowNumber)
        rowNumber.
        Returns:
        BulkRecipient

      • getRowNumber

        public String getRowNumber()
        .
        Returns:
        rowNumber

      • setRowNumber

        public void setRowNumber​(String rowNumber)
        setRowNumber.

      • getTabLabels

        public List<BulkRecipientTabLabel> getTabLabels()
        Specifies values used to populate recipient tabs with information. This allows each bulk recipient signer to have different values for their associated tabs. Any number of `tabLabel` columns can be added to the bulk recipient file. The information used in the bulk recipient file header must be the same as the `tabLabel` for the tab. The values entered in this column are automatically inserted into the corresponding tab for the recipient in the same row. Note that this option cannot be used for tabs that do not have data or that are automatically populated data such as Signature, Full Name, Email Address, Company, Title, and Date Signed tabs..
        Returns:
        tabLabels

      • 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