Class TemplateRecipients


  • public class TemplateRecipients
    extends java.lang.Object
    TemplateRecipients.
    • Constructor Detail

      • TemplateRecipients

        public TemplateRecipients()
    • Method Detail

      • addAgentsItem

        public TemplateRecipients addAgentsItem​(Agent agentsItem)
        addAgentsItem.
        Returns:
        TemplateRecipients
      • getAgents

        public java.util.List<Agent> getAgents()
        A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document..
        Returns:
        agents
      • setAgents

        public void setAgents​(java.util.List<Agent> agents)
        setAgents.
      • carbonCopies

        public TemplateRecipients carbonCopies​(java.util.List<CarbonCopy> carbonCopies)
        carbonCopies.
        Returns:
        TemplateRecipients
      • addCarbonCopiesItem

        public TemplateRecipients addCarbonCopiesItem​(CarbonCopy carbonCopiesItem)
        addCarbonCopiesItem.
        Returns:
        TemplateRecipients
      • getCarbonCopies

        public java.util.List<CarbonCopy> getCarbonCopies()
        A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it..
        Returns:
        carbonCopies
      • setCarbonCopies

        public void setCarbonCopies​(java.util.List<CarbonCopy> carbonCopies)
        setCarbonCopies.
      • certifiedDeliveries

        public TemplateRecipients certifiedDeliveries​(java.util.List<CertifiedDelivery> certifiedDeliveries)
        certifiedDeliveries.
        Returns:
        TemplateRecipients
      • addCertifiedDeliveriesItem

        public TemplateRecipients addCertifiedDeliveriesItem​(CertifiedDelivery certifiedDeliveriesItem)
        addCertifiedDeliveriesItem.
        Returns:
        TemplateRecipients
      • getCertifiedDeliveries

        public java.util.List<CertifiedDelivery> getCertifiedDeliveries()
        A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents..
        Returns:
        certifiedDeliveries
      • setCertifiedDeliveries

        public void setCertifiedDeliveries​(java.util.List<CertifiedDelivery> certifiedDeliveries)
        setCertifiedDeliveries.
      • currentRoutingOrder

        public TemplateRecipients currentRoutingOrder​(java.lang.String currentRoutingOrder)
        currentRoutingOrder.
        Returns:
        TemplateRecipients
      • getCurrentRoutingOrder

        public java.lang.String getCurrentRoutingOrder()
        .
        Returns:
        currentRoutingOrder
      • setCurrentRoutingOrder

        public void setCurrentRoutingOrder​(java.lang.String currentRoutingOrder)
        setCurrentRoutingOrder.
      • addEditorsItem

        public TemplateRecipients addEditorsItem​(Editor editorsItem)
        addEditorsItem.
        Returns:
        TemplateRecipients
      • getEditors

        public java.util.List<Editor> getEditors()
        .
        Returns:
        editors
      • setEditors

        public void setEditors​(java.util.List<Editor> editors)
        setEditors.
      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Get errorDetails.
        Returns:
        errorDetails
      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.
      • addInPersonSignersItem

        public TemplateRecipients addInPersonSignersItem​(InPersonSigner inPersonSignersItem)
        addInPersonSignersItem.
        Returns:
        TemplateRecipients
      • getInPersonSigners

        public java.util.List<InPersonSigner> getInPersonSigners()
        Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected..
        Returns:
        inPersonSigners
      • setInPersonSigners

        public void setInPersonSigners​(java.util.List<InPersonSigner> inPersonSigners)
        setInPersonSigners.
      • intermediaries

        public TemplateRecipients intermediaries​(java.util.List<Intermediary> intermediaries)
        intermediaries.
        Returns:
        TemplateRecipients
      • addIntermediariesItem

        public TemplateRecipients addIntermediariesItem​(Intermediary intermediariesItem)
        addIntermediariesItem.
        Returns:
        TemplateRecipients
      • getIntermediaries

        public java.util.List<Intermediary> getIntermediaries()
        Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added)..
        Returns:
        intermediaries
      • setIntermediaries

        public void setIntermediaries​(java.util.List<Intermediary> intermediaries)
        setIntermediaries.
      • getNotaries

        public java.util.List<NotaryRecipient> getNotaries()
        .
        Returns:
        notaries
      • setNotaries

        public void setNotaries​(java.util.List<NotaryRecipient> notaries)
        setNotaries.
      • recipientCount

        public TemplateRecipients recipientCount​(java.lang.String recipientCount)
        recipientCount.
        Returns:
        TemplateRecipients
      • getRecipientCount

        public java.lang.String getRecipientCount()
        The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. * includeDocuments - When set to **true**, the envelope time zone information is included in the message..
        Returns:
        recipientCount
      • setRecipientCount

        public void setRecipientCount​(java.lang.String recipientCount)
        setRecipientCount.
      • getSeals

        public java.util.List<SealSign> getSeals()
        .
        Returns:
        seals
      • setSeals

        public void setSeals​(java.util.List<SealSign> seals)
        setSeals.
      • addSignersItem

        public TemplateRecipients addSignersItem​(Signer signersItem)
        addSignersItem.
        Returns:
        TemplateRecipients
      • getSigners

        public java.util.List<Signer> getSigners()
        A complex type containing information about the Signer recipient..
        Returns:
        signers
      • setSigners

        public void setSigners​(java.util.List<Signer> signers)
        setSigners.
      • witnesses

        public TemplateRecipients witnesses​(java.util.List<Witness> witnesses)
        witnesses.
        Returns:
        TemplateRecipients
      • addWitnessesItem

        public TemplateRecipients addWitnessesItem​(Witness witnessesItem)
        addWitnessesItem.
        Returns:
        TemplateRecipients
      • getWitnesses

        public java.util.List<Witness> getWitnesses()
        .
        Returns:
        witnesses
      • setWitnesses

        public void setWitnesses​(java.util.List<Witness> witnesses)
        setWitnesses.
      • 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