Inheritance diagram for DocuSign.eSign.Model.Envelope:

Public Member Functions
	Envelope (string AccessControlListBase64=default(string), string AllowComments=default(string), string AllowMarkup=default(string), string AllowReassign=default(string), string AllowViewHistory=default(string), string AnySigner=default(string), string Asynchronous=default(string), string AttachmentsUri=default(string), string AuthoritativeCopy=default(string), string AuthoritativeCopyDefault=default(string), string AutoNavigation=default(string), string BrandId=default(string), string BrandLock=default(string), string BurnDefaultTabData=default(string), string CertificateUri=default(string), string CompletedDateTime=default(string), string CopyRecipientData=default(string), string CreatedDateTime=default(string), CustomFields CustomFields=default(CustomFields), string CustomFieldsUri=default(string), string DeclinedDateTime=default(string), string DeletedDateTime=default(string), string DeliveredDateTime=default(string), string DisableResponsiveDocument=default(string), string DocumentBase64=default(string), string DocumentsCombinedUri=default(string), string DocumentsUri=default(string), string EmailBlurb=default(string), EmailSettings EmailSettings=default(EmailSettings), string EmailSubject=default(string), string EnableWetSign=default(string), string EnforceSignerVisibility=default(string), List< Attachment > EnvelopeAttachments=default(List< Attachment >), EnvelopeCustomMetadata EnvelopeCustomMetadata=default(EnvelopeCustomMetadata), List< EnvelopeDocument > EnvelopeDocuments=default(List< EnvelopeDocument >), string EnvelopeId=default(string), string EnvelopeIdStamping=default(string), string EnvelopeLocation=default(string), EnvelopeMetadata EnvelopeMetadata=default(EnvelopeMetadata), string EnvelopeUri=default(string), string ExpireAfter=default(string), string ExpireDateTime=default(string), string ExpireEnabled=default(string), string ExternalEnvelopeId=default(string), List< Folder > Folders=default(List< Folder >), string HasComments=default(string), string HasFormDataChanged=default(string), string HasWavFile=default(string), string Holder=default(string), string InitialSentDateTime=default(string), string Is21CFRPart11=default(string), string IsDynamicEnvelope=default(string), string IsSignatureProviderEnvelope=default(string), string LastModifiedDateTime=default(string), string Location=default(string), LockInformation LockInformation=default(LockInformation), string MessageLock=default(string), Notification Notification=default(Notification), string NotificationUri=default(string), PowerForm PowerForm=default(PowerForm), string PurgeCompletedDate=default(string), string PurgeRequestDate=default(string), string PurgeState=default(string), Recipients Recipients=default(Recipients), string RecipientsLock=default(string), string RecipientsUri=default(string), UserInfo Sender=default(UserInfo), string SentDateTime=default(string), string SignerCanSignOnMobile=default(string), string SigningLocation=default(string), string Status=default(string), string StatusChangedDateTime=default(string), string StatusDateTime=default(string), string TemplatesUri=default(string), string TransactionId=default(string), string UseDisclosure=default(string), string USigState=default(string), string VoidedDateTime=default(string), string VoidedReason=default(string), Workflow Workflow=default(Workflow))
	Initializes a new instance of the Envelope 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 (Envelope other)
	Returns true if Envelope instances are equal More...

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

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

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

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

string	AllowMarkup `[get, set]`
	When set to true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this More...

string	AllowReassign `[get, set]`
	When set to true, the recipient can redirect an envelope to a more appropriate recipient. More...

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

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

string	Asynchronous `[get, set]`
	When set to true, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. More...

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

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

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

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

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

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

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

string	CertificateUri `[get, set]`
	Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. More...

string	CompletedDateTime `[get, set]`
	Specifies the date and time this item was completed. More...

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

string	CreatedDateTime `[get, set]`
	Indicates the date and time the item was created. More...

CustomFields	CustomFields `[get, set]`
	An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. More...

string	CustomFieldsUri `[get, set]`
	Contains a URI for an endpoint that you can use to retrieve the custom fields. More...

string	DeclinedDateTime `[get, set]`
	The date and time the recipient declined the document. More...

string	DeletedDateTime `[get, set]`
	Specifies the data and time the item was deleted. More...

string	DeliveredDateTime `[get, set]`
	Reserved: For DocuSign use only. More...

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

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

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

string	DocumentsUri `[get, set]`
	Contains a URI for an endpoint that you can use to retrieve the documents. More...

string	EmailBlurb `[get, set]`
	This is the same as the email body. If specified it is included in email body for all envelope recipients. More...

EmailSettings	EmailSettings `[get, set]`
	A complex type that contains email settings. More...

string	EmailSubject `[get, set]`
	Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. More...

string	EnableWetSign `[get, set]`
	When set to true, the signer is allowed to print the document and sign it on paper. More...

string	EnforceSignerVisibility `[get, set]`
	When set to true, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. Your account must have Document Visibility enabled to use this. More...

List< Attachment >	EnvelopeAttachments `[get, set]`
	Gets or Sets EnvelopeAttachments More...

EnvelopeCustomMetadata	EnvelopeCustomMetadata `[get, set]`
	Gets or Sets EnvelopeCustomMetadata More...

List< EnvelopeDocument >	EnvelopeDocuments `[get, set]`
	Gets or Sets EnvelopeDocuments More...

string	EnvelopeId `[get, set]`
	The envelope ID of the envelope status that failed to post. More...

string	EnvelopeIdStamping `[get, set]`
	When set to true, Envelope ID Stamping is enabled. More...

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

EnvelopeMetadata	EnvelopeMetadata `[get, set]`
	Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service. More...

string	EnvelopeUri `[get, set]`
	Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. More...

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

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

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

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

List< Folder >	Folders `[get, set]`
	Gets or Sets Folders More...

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

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

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

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

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

string	Is21CFRPart11 `[get, set]`
	When set to true, indicates that this module is enabled on the account. More...

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

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

string	LastModifiedDateTime `[get, set]`
	The date and time the item was last modified. More...

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

LockInformation	LockInformation `[get, set]`
	Provides lock information about an envelope that a user has locked. More...

string	MessageLock `[get, set]`
	When set to true, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. More...

Notification	Notification `[get, set]`
	Gets or Sets Notification More...

string	NotificationUri `[get, set]`
	Contains a URI for an endpoint that you can use to retrieve the notifications. More...

PowerForm	PowerForm `[get, set]`
	Information about any PowerForms that are included in the envelope. More...

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

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

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

Recipients	Recipients `[get, set]`
	An array of powerform recipients. More...

string	RecipientsLock `[get, set]`
	When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope. More...

string	RecipientsUri `[get, set]`
	Contains a URI for an endpoint that you can use to retrieve the recipients. More...

UserInfo	Sender `[get, set]`
	Information about the sender of the envelope. More...

string	SentDateTime `[get, set]`
	The date and time the envelope was sent. More...

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

string	SigningLocation `[get, set]`
	Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. More...

string	Status `[get, set]`
	Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. *created - The envelope is saved as a draft and can be modified and sent later. More...

string	StatusChangedDateTime `[get, set]`
	The data and time the status changed. More...

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

string	TemplatesUri `[get, set]`
	Contains a URI for an endpoint which you can use to retrieve the templates. More...

string	TransactionId `[get, set]`
	Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. More...

string	UseDisclosure `[get, set]`
	When set to true, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to false, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. More...

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

string	VoidedDateTime `[get, set]`
	The date and time the envelope or template was voided. More...

string	VoidedReason `[get, set]`
	The reason the envelope or template was voided. More...

Workflow	Workflow `[get, set]`
	Gets or Sets Workflow More...

Detailed Description

Envelope

Constructor & Destructor Documentation

◆ Envelope()

DocuSign.eSign.Model.Envelope.Envelope	(	string	AccessControlListBase64 = `default(string)`,
		string	AllowComments = `default(string)`,
		string	AllowMarkup = `default(string)`,
		string	AllowReassign = `default(string)`,
		string	AllowViewHistory = `default(string)`,
		string	AnySigner = `default(string)`,
		string	Asynchronous = `default(string)`,
		string	AttachmentsUri = `default(string)`,
		string	AuthoritativeCopy = `default(string)`,
		string	AuthoritativeCopyDefault = `default(string)`,
		string	AutoNavigation = `default(string)`,
		string	BrandId = `default(string)`,
		string	BrandLock = `default(string)`,
		string	BurnDefaultTabData = `default(string)`,
		string	CertificateUri = `default(string)`,
		string	CompletedDateTime = `default(string)`,
		string	CopyRecipientData = `default(string)`,
		string	CreatedDateTime = `default(string)`,
		CustomFields	CustomFields = `default(CustomFields)`,
		string	CustomFieldsUri = `default(string)`,
		string	DeclinedDateTime = `default(string)`,
		string	DeletedDateTime = `default(string)`,
		string	DeliveredDateTime = `default(string)`,
		string	DisableResponsiveDocument = `default(string)`,
		string	DocumentBase64 = `default(string)`,
		string	DocumentsCombinedUri = `default(string)`,
		string	DocumentsUri = `default(string)`,
		string	EmailBlurb = `default(string)`,
		EmailSettings	EmailSettings = `default(EmailSettings)`,
		string	EmailSubject = `default(string)`,
		string	EnableWetSign = `default(string)`,
		string	EnforceSignerVisibility = `default(string)`,
		List< Attachment >	EnvelopeAttachments = `default(List<Attachment>)`,
		EnvelopeCustomMetadata	EnvelopeCustomMetadata = `default(EnvelopeCustomMetadata)`,
		List< EnvelopeDocument >	EnvelopeDocuments = `default(List<EnvelopeDocument>)`,
		string	EnvelopeId = `default(string)`,
		string	EnvelopeIdStamping = `default(string)`,
		string	EnvelopeLocation = `default(string)`,
		EnvelopeMetadata	EnvelopeMetadata = `default(EnvelopeMetadata)`,
		string	EnvelopeUri = `default(string)`,
		string	ExpireAfter = `default(string)`,
		string	ExpireDateTime = `default(string)`,
		string	ExpireEnabled = `default(string)`,
		string	ExternalEnvelopeId = `default(string)`,
		List< Folder >	Folders = `default(List<Folder>)`,
		string	HasComments = `default(string)`,
		string	HasFormDataChanged = `default(string)`,
		string	HasWavFile = `default(string)`,
		string	Holder = `default(string)`,
		string	InitialSentDateTime = `default(string)`,
		string	Is21CFRPart11 = `default(string)`,
		string	IsDynamicEnvelope = `default(string)`,
		string	IsSignatureProviderEnvelope = `default(string)`,
		string	LastModifiedDateTime = `default(string)`,
		string	Location = `default(string)`,
		LockInformation	LockInformation = `default(LockInformation)`,
		string	MessageLock = `default(string)`,
		Notification	Notification = `default(Notification)`,
		string	NotificationUri = `default(string)`,
		PowerForm	PowerForm = `default(PowerForm)`,
		string	PurgeCompletedDate = `default(string)`,
		string	PurgeRequestDate = `default(string)`,
		string	PurgeState = `default(string)`,
		Recipients	Recipients = `default(Recipients)`,
		string	RecipientsLock = `default(string)`,
		string	RecipientsUri = `default(string)`,
		UserInfo	Sender = `default(UserInfo)`,
		string	SentDateTime = `default(string)`,
		string	SignerCanSignOnMobile = `default(string)`,
		string	SigningLocation = `default(string)`,
		string	Status = `default(string)`,
		string	StatusChangedDateTime = `default(string)`,
		string	StatusDateTime = `default(string)`,
		string	TemplatesUri = `default(string)`,
		string	TransactionId = `default(string)`,
		string	UseDisclosure = `default(string)`,
		string	USigState = `default(string)`,
		string	VoidedDateTime = `default(string)`,
		string	VoidedReason = `default(string)`,
		Workflow	Workflow = `default(Workflow)`
	)

inline

Initializes a new instance of the Envelope class.

Parameters

AccessControlListBase64	AccessControlListBase64.
AllowComments	AllowComments.
AllowMarkup	When set to true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this.
AllowReassign	When set to true, the recipient can redirect an envelope to a more appropriate recipient..
AllowViewHistory	AllowViewHistory.
AnySigner	AnySigner.
Asynchronous	When set to true, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed..
AttachmentsUri	AttachmentsUri.
AuthoritativeCopy	Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled..
AuthoritativeCopyDefault	AuthoritativeCopyDefault.
AutoNavigation	AutoNavigation.
BrandId	BrandId.
BrandLock	BrandLock.
BurnDefaultTabData	BurnDefaultTabData.
CertificateUri	Retrieves a URI for an endpoint that allows you to easily retrieve certificate information..
CompletedDateTime	Specifies the date and time this item was completed..
CopyRecipientData	CopyRecipientData.
CreatedDateTime	Indicates the date and time the item was created..
CustomFields	An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters..
CustomFieldsUri	Contains a URI for an endpoint that you can use to retrieve the custom fields..
DeclinedDateTime	The date and time the recipient declined the document..
DeletedDateTime	Specifies the data and time the item was deleted..
DeliveredDateTime	Reserved: For DocuSign use only..
DisableResponsiveDocument	DisableResponsiveDocument.
DocumentBase64	DocumentBase64.
DocumentsCombinedUri	DocumentsCombinedUri.
DocumentsUri	Contains a URI for an endpoint that you can use to retrieve the documents..
EmailBlurb	This is the same as the email body. If specified it is included in email body for all envelope recipients..
EmailSettings	A complex type that contains email settings..
EmailSubject	Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject..
EnableWetSign	When set to true, the signer is allowed to print the document and sign it on paper..
EnforceSignerVisibility	When set to true, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. Your account must have Document Visibility enabled to use this..
EnvelopeAttachments	EnvelopeAttachments.
EnvelopeCustomMetadata	EnvelopeCustomMetadata.
EnvelopeDocuments	EnvelopeDocuments.
EnvelopeId	The envelope ID of the envelope status that failed to post..
EnvelopeIdStamping	When set to true, Envelope ID Stamping is enabled..
EnvelopeLocation	EnvelopeLocation.
EnvelopeMetadata	Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service..
EnvelopeUri	Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes..
ExpireAfter	ExpireAfter.
ExpireDateTime	ExpireDateTime.
ExpireEnabled	ExpireEnabled.
ExternalEnvelopeId	ExternalEnvelopeId.
Folders	Folders.
HasComments	HasComments.
HasFormDataChanged	HasFormDataChanged.
HasWavFile	HasWavFile.
Holder	Holder.
InitialSentDateTime	InitialSentDateTime.
Is21CFRPart11	When set to true, indicates that this module is enabled on the account..
IsDynamicEnvelope	IsDynamicEnvelope.
IsSignatureProviderEnvelope	IsSignatureProviderEnvelope.
LastModifiedDateTime	The date and time the item was last modified..
Location	Location.
LockInformation	Provides lock information about an envelope that a user has locked..
MessageLock	When set to true, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope..
Notification	Notification.
NotificationUri	Contains a URI for an endpoint that you can use to retrieve the notifications..
PowerForm	Information about any PowerForms that are included in the envelope..
PurgeCompletedDate	PurgeCompletedDate.
PurgeRequestDate	PurgeRequestDate.
PurgeState	PurgeState.
Recipients	An array of powerform recipients..
RecipientsLock	When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope..
RecipientsUri	Contains a URI for an endpoint that you can use to retrieve the recipients..
Sender	Information about the sender of the envelope..
SentDateTime	The date and time the envelope was sent..
SignerCanSignOnMobile	SignerCanSignOnMobile.
SigningLocation	Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online..
Status	Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. *created - The envelope is saved as a draft and can be modified and sent later..
StatusChangedDateTime	The data and time the status changed..
StatusDateTime	StatusDateTime.
TemplatesUri	Contains a URI for an endpoint which you can use to retrieve the templates..
TransactionId	Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned..
UseDisclosure	When set to true, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to false, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information..
USigState	USigState.
VoidedDateTime	The date and time the envelope or template was voided..
VoidedReason	The reason the envelope or template was voided..
Workflow	Workflow.

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if Envelope instances are equal

Parameters

other Instance of Envelope to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AccessControlListBase64

string DocuSign.eSign.Model.Envelope.AccessControlListBase64

getset

Gets or Sets AccessControlListBase64

◆ AllowComments

string DocuSign.eSign.Model.Envelope.AllowComments

getset

Gets or Sets AllowComments

◆ AllowMarkup

string DocuSign.eSign.Model.Envelope.AllowMarkup

getset

When set to true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this

◆ AllowReassign

string DocuSign.eSign.Model.Envelope.AllowReassign

getset

When set to true, the recipient can redirect an envelope to a more appropriate recipient.

◆ AllowViewHistory

string DocuSign.eSign.Model.Envelope.AllowViewHistory

getset

Gets or Sets AllowViewHistory

◆ AnySigner

string DocuSign.eSign.Model.Envelope.AnySigner

getset

Gets or Sets AnySigner

◆ Asynchronous

string DocuSign.eSign.Model.Envelope.Asynchronous

getset

When set to true, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed.

◆ AttachmentsUri

string DocuSign.eSign.Model.Envelope.AttachmentsUri

getset

Gets or Sets AttachmentsUri

◆ AuthoritativeCopy

string DocuSign.eSign.Model.Envelope.AuthoritativeCopy

getset

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

◆ AuthoritativeCopyDefault

string DocuSign.eSign.Model.Envelope.AuthoritativeCopyDefault

getset

Gets or Sets AuthoritativeCopyDefault

◆ AutoNavigation

string DocuSign.eSign.Model.Envelope.AutoNavigation

getset

Gets or Sets AutoNavigation

◆ BrandId

string DocuSign.eSign.Model.Envelope.BrandId

getset

Gets or Sets BrandId

◆ BrandLock

string DocuSign.eSign.Model.Envelope.BrandLock

getset

Gets or Sets BrandLock

◆ BurnDefaultTabData

string DocuSign.eSign.Model.Envelope.BurnDefaultTabData

getset

Gets or Sets BurnDefaultTabData

◆ CertificateUri

string DocuSign.eSign.Model.Envelope.CertificateUri

getset

Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.

◆ CompletedDateTime

string DocuSign.eSign.Model.Envelope.CompletedDateTime

getset

Specifies the date and time this item was completed.

◆ CopyRecipientData

string DocuSign.eSign.Model.Envelope.CopyRecipientData

getset

Gets or Sets CopyRecipientData

◆ CreatedDateTime

string DocuSign.eSign.Model.Envelope.CreatedDateTime

getset

Indicates the date and time the item was created.

◆ CustomFields

CustomFields DocuSign.eSign.Model.Envelope.CustomFields

getset

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

◆ CustomFieldsUri

string DocuSign.eSign.Model.Envelope.CustomFieldsUri

getset

Contains a URI for an endpoint that you can use to retrieve the custom fields.

◆ DeclinedDateTime

string DocuSign.eSign.Model.Envelope.DeclinedDateTime

getset

The date and time the recipient declined the document.

◆ DeletedDateTime

string DocuSign.eSign.Model.Envelope.DeletedDateTime

getset

Specifies the data and time the item was deleted.

◆ DeliveredDateTime

string DocuSign.eSign.Model.Envelope.DeliveredDateTime

getset

Reserved: For DocuSign use only.

◆ DisableResponsiveDocument

string DocuSign.eSign.Model.Envelope.DisableResponsiveDocument

getset

Gets or Sets DisableResponsiveDocument

◆ DocumentBase64

string DocuSign.eSign.Model.Envelope.DocumentBase64

getset

Gets or Sets DocumentBase64

◆ DocumentsCombinedUri

string DocuSign.eSign.Model.Envelope.DocumentsCombinedUri

getset

Gets or Sets DocumentsCombinedUri

◆ DocumentsUri

string DocuSign.eSign.Model.Envelope.DocumentsUri

getset

Contains a URI for an endpoint that you can use to retrieve the documents.

◆ EmailBlurb

string DocuSign.eSign.Model.Envelope.EmailBlurb

getset

This is the same as the email body. If specified it is included in email body for all envelope recipients.

◆ EmailSettings

EmailSettings DocuSign.eSign.Model.Envelope.EmailSettings

getset

A complex type that contains email settings.

◆ EmailSubject

string DocuSign.eSign.Model.Envelope.EmailSubject

getset

Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.

◆ EnableWetSign

string DocuSign.eSign.Model.Envelope.EnableWetSign

getset

When set to true, the signer is allowed to print the document and sign it on paper.

◆ EnforceSignerVisibility

string DocuSign.eSign.Model.Envelope.EnforceSignerVisibility

getset

When set to true, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. Your account must have Document Visibility enabled to use this.

◆ EnvelopeAttachments

List<Attachment> DocuSign.eSign.Model.Envelope.EnvelopeAttachments

getset

Gets or Sets EnvelopeAttachments

◆ EnvelopeCustomMetadata

EnvelopeCustomMetadata DocuSign.eSign.Model.Envelope.EnvelopeCustomMetadata

getset

Gets or Sets EnvelopeCustomMetadata

◆ EnvelopeDocuments

List<EnvelopeDocument> DocuSign.eSign.Model.Envelope.EnvelopeDocuments

getset

Gets or Sets EnvelopeDocuments

◆ EnvelopeId

string DocuSign.eSign.Model.Envelope.EnvelopeId

getset

The envelope ID of the envelope status that failed to post.

◆ EnvelopeIdStamping

string DocuSign.eSign.Model.Envelope.EnvelopeIdStamping

getset

When set to true, Envelope ID Stamping is enabled.

◆ EnvelopeLocation

string DocuSign.eSign.Model.Envelope.EnvelopeLocation

getset

Gets or Sets EnvelopeLocation

◆ EnvelopeMetadata

EnvelopeMetadata DocuSign.eSign.Model.Envelope.EnvelopeMetadata

getset

Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service.

◆ EnvelopeUri

string DocuSign.eSign.Model.Envelope.EnvelopeUri

getset

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

◆ ExpireAfter

string DocuSign.eSign.Model.Envelope.ExpireAfter

getset

Gets or Sets ExpireAfter

◆ ExpireDateTime

string DocuSign.eSign.Model.Envelope.ExpireDateTime

getset

Gets or Sets ExpireDateTime

◆ ExpireEnabled

string DocuSign.eSign.Model.Envelope.ExpireEnabled

getset

Gets or Sets ExpireEnabled

◆ ExternalEnvelopeId

string DocuSign.eSign.Model.Envelope.ExternalEnvelopeId

getset

Gets or Sets ExternalEnvelopeId

◆ Folders

List<Folder> DocuSign.eSign.Model.Envelope.Folders

getset

Gets or Sets Folders

◆ HasComments

string DocuSign.eSign.Model.Envelope.HasComments

getset

Gets or Sets HasComments

◆ HasFormDataChanged

string DocuSign.eSign.Model.Envelope.HasFormDataChanged

getset

Gets or Sets HasFormDataChanged

◆ HasWavFile

string DocuSign.eSign.Model.Envelope.HasWavFile

getset

Gets or Sets HasWavFile

◆ Holder

string DocuSign.eSign.Model.Envelope.Holder

getset

Gets or Sets Holder

◆ InitialSentDateTime

string DocuSign.eSign.Model.Envelope.InitialSentDateTime

getset

Gets or Sets InitialSentDateTime

◆ Is21CFRPart11

string DocuSign.eSign.Model.Envelope.Is21CFRPart11

getset

When set to true, indicates that this module is enabled on the account.

◆ IsDynamicEnvelope

string DocuSign.eSign.Model.Envelope.IsDynamicEnvelope

getset

Gets or Sets IsDynamicEnvelope

◆ IsSignatureProviderEnvelope

string DocuSign.eSign.Model.Envelope.IsSignatureProviderEnvelope

getset

Gets or Sets IsSignatureProviderEnvelope

◆ LastModifiedDateTime

string DocuSign.eSign.Model.Envelope.LastModifiedDateTime

getset

The date and time the item was last modified.

◆ Location

string DocuSign.eSign.Model.Envelope.Location

getset

Gets or Sets Location

◆ LockInformation

LockInformation DocuSign.eSign.Model.Envelope.LockInformation

getset

Provides lock information about an envelope that a user has locked.

◆ MessageLock

string DocuSign.eSign.Model.Envelope.MessageLock

getset

When set to true, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.

◆ Notification

Notification DocuSign.eSign.Model.Envelope.Notification

getset

Gets or Sets Notification

◆ NotificationUri

string DocuSign.eSign.Model.Envelope.NotificationUri

getset

Contains a URI for an endpoint that you can use to retrieve the notifications.

◆ PowerForm

PowerForm DocuSign.eSign.Model.Envelope.PowerForm

getset

Information about any PowerForms that are included in the envelope.

◆ PurgeCompletedDate

string DocuSign.eSign.Model.Envelope.PurgeCompletedDate

getset

Gets or Sets PurgeCompletedDate

◆ PurgeRequestDate

string DocuSign.eSign.Model.Envelope.PurgeRequestDate

getset

Gets or Sets PurgeRequestDate

◆ PurgeState

string DocuSign.eSign.Model.Envelope.PurgeState

getset

Gets or Sets PurgeState

◆ Recipients

Recipients DocuSign.eSign.Model.Envelope.Recipients

getset

An array of powerform recipients.

◆ RecipientsLock

string DocuSign.eSign.Model.Envelope.RecipientsLock

getset

When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.

◆ RecipientsUri

string DocuSign.eSign.Model.Envelope.RecipientsUri

getset

Contains a URI for an endpoint that you can use to retrieve the recipients.

◆ Sender

UserInfo DocuSign.eSign.Model.Envelope.Sender

getset

Information about the sender of the envelope.

◆ SentDateTime

string DocuSign.eSign.Model.Envelope.SentDateTime

getset

The date and time the envelope was sent.

◆ SignerCanSignOnMobile

string DocuSign.eSign.Model.Envelope.SignerCanSignOnMobile

getset

Gets or Sets SignerCanSignOnMobile

◆ SigningLocation

string DocuSign.eSign.Model.Envelope.SigningLocation

getset

Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.

◆ Status

string DocuSign.eSign.Model.Envelope.Status

getset

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. *created - The envelope is saved as a draft and can be modified and sent later.

◆ StatusChangedDateTime

string DocuSign.eSign.Model.Envelope.StatusChangedDateTime

getset

The data and time the status changed.

◆ StatusDateTime

string DocuSign.eSign.Model.Envelope.StatusDateTime

getset

Gets or Sets StatusDateTime

◆ TemplatesUri

string DocuSign.eSign.Model.Envelope.TemplatesUri

getset

Contains a URI for an endpoint which you can use to retrieve the templates.

◆ TransactionId

string DocuSign.eSign.Model.Envelope.TransactionId

getset

Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.

◆ UseDisclosure

string DocuSign.eSign.Model.Envelope.UseDisclosure

getset

When set to true, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to false, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.

◆ USigState

string DocuSign.eSign.Model.Envelope.USigState

getset

Gets or Sets USigState

◆ VoidedDateTime

string DocuSign.eSign.Model.Envelope.VoidedDateTime

getset

The date and time the envelope or template was voided.

◆ VoidedReason

string DocuSign.eSign.Model.Envelope.VoidedReason

getset

The reason the envelope or template was voided.

◆ Workflow

Workflow DocuSign.eSign.Model.Envelope.Workflow

getset

Gets or Sets Workflow

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

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Envelope()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AccessControlListBase64

◆ AllowComments

◆ AllowMarkup

◆ AllowReassign

◆ AllowViewHistory

◆ AnySigner

◆ Asynchronous

◆ AttachmentsUri

◆ AuthoritativeCopy

◆ AuthoritativeCopyDefault

◆ AutoNavigation

◆ BrandId

◆ BrandLock

◆ BurnDefaultTabData

◆ CertificateUri

◆ CompletedDateTime

◆ CopyRecipientData

◆ CreatedDateTime

◆ CustomFields

◆ CustomFieldsUri

◆ DeclinedDateTime

◆ DeletedDateTime

◆ DeliveredDateTime

◆ DisableResponsiveDocument

◆ DocumentBase64

◆ DocumentsCombinedUri

◆ DocumentsUri

◆ EmailBlurb

◆ EmailSettings

◆ EmailSubject

◆ EnableWetSign

◆ EnforceSignerVisibility

◆ EnvelopeAttachments

◆ EnvelopeCustomMetadata

◆ EnvelopeDocuments

◆ EnvelopeId

◆ EnvelopeIdStamping

◆ EnvelopeLocation

◆ EnvelopeMetadata

◆ EnvelopeUri

◆ ExpireAfter

◆ ExpireDateTime

◆ ExpireEnabled

◆ ExternalEnvelopeId

◆ Folders

◆ HasComments

◆ HasFormDataChanged

◆ HasWavFile

◆ Holder

◆ InitialSentDateTime

◆ Is21CFRPart11

◆ IsDynamicEnvelope

◆ IsSignatureProviderEnvelope

◆ LastModifiedDateTime

◆ Location

◆ LockInformation

◆ MessageLock

◆ Notification

◆ NotificationUri

◆ PowerForm

◆ PurgeCompletedDate

◆ PurgeRequestDate

◆ PurgeState

◆ Recipients

◆ RecipientsLock

◆ RecipientsUri

◆ Sender

◆ SentDateTime