Package com.docusign.esign.model
Class Recipients
- java.lang.Object
-
- com.docusign.esign.model.Recipients
-
public class Recipients extends Object
Specifies the envelope recipients..
-
-
Constructor Summary
Constructors Constructor Description Recipients()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Recipients
addAgentsItem(Agent agentsItem)
addAgentsItem.Recipients
addCarbonCopiesItem(CarbonCopy carbonCopiesItem)
addCarbonCopiesItem.Recipients
addCertifiedDeliveriesItem(CertifiedDelivery certifiedDeliveriesItem)
addCertifiedDeliveriesItem.Recipients
addEditorsItem(Editor editorsItem)
addEditorsItem.Recipients
addInPersonSignersItem(InPersonSigner inPersonSignersItem)
addInPersonSignersItem.Recipients
addIntermediariesItem(Intermediary intermediariesItem)
addIntermediariesItem.Recipients
addNotariesItem(NotaryRecipient notariesItem)
addNotariesItem.Recipients
addParticipantsItem(Participant participantsItem)
addParticipantsItem.Recipients
addSealsItem(SealSign sealsItem)
addSealsItem.Recipients
addSignersItem(Signer signersItem)
addSignersItem.Recipients
addWitnessesItem(Witness witnessesItem)
addWitnessesItem.Recipients
agents(List<Agent> agents)
agents.Recipients
carbonCopies(List<CarbonCopy> carbonCopies)
carbonCopies.Recipients
certifiedDeliveries(List<CertifiedDelivery> certifiedDeliveries)
certifiedDeliveries.Recipients
currentRoutingOrder(String currentRoutingOrder)
currentRoutingOrder.Recipients
editors(List<Editor> editors)
editors.boolean
equals(Object o)
Compares objects.Recipients
errorDetails(ErrorDetails errorDetails)
errorDetails.List<Agent>
getAgents()
A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document..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..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..String
getCurrentRoutingOrder()
.List<Editor>
getEditors()
A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document..ErrorDetails
getErrorDetails()
Array or errors..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.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)..List<NotaryRecipient>
getNotaries()
.List<Participant>
getParticipants()
.String
getRecipientCount()
.List<SealSign>
getSeals()
.List<Signer>
getSigners()
A complex type containing information about the Signer recipient..List<Witness>
getWitnesses()
.int
hashCode()
Returns the HashCode.Recipients
inPersonSigners(List<InPersonSigner> inPersonSigners)
inPersonSigners.Recipients
intermediaries(List<Intermediary> intermediaries)
intermediaries.Recipients
notaries(List<NotaryRecipient> notaries)
notaries.Recipients
participants(List<Participant> participants)
participants.Recipients
recipientCount(String recipientCount)
recipientCount.Recipients
seals(List<SealSign> seals)
seals.void
setAgents(List<Agent> agents)
setAgents.void
setCarbonCopies(List<CarbonCopy> carbonCopies)
setCarbonCopies.void
setCertifiedDeliveries(List<CertifiedDelivery> certifiedDeliveries)
setCertifiedDeliveries.void
setCurrentRoutingOrder(String currentRoutingOrder)
setCurrentRoutingOrder.void
setEditors(List<Editor> editors)
setEditors.void
setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.void
setInPersonSigners(List<InPersonSigner> inPersonSigners)
setInPersonSigners.void
setIntermediaries(List<Intermediary> intermediaries)
setIntermediaries.void
setNotaries(List<NotaryRecipient> notaries)
setNotaries.void
setParticipants(List<Participant> participants)
setParticipants.void
setRecipientCount(String recipientCount)
setRecipientCount.void
setSeals(List<SealSign> seals)
setSeals.void
setSigners(List<Signer> signers)
setSigners.void
setWitnesses(List<Witness> witnesses)
setWitnesses.Recipients
signers(List<Signer> signers)
signers.String
toString()
Converts the given object to string.Recipients
witnesses(List<Witness> witnesses)
witnesses.
-
-
-
Method Detail
-
agents
public Recipients agents(List<Agent> agents)
agents.- Returns:
- Recipients
-
addAgentsItem
public Recipients addAgentsItem(Agent agentsItem)
addAgentsItem.- Returns:
- Recipients
-
getAgents
public 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
-
carbonCopies
public Recipients carbonCopies(List<CarbonCopy> carbonCopies)
carbonCopies.- Returns:
- Recipients
-
addCarbonCopiesItem
public Recipients addCarbonCopiesItem(CarbonCopy carbonCopiesItem)
addCarbonCopiesItem.- Returns:
- Recipients
-
getCarbonCopies
public 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(List<CarbonCopy> carbonCopies)
setCarbonCopies.
-
certifiedDeliveries
public Recipients certifiedDeliveries(List<CertifiedDelivery> certifiedDeliveries)
certifiedDeliveries.- Returns:
- Recipients
-
addCertifiedDeliveriesItem
public Recipients addCertifiedDeliveriesItem(CertifiedDelivery certifiedDeliveriesItem)
addCertifiedDeliveriesItem.- Returns:
- Recipients
-
getCertifiedDeliveries
public 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(List<CertifiedDelivery> certifiedDeliveries)
setCertifiedDeliveries.
-
currentRoutingOrder
public Recipients currentRoutingOrder(String currentRoutingOrder)
currentRoutingOrder.- Returns:
- Recipients
-
getCurrentRoutingOrder
public String getCurrentRoutingOrder()
.- Returns:
- currentRoutingOrder
-
setCurrentRoutingOrder
public void setCurrentRoutingOrder(String currentRoutingOrder)
setCurrentRoutingOrder.
-
editors
public Recipients editors(List<Editor> editors)
editors.- Returns:
- Recipients
-
addEditorsItem
public Recipients addEditorsItem(Editor editorsItem)
addEditorsItem.- Returns:
- Recipients
-
getEditors
public List<Editor> getEditors()
A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document..- Returns:
- editors
-
errorDetails
public Recipients errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- Recipients
-
getErrorDetails
public ErrorDetails getErrorDetails()
Array or errors..- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
inPersonSigners
public Recipients inPersonSigners(List<InPersonSigner> inPersonSigners)
inPersonSigners.- Returns:
- Recipients
-
addInPersonSignersItem
public Recipients addInPersonSignersItem(InPersonSigner inPersonSignersItem)
addInPersonSignersItem.- Returns:
- Recipients
-
getInPersonSigners
public 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(List<InPersonSigner> inPersonSigners)
setInPersonSigners.
-
intermediaries
public Recipients intermediaries(List<Intermediary> intermediaries)
intermediaries.- Returns:
- Recipients
-
addIntermediariesItem
public Recipients addIntermediariesItem(Intermediary intermediariesItem)
addIntermediariesItem.- Returns:
- Recipients
-
getIntermediaries
public 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(List<Intermediary> intermediaries)
setIntermediaries.
-
notaries
public Recipients notaries(List<NotaryRecipient> notaries)
notaries.- Returns:
- Recipients
-
addNotariesItem
public Recipients addNotariesItem(NotaryRecipient notariesItem)
addNotariesItem.- Returns:
- Recipients
-
getNotaries
public List<NotaryRecipient> getNotaries()
.- Returns:
- notaries
-
setNotaries
public void setNotaries(List<NotaryRecipient> notaries)
setNotaries.
-
participants
public Recipients participants(List<Participant> participants)
participants.- Returns:
- Recipients
-
addParticipantsItem
public Recipients addParticipantsItem(Participant participantsItem)
addParticipantsItem.- Returns:
- Recipients
-
getParticipants
public List<Participant> getParticipants()
.- Returns:
- participants
-
setParticipants
public void setParticipants(List<Participant> participants)
setParticipants.
-
recipientCount
public Recipients recipientCount(String recipientCount)
recipientCount.- Returns:
- Recipients
-
getRecipientCount
public String getRecipientCount()
.- Returns:
- recipientCount
-
setRecipientCount
public void setRecipientCount(String recipientCount)
setRecipientCount.
-
seals
public Recipients seals(List<SealSign> seals)
seals.- Returns:
- Recipients
-
addSealsItem
public Recipients addSealsItem(SealSign sealsItem)
addSealsItem.- Returns:
- Recipients
-
signers
public Recipients signers(List<Signer> signers)
signers.- Returns:
- Recipients
-
addSignersItem
public Recipients addSignersItem(Signer signersItem)
addSignersItem.- Returns:
- Recipients
-
getSigners
public List<Signer> getSigners()
A complex type containing information about the Signer recipient..- Returns:
- signers
-
witnesses
public Recipients witnesses(List<Witness> witnesses)
witnesses.- Returns:
- Recipients
-
addWitnessesItem
public Recipients addWitnessesItem(Witness witnessesItem)
addWitnessesItem.- Returns:
- Recipients
-
equals
public boolean equals(Object o)
Compares objects.
-
-