This object contains details about the envelope document. More...

Inheritance diagram for DocuSign.eSign.Model.EnvelopeDocument:

Public Member Functions
	EnvelopeDocument (List< string > AddedRecipientIds=default(List< string >), string AttachmentTabId=default(string), string AuthoritativeCopy=default(string), PropertyMetadata AuthoritativeCopyMetadata=default(PropertyMetadata), List< SignatureType > AvailableDocumentTypes=default(List< SignatureType >), string ContainsPdfFormFields=default(string), string Display=default(string), PropertyMetadata DisplayMetadata=default(PropertyMetadata), string DocGenDocumentStatus=default(string), List< DocGenSyntaxError > DocGenErrors=default(List< DocGenSyntaxError >), List< DocGenFormField > DocGenFormFields=default(List< DocGenFormField >), string DocumentBase64=default(string), List< NameValue > DocumentFields=default(List< NameValue >), string DocumentId=default(string), string DocumentIdGuid=default(string), ErrorDetails ErrorDetails=default(ErrorDetails), string IncludeInDownload=default(string), PropertyMetadata IncludeInDownloadMetadata=default(PropertyMetadata), string IsDocGenDocument=default(string), string Name=default(string), PropertyMetadata NameMetadata=default(PropertyMetadata), string Order=default(string), List< Page > Pages=default(List< Page >), string SignerMustAcknowledge=default(string), PropertyMetadata SignerMustAcknowledgeMetadata=default(PropertyMetadata), string SizeBytes=default(string), string TemplateLocked=default(string), string TemplateRequired=default(string), string Type=default(string), string Uri=default(string))
	Initializes a new instance of the EnvelopeDocument 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 (EnvelopeDocument other)
	Returns true if EnvelopeDocument instances are equal More...

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

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
List< string >	AddedRecipientIds `[get, set]`
	Gets or Sets AddedRecipientIds More...

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

string	AuthoritativeCopy `[get, set]`
	Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. More...

PropertyMetadata	AuthoritativeCopyMetadata `[get, set]`
	Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents. More...

List< SignatureType >	AvailableDocumentTypes `[get, set]`
	Gets or Sets AvailableDocumentTypes More...

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

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

PropertyMetadata	DisplayMetadata `[get, set]`
	Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents. More...

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

List< DocGenSyntaxError >	DocGenErrors `[get, set]`
	Gets or Sets DocGenErrors More...

List< DocGenFormField >	DocGenFormFields `[get, set]`
	Gets or Sets DocGenFormFields More...

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

List< NameValue >	DocumentFields `[get, set]`
	Gets or Sets DocumentFields More...

string	DocumentId `[get, set]`
	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. More...

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

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

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

PropertyMetadata	IncludeInDownloadMetadata `[get, set]`
	Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents. More...

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

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

PropertyMetadata	NameMetadata `[get, set]`
	Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents. More...

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

List< Page >	Pages `[get, set]`
	Gets or Sets Pages More...

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

PropertyMetadata	SignerMustAcknowledgeMetadata `[get, set]`
	Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents. More...

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

string	TemplateLocked `[get, set]`
	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. More...

string	TemplateRequired `[get, set]`
	When set to true, the sender may not remove the recipient. Used only when working with template recipients. More...

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

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

Detailed Description

This object contains details about the envelope document.

Constructor & Destructor Documentation

◆ EnvelopeDocument()

DocuSign.eSign.Model.EnvelopeDocument.EnvelopeDocument	(	List< string >	AddedRecipientIds = `default(List<string>)`,
		string	AttachmentTabId = `default(string)`,
		string	AuthoritativeCopy = `default(string)`,
		PropertyMetadata	AuthoritativeCopyMetadata = `default(PropertyMetadata)`,
		List< SignatureType >	AvailableDocumentTypes = `default(List<SignatureType>)`,
		string	ContainsPdfFormFields = `default(string)`,
		string	Display = `default(string)`,
		PropertyMetadata	DisplayMetadata = `default(PropertyMetadata)`,
		string	DocGenDocumentStatus = `default(string)`,
		List< DocGenSyntaxError >	DocGenErrors = `default(List<DocGenSyntaxError>)`,
		List< DocGenFormField >	DocGenFormFields = `default(List<DocGenFormField>)`,
		string	DocumentBase64 = `default(string)`,
		List< NameValue >	DocumentFields = `default(List<NameValue>)`,
		string	DocumentId = `default(string)`,
		string	DocumentIdGuid = `default(string)`,
		ErrorDetails	ErrorDetails = `default(ErrorDetails)`,
		string	IncludeInDownload = `default(string)`,
		PropertyMetadata	IncludeInDownloadMetadata = `default(PropertyMetadata)`,
		string	IsDocGenDocument = `default(string)`,
		string	Name = `default(string)`,
		PropertyMetadata	NameMetadata = `default(PropertyMetadata)`,
		string	Order = `default(string)`,
		List< Page >	Pages = `default(List<Page>)`,
		string	SignerMustAcknowledge = `default(string)`,
		PropertyMetadata	SignerMustAcknowledgeMetadata = `default(PropertyMetadata)`,
		string	SizeBytes = `default(string)`,
		string	TemplateLocked = `default(string)`,
		string	TemplateRequired = `default(string)`,
		string	Type = `default(string)`,
		string	Uri = `default(string)`
	)

inline

Initializes a new instance of the EnvelopeDocument class.

Parameters

AddedRecipientIds	AddedRecipientIds.
AttachmentTabId	AttachmentTabId.
AuthoritativeCopy	Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled..
AuthoritativeCopyMetadata	Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents..
AvailableDocumentTypes	AvailableDocumentTypes.
ContainsPdfFormFields	ContainsPdfFormFields.
Display	Display.
DisplayMetadata	Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents..
DocGenDocumentStatus	DocGenDocumentStatus.
DocGenErrors	DocGenErrors.
DocGenFormFields	DocGenFormFields.
DocumentBase64	DocumentBase64.
DocumentFields	DocumentFields.
DocumentId	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute..
DocumentIdGuid	DocumentIdGuid.
ErrorDetails	Array or errors..
IncludeInDownload	IncludeInDownload.
IncludeInDownloadMetadata	Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents..
IsDocGenDocument	IsDocGenDocument.
Name	Name.
NameMetadata	Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents..
Order	Order.
Pages	Pages.
SignerMustAcknowledge	SignerMustAcknowledge.
SignerMustAcknowledgeMetadata	Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents..
SizeBytes	SizeBytes.
TemplateLocked	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. .
TemplateRequired	When set to true, the sender may not remove the recipient. Used only when working with template recipients..
Type	Type.
Uri	Uri.

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.EnvelopeDocument.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.EnvelopeDocument.Equals ( EnvelopeDocument other )

inline

Returns true if EnvelopeDocument instances are equal

Parameters

other Instance of EnvelopeDocument to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AddedRecipientIds

List<string> DocuSign.eSign.Model.EnvelopeDocument.AddedRecipientIds

getset

Gets or Sets AddedRecipientIds

◆ AttachmentTabId

string DocuSign.eSign.Model.EnvelopeDocument.AttachmentTabId

getset

Gets or Sets AttachmentTabId

◆ AuthoritativeCopy

string DocuSign.eSign.Model.EnvelopeDocument.AuthoritativeCopy

getset

Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.

◆ AuthoritativeCopyMetadata

PropertyMetadata DocuSign.eSign.Model.EnvelopeDocument.AuthoritativeCopyMetadata

getset

Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents.

◆ AvailableDocumentTypes

List<SignatureType> DocuSign.eSign.Model.EnvelopeDocument.AvailableDocumentTypes

getset

Gets or Sets AvailableDocumentTypes

◆ ContainsPdfFormFields

string DocuSign.eSign.Model.EnvelopeDocument.ContainsPdfFormFields

getset

Gets or Sets ContainsPdfFormFields

◆ Display

string DocuSign.eSign.Model.EnvelopeDocument.Display

getset

Gets or Sets Display

◆ DisplayMetadata

PropertyMetadata DocuSign.eSign.Model.EnvelopeDocument.DisplayMetadata

getset

Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents.

◆ DocGenDocumentStatus

string DocuSign.eSign.Model.EnvelopeDocument.DocGenDocumentStatus

getset

Gets or Sets DocGenDocumentStatus

◆ DocGenErrors

List<DocGenSyntaxError> DocuSign.eSign.Model.EnvelopeDocument.DocGenErrors

getset

Gets or Sets DocGenErrors

◆ DocGenFormFields

List<DocGenFormField> DocuSign.eSign.Model.EnvelopeDocument.DocGenFormFields

getset

Gets or Sets DocGenFormFields

◆ DocumentBase64

string DocuSign.eSign.Model.EnvelopeDocument.DocumentBase64

getset

Gets or Sets DocumentBase64

◆ DocumentFields

List<NameValue> DocuSign.eSign.Model.EnvelopeDocument.DocumentFields

getset

Gets or Sets DocumentFields

◆ DocumentId

string DocuSign.eSign.Model.EnvelopeDocument.DocumentId

getset

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

◆ DocumentIdGuid

string DocuSign.eSign.Model.EnvelopeDocument.DocumentIdGuid

getset

Gets or Sets DocumentIdGuid

◆ ErrorDetails

ErrorDetails DocuSign.eSign.Model.EnvelopeDocument.ErrorDetails

getset

Array or errors.

◆ IncludeInDownload

string DocuSign.eSign.Model.EnvelopeDocument.IncludeInDownload

getset

Gets or Sets IncludeInDownload

◆ IncludeInDownloadMetadata

PropertyMetadata DocuSign.eSign.Model.EnvelopeDocument.IncludeInDownloadMetadata

getset

Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents.

◆ IsDocGenDocument

string DocuSign.eSign.Model.EnvelopeDocument.IsDocGenDocument

getset

Gets or Sets IsDocGenDocument

◆ Name

string DocuSign.eSign.Model.EnvelopeDocument.Name

getset

Gets or Sets Name

◆ NameMetadata

PropertyMetadata DocuSign.eSign.Model.EnvelopeDocument.NameMetadata

getset

Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents.

◆ Order

string DocuSign.eSign.Model.EnvelopeDocument.Order

getset

Gets or Sets Order

◆ Pages

List<Page> DocuSign.eSign.Model.EnvelopeDocument.Pages

getset

Gets or Sets Pages

◆ SignerMustAcknowledge

string DocuSign.eSign.Model.EnvelopeDocument.SignerMustAcknowledge

getset

Gets or Sets SignerMustAcknowledge

◆ SignerMustAcknowledgeMetadata

PropertyMetadata DocuSign.eSign.Model.EnvelopeDocument.SignerMustAcknowledgeMetadata

getset

Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents.

◆ SizeBytes

string DocuSign.eSign.Model.EnvelopeDocument.SizeBytes

getset

Gets or Sets SizeBytes

◆ TemplateLocked

string DocuSign.eSign.Model.EnvelopeDocument.TemplateLocked

getset

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

◆ TemplateRequired

string DocuSign.eSign.Model.EnvelopeDocument.TemplateRequired

getset

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

◆ Type

string DocuSign.eSign.Model.EnvelopeDocument.Type

getset

Gets or Sets Type

◆ Uri

string DocuSign.eSign.Model.EnvelopeDocument.Uri

getset

Gets or Sets Uri

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

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ EnvelopeDocument()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AddedRecipientIds

◆ AttachmentTabId

◆ AuthoritativeCopy

◆ AuthoritativeCopyMetadata

◆ AvailableDocumentTypes

◆ ContainsPdfFormFields

◆ Display

◆ DisplayMetadata

◆ DocGenDocumentStatus

◆ DocGenErrors

◆ DocGenFormFields

◆ DocumentBase64

◆ DocumentFields

◆ DocumentId

◆ DocumentIdGuid

◆ ErrorDetails

◆ IncludeInDownload

◆ IncludeInDownloadMetadata

◆ IsDocGenDocument

◆ Name

◆ NameMetadata

◆ Order

◆ Pages

◆ SignerMustAcknowledge

◆ SignerMustAcknowledgeMetadata

◆ SizeBytes

◆ TemplateLocked

◆ TemplateRequired

◆ Type

◆ Uri