Package com.docusign.esign.model

Class BulkSendingCopyRecipient

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

    • Constructor Detail

      • BulkSendingCopyRecipient

        public BulkSendingCopyRecipient()

    • Method Detail

      • accessCode

        public BulkSendingCopyRecipient accessCode​(java.lang.String accessCode)
        accessCode.
        Returns:
        BulkSendingCopyRecipient

      • getAccessCode

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

      • clientUserId

        public BulkSendingCopyRecipient clientUserId​(java.lang.String clientUserId)
        clientUserId.
        Returns:
        BulkSendingCopyRecipient

      • getClientUserId

        public java.lang.String getClientUserId()
        Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. .
        Returns:
        clientUserId

      • setClientUserId

        public void setClientUserId​(java.lang.String clientUserId)
        setClientUserId.

      • customFields

        public BulkSendingCopyRecipient customFields​(java.util.List<java.lang.String> customFields)
        customFields.
        Returns:
        BulkSendingCopyRecipient

      • addCustomFieldsItem

        public BulkSendingCopyRecipient addCustomFieldsItem​(java.lang.String customFieldsItem)
        addCustomFieldsItem.
        Returns:
        BulkSendingCopyRecipient

      • getCustomFields

        public java.util.List<java.lang.String> getCustomFields()
        An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters..
        Returns:
        customFields

      • setCustomFields

        public void setCustomFields​(java.util.List<java.lang.String> customFields)
        setCustomFields.

      • deliveryMethod

        public BulkSendingCopyRecipient deliveryMethod​(java.lang.String deliveryMethod)
        deliveryMethod.
        Returns:
        BulkSendingCopyRecipient

      • getDeliveryMethod

        public java.lang.String getDeliveryMethod()
        Reserved: For DocuSign use only..
        Returns:
        deliveryMethod

      • setDeliveryMethod

        public void setDeliveryMethod​(java.lang.String deliveryMethod)
        setDeliveryMethod.

      • getEmail

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

      • setEmail

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

      • getEmailNotification

        public RecipientEmailNotification getEmailNotification()
        Get emailNotification.
        Returns:
        emailNotification

      • embeddedRecipientStartURL

        public BulkSendingCopyRecipient embeddedRecipientStartURL​(java.lang.String embeddedRecipientStartURL)
        embeddedRecipientStartURL.
        Returns:
        BulkSendingCopyRecipient

      • getEmbeddedRecipientStartURL

        public java.lang.String getEmbeddedRecipientStartURL()
        Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` .
        Returns:
        embeddedRecipientStartURL

      • setEmbeddedRecipientStartURL

        public void setEmbeddedRecipientStartURL​(java.lang.String embeddedRecipientStartURL)
        setEmbeddedRecipientStartURL.

      • faxNumber

        public BulkSendingCopyRecipient faxNumber​(java.lang.String faxNumber)
        faxNumber.
        Returns:
        BulkSendingCopyRecipient

      • getFaxNumber

        public java.lang.String getFaxNumber()
        Reserved:.
        Returns:
        faxNumber

      • setFaxNumber

        public void setFaxNumber​(java.lang.String faxNumber)
        setFaxNumber.

      • hostEmail

        public BulkSendingCopyRecipient hostEmail​(java.lang.String hostEmail)
        hostEmail.
        Returns:
        BulkSendingCopyRecipient

      • getHostEmail

        public java.lang.String getHostEmail()
        .
        Returns:
        hostEmail

      • setHostEmail

        public void setHostEmail​(java.lang.String hostEmail)
        setHostEmail.

      • hostName

        public BulkSendingCopyRecipient hostName​(java.lang.String hostName)
        hostName.
        Returns:
        BulkSendingCopyRecipient

      • getHostName

        public java.lang.String getHostName()
        .
        Returns:
        hostName

      • setHostName

        public void setHostName​(java.lang.String hostName)
        setHostName.

      • idCheckConfigurationName

        public BulkSendingCopyRecipient idCheckConfigurationName​(java.lang.String idCheckConfigurationName)
        idCheckConfigurationName.
        Returns:
        BulkSendingCopyRecipient

      • getIdCheckConfigurationName

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

      • getIdCheckInformationInput

        public IdCheckInformationInput getIdCheckInformationInput()
        Get idCheckInformationInput.
        Returns:
        idCheckInformationInput

      • setIdCheckInformationInput

        public void setIdCheckInformationInput​(IdCheckInformationInput idCheckInformationInput)
        setIdCheckInformationInput.

      • identificationMethod

        public BulkSendingCopyRecipient identificationMethod​(java.lang.String identificationMethod)
        identificationMethod.
        Returns:
        BulkSendingCopyRecipient

      • getIdentificationMethod

        public java.lang.String getIdentificationMethod()
        .
        Returns:
        identificationMethod

      • setIdentificationMethod

        public void setIdentificationMethod​(java.lang.String identificationMethod)
        setIdentificationMethod.

      • getName

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

      • setName

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

      • getNote

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

      • getPhoneAuthentication

        public RecipientPhoneAuthentication getPhoneAuthentication()
        Get phoneAuthentication.
        Returns:
        phoneAuthentication

      • recipientId

        public BulkSendingCopyRecipient recipientId​(java.lang.String recipientId)
        recipientId.
        Returns:
        BulkSendingCopyRecipient

      • getRecipientId

        public java.lang.String getRecipientId()
        Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document..
        Returns:
        recipientId

      • setRecipientId

        public void setRecipientId​(java.lang.String recipientId)
        setRecipientId.

      • getRecipientSignatureProviders

        public java.util.List<RecipientSignatureProvider> getRecipientSignatureProviders()
        .
        Returns:
        recipientSignatureProviders

      • setRecipientSignatureProviders

        public void setRecipientSignatureProviders​(java.util.List<RecipientSignatureProvider> recipientSignatureProviders)
        setRecipientSignatureProviders.

      • roleName

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

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

      • signerName

        public BulkSendingCopyRecipient signerName​(java.lang.String signerName)
        signerName.
        Returns:
        BulkSendingCopyRecipient

      • getSignerName

        public java.lang.String getSignerName()
        .
        Returns:
        signerName

      • setSignerName

        public void setSignerName​(java.lang.String signerName)
        setSignerName.

      • signingGroupId

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

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

      • getSmsAuthentication

        public RecipientSMSAuthentication getSmsAuthentication()
        Get smsAuthentication.
        Returns:
        smsAuthentication

      • getSocialAuthentications

        public java.util.List<SocialAuthentication> getSocialAuthentications()
        Lists the social ID type that can be used for recipient authentication..
        Returns:
        socialAuthentications

      • setSocialAuthentications

        public void setSocialAuthentications​(java.util.List<SocialAuthentication> socialAuthentications)
        setSocialAuthentications.

      • 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