java.lang.Object
- com.docusign.esign.model.TemplateRecipients

public class TemplateRecipients
extends Object

TemplateRecipients.

Constructor Summary

Constructors
Constructor Description

TemplateRecipients()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TemplateRecipients`	`addAgentsItem(Agent agentsItem)`	addAgentsItem.
`TemplateRecipients`	`addCarbonCopiesItem(CarbonCopy carbonCopiesItem)`	addCarbonCopiesItem.
`TemplateRecipients`	`addCertifiedDeliveriesItem(CertifiedDelivery certifiedDeliveriesItem)`	addCertifiedDeliveriesItem.
`TemplateRecipients`	`addEditorsItem(Editor editorsItem)`	addEditorsItem.
`TemplateRecipients`	`addInPersonSignersItem(InPersonSigner inPersonSignersItem)`	addInPersonSignersItem.
`TemplateRecipients`	`addIntermediariesItem(Intermediary intermediariesItem)`	addIntermediariesItem.
`TemplateRecipients`	`addNotariesItem(NotaryRecipient notariesItem)`	addNotariesItem.
`TemplateRecipients`	`addParticipantsItem(Participant participantsItem)`	addParticipantsItem.
`TemplateRecipients`	`addSealsItem(SealSign sealsItem)`	addSealsItem.
`TemplateRecipients`	`addSignersItem(Signer signersItem)`	addSignersItem.
`TemplateRecipients`	`addWitnessesItem(Witness witnessesItem)`	addWitnessesItem.
`TemplateRecipients`	`agents(List<Agent> agents)`	agents.
`TemplateRecipients`	`carbonCopies(List<CarbonCopy> carbonCopies)`	carbonCopies.
`TemplateRecipients`	`certifiedDeliveries(List<CertifiedDelivery> certifiedDeliveries)`	certifiedDeliveries.
`TemplateRecipients`	`currentRoutingOrder(String currentRoutingOrder)`	currentRoutingOrder.
`TemplateRecipients`	`editors(List<Editor> editors)`	editors.
`boolean`	`equals(Object o)`	Compares objects.
`TemplateRecipients`	`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()`	.
`ErrorDetails`	`getErrorDetails()`	This object describes errors that occur.
`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()`	The list of recipient event statuses that will trigger Connect to send updates to the url.
`List<SealSign>`	`getSeals()`	.
`List<Signer>`	`getSigners()`	A complex type containing information about the Signer recipient..
`List<Witness>`	`getWitnesses()`	.
`int`	`hashCode()`	Returns the HashCode.
`TemplateRecipients`	`inPersonSigners(List<InPersonSigner> inPersonSigners)`	inPersonSigners.
`TemplateRecipients`	`intermediaries(List<Intermediary> intermediaries)`	intermediaries.
`TemplateRecipients`	`notaries(List<NotaryRecipient> notaries)`	notaries.
`TemplateRecipients`	`participants(List<Participant> participants)`	participants.
`TemplateRecipients`	`recipientCount(String recipientCount)`	recipientCount.
`TemplateRecipients`	`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.
`TemplateRecipients`	`signers(List<Signer> signers)`	signers.
`String`	`toString()`	Converts the given object to string.
`TemplateRecipients`	`witnesses(List<Witness> witnesses)`	witnesses.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TemplateRecipients
```
public TemplateRecipients()
```
- Method Detail
  - agents
```
public TemplateRecipients agents(List<Agent> agents)
```
    agents.
    
    Returns:
    
    TemplateRecipients
  - addAgentsItem
```
public TemplateRecipients addAgentsItem(Agent agentsItem)
```
    addAgentsItem.
    
    Returns:
    
    TemplateRecipients
  - 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
  - setAgents
```
public void setAgents(List<Agent> agents)
```
    setAgents.
  - carbonCopies
```
public TemplateRecipients carbonCopies(List<CarbonCopy> carbonCopies)
```
    carbonCopies.
    
    Returns:
    
    TemplateRecipients
  - addCarbonCopiesItem
```
public TemplateRecipients addCarbonCopiesItem(CarbonCopy carbonCopiesItem)
```
    addCarbonCopiesItem.
    
    Returns:
    
    TemplateRecipients
  - 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 TemplateRecipients certifiedDeliveries(List<CertifiedDelivery> certifiedDeliveries)
```
    certifiedDeliveries.
    
    Returns:
    
    TemplateRecipients
  - addCertifiedDeliveriesItem
```
public TemplateRecipients addCertifiedDeliveriesItem(CertifiedDelivery certifiedDeliveriesItem)
```
    addCertifiedDeliveriesItem.
    
    Returns:
    
    TemplateRecipients
  - 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 TemplateRecipients currentRoutingOrder(String currentRoutingOrder)
```
    currentRoutingOrder.
    
    Returns:
    
    TemplateRecipients
  - getCurrentRoutingOrder
```
public String getCurrentRoutingOrder()
```
    .
    
    Returns:
    
    currentRoutingOrder
  - setCurrentRoutingOrder
```
public void setCurrentRoutingOrder(String currentRoutingOrder)
```
    setCurrentRoutingOrder.
  - editors
```
public TemplateRecipients editors(List<Editor> editors)
```
    editors.
    
    Returns:
    
    TemplateRecipients
  - addEditorsItem
```
public TemplateRecipients addEditorsItem(Editor editorsItem)
```
    addEditorsItem.
    
    Returns:
    
    TemplateRecipients
  - getEditors
```
public List<Editor> getEditors()
```
    .
    
    Returns:
    
    editors
  - setEditors
```
public void setEditors(List<Editor> editors)
```
    setEditors.
  - errorDetails
```
public TemplateRecipients errorDetails(ErrorDetails errorDetails)
```
    errorDetails.
    
    Returns:
    
    TemplateRecipients
  - getErrorDetails
```
public ErrorDetails getErrorDetails()
```
    This object describes errors that occur. It is only valid for responses and ignored in requests..
    
    Returns:
    
    errorDetails
  - setErrorDetails
```
public void setErrorDetails(ErrorDetails errorDetails)
```
    setErrorDetails.
  - inPersonSigners
```
public TemplateRecipients inPersonSigners(List<InPersonSigner> inPersonSigners)
```
    inPersonSigners.
    
    Returns:
    
    TemplateRecipients
  - addInPersonSignersItem
```
public TemplateRecipients addInPersonSignersItem(InPersonSigner inPersonSignersItem)
```
    addInPersonSignersItem.
    
    Returns:
    
    TemplateRecipients
  - 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 TemplateRecipients intermediaries(List<Intermediary> intermediaries)
```
    intermediaries.
    
    Returns:
    
    TemplateRecipients
  - addIntermediariesItem
```
public TemplateRecipients addIntermediariesItem(Intermediary intermediariesItem)
```
    addIntermediariesItem.
    
    Returns:
    
    TemplateRecipients
  - 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 TemplateRecipients notaries(List<NotaryRecipient> notaries)
```
    notaries.
    
    Returns:
    
    TemplateRecipients
  - addNotariesItem
```
public TemplateRecipients addNotariesItem(NotaryRecipient notariesItem)
```
    addNotariesItem.
    
    Returns:
    
    TemplateRecipients
  - getNotaries
```
public List<NotaryRecipient> getNotaries()
```
    .
    
    Returns:
    
    notaries
  - setNotaries
```
public void setNotaries(List<NotaryRecipient> notaries)
```
    setNotaries.
  - participants
```
public TemplateRecipients participants(List<Participant> participants)
```
    participants.
    
    Returns:
    
    TemplateRecipients
  - addParticipantsItem
```
public TemplateRecipients addParticipantsItem(Participant participantsItem)
```
    addParticipantsItem.
    
    Returns:
    
    TemplateRecipients
  - getParticipants
```
public List<Participant> getParticipants()
```
    .
    
    Returns:
    
    participants
  - setParticipants
```
public void setParticipants(List<Participant> participants)
```
    setParticipants.
  - recipientCount
```
public TemplateRecipients recipientCount(String recipientCount)
```
    recipientCount.
    
    Returns:
    
    TemplateRecipients
  - getRecipientCount
```
public 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(String recipientCount)
```
    setRecipientCount.
  - seals
```
public TemplateRecipients seals(List<SealSign> seals)
```
    seals.
    
    Returns:
    
    TemplateRecipients
  - addSealsItem
```
public TemplateRecipients addSealsItem(SealSign sealsItem)
```
    addSealsItem.
    
    Returns:
    
    TemplateRecipients
  - getSeals
```
public List<SealSign> getSeals()
```
    .
    
    Returns:
    
    seals
  - setSeals
```
public void setSeals(List<SealSign> seals)
```
    setSeals.
  - signers
```
public TemplateRecipients signers(List<Signer> signers)
```
    signers.
    
    Returns:
    
    TemplateRecipients
  - addSignersItem
```
public TemplateRecipients addSignersItem(Signer signersItem)
```
    addSignersItem.
    
    Returns:
    
    TemplateRecipients
  - getSigners
```
public List<Signer> getSigners()
```
    A complex type containing information about the Signer recipient..
    
    Returns:
    
    signers
  - setSigners
```
public void setSigners(List<Signer> signers)
```
    setSigners.
  - witnesses
```
public TemplateRecipients witnesses(List<Witness> witnesses)
```
    witnesses.
    
    Returns:
    
    TemplateRecipients
  - addWitnessesItem
```
public TemplateRecipients addWitnessesItem(Witness witnessesItem)
```
    addWitnessesItem.
    
    Returns:
    
    TemplateRecipients
  - getWitnesses
```
public List<Witness> getWitnesses()
```
    .
    
    Returns:
    
    witnesses
  - setWitnesses
```
public void setWitnesses(List<Witness> witnesses)
```
    setWitnesses.
  - 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

Class TemplateRecipients

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TemplateRecipients

Method Detail

agents

addAgentsItem

getAgents

setAgents

carbonCopies

addCarbonCopiesItem

getCarbonCopies

setCarbonCopies

certifiedDeliveries

addCertifiedDeliveriesItem

getCertifiedDeliveries

setCertifiedDeliveries

currentRoutingOrder

getCurrentRoutingOrder

setCurrentRoutingOrder

editors

addEditorsItem

getEditors

setEditors

errorDetails

getErrorDetails

setErrorDetails

inPersonSigners

addInPersonSignersItem

getInPersonSigners

setInPersonSigners

intermediaries

addIntermediariesItem

getIntermediaries

setIntermediaries

notaries

addNotariesItem

getNotaries

setNotaries

participants

addParticipantsItem

getParticipants

setParticipants

recipientCount

getRecipientCount

setRecipientCount

seals

addSealsItem

getSeals

setSeals

signers

addSignersItem

getSigners

setSigners

witnesses

addWitnessesItem

getWitnesses

setWitnesses

equals

hashCode

toString