Specifies the envelope recipients. More...

Inheritance diagram for DocuSign.eSign.Model.Recipients:

Public Member Functions
	Recipients (List< Agent > Agents=default(List< Agent >), List< CarbonCopy > CarbonCopies=default(List< CarbonCopy >), List< CertifiedDelivery > CertifiedDeliveries=default(List< CertifiedDelivery >), string CurrentRoutingOrder=default(string), List< Editor > Editors=default(List< Editor >), ErrorDetails ErrorDetails=default(ErrorDetails), List< InPersonSigner > InPersonSigners=default(List< InPersonSigner >), List< Intermediary > Intermediaries=default(List< Intermediary >), List< NotaryRecipient > Notaries=default(List< NotaryRecipient >), List< Participant > Participants=default(List< Participant >), string RecipientCount=default(string), List< SealSign > Seals=default(List< SealSign >), List< Signer > Signers=default(List< Signer >), List< Witness > Witnesses=default(List< Witness >))
	Initializes a new instance of the Recipients class. More...

override string	ToString ()
	Returns the string presentation of the object More...

string	ToJson ()
	Returns the JSON string presentation of the object More...

override bool	Equals (object obj)
	Returns true if objects are equal More...

bool	Equals (Recipients other)
	Returns true if Recipients instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
List< Agent >	Agents `[get, set]`
	A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document. More...

List< CarbonCopy >	CarbonCopies `[get, set]`
	A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it. More...

List< CertifiedDelivery >	CertifiedDeliveries `[get, set]`
	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. More...

string	CurrentRoutingOrder `[get, set]`
	Gets or Sets CurrentRoutingOrder More...

List< Editor >	Editors `[get, set]`
	A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document. More...

ErrorDetails	ErrorDetails `[get, set]`
	Array or errors. More...

List< InPersonSigner >	InPersonSigners `[get, set]`
	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. More...

List< Intermediary >	Intermediaries `[get, set]`
	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). More...

List< NotaryRecipient >	Notaries `[get, set]`
	Gets or Sets Notaries More...

List< Participant >	Participants `[get, set]`
	Gets or Sets Participants More...

string	RecipientCount `[get, set]`
	Gets or Sets RecipientCount More...

List< SealSign >	Seals `[get, set]`
	Gets or Sets Seals More...

List< Signer >	Signers `[get, set]`
	A complex type containing information about the Signer recipient. More...

List< Witness >	Witnesses `[get, set]`
	Gets or Sets Witnesses More...

Detailed Description

Specifies the envelope recipients.

Constructor & Destructor Documentation

◆ Recipients()

DocuSign.eSign.Model.Recipients.Recipients	(	List< Agent >	Agents = `default(List<Agent>)`,
		List< CarbonCopy >	CarbonCopies = `default(List<CarbonCopy>)`,
		List< CertifiedDelivery >	CertifiedDeliveries = `default(List<CertifiedDelivery>)`,
		string	CurrentRoutingOrder = `default(string)`,
		List< Editor >	Editors = `default(List<Editor>)`,
		ErrorDetails	ErrorDetails = `default(ErrorDetails)`,
		List< InPersonSigner >	InPersonSigners = `default(List<InPersonSigner>)`,
		List< Intermediary >	Intermediaries = `default(List<Intermediary>)`,
		List< NotaryRecipient >	Notaries = `default(List<NotaryRecipient>)`,
		List< Participant >	Participants = `default(List<Participant>)`,
		string	RecipientCount = `default(string)`,
		List< SealSign >	Seals = `default(List<SealSign>)`,
		List< Signer >	Signers = `default(List<Signer>)`,
		List< Witness >	Witnesses = `default(List<Witness>)`
	)

inline

Initializes a new instance of the Recipients class.

Parameters

Agents	A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document..
CarbonCopies	A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it..
CertifiedDeliveries	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..
CurrentRoutingOrder	CurrentRoutingOrder.
Editors	A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document..
ErrorDetails	Array or errors..
InPersonSigners	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..
Intermediaries	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)..
Notaries	Notaries.
Participants	Participants.
RecipientCount	RecipientCount.
Seals	Seals.
Signers	A complex type containing information about the Signer recipient..
Witnesses	Witnesses.

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.Recipients.Equals ( object obj )

inline

Returns true if objects are equal

Parameters

obj	Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.Recipients.Equals ( Recipients other )

inline

Returns true if Recipients instances are equal

Parameters

other Instance of Recipients to be compared

Returns: Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.Recipients.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

string DocuSign.eSign.Model.Recipients.ToJson ( )

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.Recipients.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ Agents

List<Agent> DocuSign.eSign.Model.Recipients.Agents

getset

A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document.

◆ CarbonCopies

List<CarbonCopy> DocuSign.eSign.Model.Recipients.CarbonCopies

getset

A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it.

◆ CertifiedDeliveries

List<CertifiedDelivery> DocuSign.eSign.Model.Recipients.CertifiedDeliveries

getset

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.

◆ CurrentRoutingOrder

string DocuSign.eSign.Model.Recipients.CurrentRoutingOrder

getset

Gets or Sets CurrentRoutingOrder

◆ Editors

List<Editor> DocuSign.eSign.Model.Recipients.Editors

getset

A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document.

◆ ErrorDetails

ErrorDetails DocuSign.eSign.Model.Recipients.ErrorDetails

getset

Array or errors.

◆ InPersonSigners

List<InPersonSigner> DocuSign.eSign.Model.Recipients.InPersonSigners

getset

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.

◆ Intermediaries

List<Intermediary> DocuSign.eSign.Model.Recipients.Intermediaries

getset

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

◆ Notaries

List<NotaryRecipient> DocuSign.eSign.Model.Recipients.Notaries

getset

Gets or Sets Notaries

◆ Participants

List<Participant> DocuSign.eSign.Model.Recipients.Participants

getset

Gets or Sets Participants

◆ RecipientCount

string DocuSign.eSign.Model.Recipients.RecipientCount

getset

Gets or Sets RecipientCount

◆ Seals

List<SealSign> DocuSign.eSign.Model.Recipients.Seals

getset

Gets or Sets Seals

◆ Signers

List<Signer> DocuSign.eSign.Model.Recipients.Signers

getset

A complex type containing information about the Signer recipient.

◆ Witnesses

List<Witness> DocuSign.eSign.Model.Recipients.Witnesses

getset

Gets or Sets Witnesses

The documentation for this class was generated from the following file:

sdk/src/DocuSign.eSign/Model/Recipients.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Recipients()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ Agents

◆ CarbonCopies

◆ CertifiedDeliveries

◆ CurrentRoutingOrder

◆ Editors

◆ ErrorDetails

◆ InPersonSigners

◆ Intermediaries

◆ Notaries

◆ Participants

◆ RecipientCount

◆ Seals

◆ Signers

◆ Witnesses