DocuSign CSharp Docs
Public Member Functions | Properties | List of all members
DocuSign.eSign.Model.EnvelopeTemplateResult Class Reference

EnvelopeTemplateResult More...

Inheritance diagram for DocuSign.eSign.Model.EnvelopeTemplateResult:

Public Member Functions

 EnvelopeTemplateResult (string AllowMarkup=default(string), string AllowReassign=default(string), string AllowViewHistory=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 CertificateUri=default(string), string CompletedDateTime=default(string), string Created=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 Description=default(string), List< Document > Documents=default(List< Document >), 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), string EnvelopeId=default(string), string EnvelopeIdStamping=default(string), string EnvelopeUri=default(string), string FolderId=default(string), string FolderName=default(string), string FolderUri=default(string), string InitialSentDateTime=default(string), string Is21CFRPart11=default(string), string IsSignatureProviderEnvelope=default(string), string LastModified=default(string), string LastModifiedDateTime=default(string), LockInformation LockInformation=default(LockInformation), string MessageLock=default(string), string Name=default(string), Notification Notification=default(Notification), string NotificationUri=default(string), UserInfo Owner=default(UserInfo), int? PageCount=default(int?), string ParentFolderUri=default(string), string Password=default(string), string PurgeState=default(string), Recipients Recipients=default(Recipients), string RecipientsLock=default(string), string RecipientsUri=default(string), string SentDateTime=default(string), string Shared=default(string), string SignerCanSignOnMobile=default(string), string SigningLocation=default(string), string Status=default(string), string StatusChangedDateTime=default(string), string TemplateId=default(string), string TemplatesUri=default(string), string TransactionId=default(string), string Uri=default(string), string UseDisclosure=default(string), string VoidedDateTime=default(string), string VoidedReason=default(string))
 Initializes a new instance of the EnvelopeTemplateResult 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 (EnvelopeTemplateResult other)
 Returns true if EnvelopeTemplateResult instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

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]
 
string Asynchronous [get, set]
 When set to true, the envelope is queued for processing and the value of the &#x60;status&#x60; property is set to &#39;Processing&#39;. Additionally, get status calls return &#39;Processing&#39; until completed. More...
 
string AttachmentsUri [get, set]
 
string AuthoritativeCopy [get, set]
 Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. More...
 
string AuthoritativeCopyDefault [get, set]
 
string AutoNavigation [get, set]
 
string BrandId [get, set]
 
string BrandLock [get, set]
 
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 Created [get, set]
 
string CreatedDateTime [get, set]
 Indicates the date and time the item was created. More...
 
CustomFields CustomFields [get, set]
 Gets or Sets CustomFields 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 Description [get, set]
 
List< DocumentDocuments [get, set]
 Complex element contains the details on the documents in the envelope. More...
 
string DocumentsCombinedUri [get, set]
 
string DocumentsUri [get, set]
 Contains a URI for an endpoint that you can use to retrieve the documents. More...
 
string EmailBlurb [get, set]
 
EmailSettings EmailSettings [get, set]
 Gets or Sets EmailSettings 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...
 
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 EnvelopeUri [get, set]
 Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. More...
 
string FolderId [get, set]
 
string FolderName [get, set]
 
string FolderUri [get, set]
 
string InitialSentDateTime [get, set]
 
string Is21CFRPart11 [get, set]
 When set to true, indicates that this module is enabled on the account. More...
 
string IsSignatureProviderEnvelope [get, set]
 
string LastModified [get, set]
 
string LastModifiedDateTime [get, set]
 The date and time the item was last modified. More...
 
LockInformation LockInformation [get, set]
 Gets or Sets LockInformation More...
 
string MessageLock [get, set]
 When set to true, prevents senders from changing the contents of &#x60;emailBlurb&#x60; and &#x60;emailSubject&#x60; properties for the envelope. Additionally, this prevents users from making changes to the contents of &#x60;emailBlurb&#x60; and &#x60;emailSubject&#x60; properties when correcting envelopes. However, if the &#x60;messageLock&#x60; node is set to true**** and the &#x60;emailSubject&#x60; property is empty, senders and correctors are able to add a subject to the envelope. More...
 
string Name [get, set]
 
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...
 
UserInfo Owner [get, set]
 Gets or Sets Owner More...
 
int PageCount [get, set]
 
string ParentFolderUri [get, set]
 
string Password [get, set]
 
string PurgeState [get, set]
 
Recipients Recipients [get, set]
 Gets or Sets 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...
 
string SentDateTime [get, set]
 The date and time the envelope was sent. More...
 
string Shared [get, set]
 When set to true, this custom tab is shared. More...
 
string SignerCanSignOnMobile [get, set]
 
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 TemplateId [get, set]
 The unique identifier of the template. If this is not provided, DocuSign will generate a value. 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 &#x60;transactionId&#x60; property can be used determine an envelope&#39;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 Uri [get, set]
 
string UseDisclosure [get, set]
 When set to true, the disclosure is shown to recipients in accordance with the account&#39;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 &#x60;useDisclosure&#x60; property is not set, then the account&#39;s normal disclosure setting is used and the value of the &#x60;useDisclosure&#x60; property is not returned in responses when getting envelope information. 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...
 

Detailed Description

EnvelopeTemplateResult

Constructor & Destructor Documentation

◆ EnvelopeTemplateResult()

DocuSign.eSign.Model.EnvelopeTemplateResult.EnvelopeTemplateResult ( string  AllowMarkup = default(string),
string  AllowReassign = default(string),
string  AllowViewHistory = 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  CertificateUri = default(string),
string  CompletedDateTime = default(string),
string  Created = 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  Description = default(string),
List< Document Documents = default(List<Document>),
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),
string  EnvelopeId = default(string),
string  EnvelopeIdStamping = default(string),
string  EnvelopeUri = default(string),
string  FolderId = default(string),
string  FolderName = default(string),
string  FolderUri = default(string),
string  InitialSentDateTime = default(string),
string  Is21CFRPart11 = default(string),
string  IsSignatureProviderEnvelope = default(string),
string  LastModified = default(string),
string  LastModifiedDateTime = default(string),
LockInformation  LockInformation = default(LockInformation),
string  MessageLock = default(string),
string  Name = default(string),
Notification  Notification = default(Notification),
string  NotificationUri = default(string),
UserInfo  Owner = default(UserInfo),
int?  PageCount = default(int?),
string  ParentFolderUri = default(string),
string  Password = default(string),
string  PurgeState = default(string),
Recipients  Recipients = default(Recipients),
string  RecipientsLock = default(string),
string  RecipientsUri = default(string),
string  SentDateTime = default(string),
string  Shared = default(string),
string  SignerCanSignOnMobile = default(string),
string  SigningLocation = default(string),
string  Status = default(string),
string  StatusChangedDateTime = default(string),
string  TemplateId = default(string),
string  TemplatesUri = default(string),
string  TransactionId = default(string),
string  Uri = default(string),
string  UseDisclosure = default(string),
string  VoidedDateTime = default(string),
string  VoidedReason = default(string) 
)
inline

Initializes a new instance of the EnvelopeTemplateResult class.

Parameters
AllowMarkupWhen set to true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this.
AllowReassignWhen set to true, the recipient can redirect an envelope to a more appropriate recipient..
AllowViewHistory.
AsynchronousWhen set to true, the envelope is queued for processing and the value of the &#x60;status&#x60; property is set to &#39;Processing&#39;. Additionally, get status calls return &#39;Processing&#39; until completed..
AttachmentsUri.
AuthoritativeCopySpecifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled..
AuthoritativeCopyDefault.
AutoNavigation.
BrandId.
BrandLock.
CertificateUriRetrieves a URI for an endpoint that allows you to easily retrieve certificate information..
CompletedDateTimeSpecifies the date and time this item was completed..
Created.
CreatedDateTimeIndicates the date and time the item was created..
CustomFieldsCustomFields.
CustomFieldsUriContains a URI for an endpoint that you can use to retrieve the custom fields..
DeclinedDateTimeThe date and time the recipient declined the document..
DeletedDateTimeSpecifies the data and time the item was deleted..
DeliveredDateTimeReserved: For DocuSign use only..
Description.
DocumentsComplex element contains the details on the documents in the envelope..
DocumentsCombinedUri.
DocumentsUriContains a URI for an endpoint that you can use to retrieve the documents..
EmailBlurb.
EmailSettingsEmailSettings.
EmailSubjectSpecifies 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..
EnableWetSignWhen set to true, the signer is allowed to print the document and sign it on paper..
EnforceSignerVisibilityWhen 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..
EnvelopeIdThe envelope ID of the envelope status that failed to post..
EnvelopeIdStampingWhen set to true, Envelope ID Stamping is enabled..
EnvelopeUriContains a URI for an endpoint that you can use to retrieve the envelope or envelopes..
FolderId.
FolderName.
FolderUri.
InitialSentDateTime.
Is21CFRPart11When set to true, indicates that this module is enabled on the account..
IsSignatureProviderEnvelope.
LastModified.
LastModifiedDateTimeThe date and time the item was last modified..
LockInformationLockInformation.
MessageLockWhen set to true, prevents senders from changing the contents of &#x60;emailBlurb&#x60; and &#x60;emailSubject&#x60; properties for the envelope. Additionally, this prevents users from making changes to the contents of &#x60;emailBlurb&#x60; and &#x60;emailSubject&#x60; properties when correcting envelopes. However, if the &#x60;messageLock&#x60; node is set to true**** and the &#x60;emailSubject&#x60; property is empty, senders and correctors are able to add a subject to the envelope..
Name.
NotificationNotification.
NotificationUriContains a URI for an endpoint that you can use to retrieve the notifications..
OwnerOwner.
PageCount.
ParentFolderUri.
Password.
PurgeState.
RecipientsRecipients.
RecipientsLockWhen set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope..
RecipientsUriContains a URI for an endpoint that you can use to retrieve the recipients..
SentDateTimeThe date and time the envelope was sent..
SharedWhen set to true, this custom tab is shared..
SignerCanSignOnMobile.
SigningLocationSpecifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online..
StatusIndicates 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..
StatusChangedDateTimeThe data and time the status changed..
TemplateIdThe unique identifier of the template. If this is not provided, DocuSign will generate a value. .
TemplatesUriContains a URI for an endpoint which you can use to retrieve the templates..
TransactionIdUsed 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 &#x60;transactionId&#x60; property can be used determine an envelope&#39;s status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned..
Uri.
UseDisclosureWhen set to true, the disclosure is shown to recipients in accordance with the account&#39;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 &#x60;useDisclosure&#x60; property is not set, then the account&#39;s normal disclosure setting is used and the value of the &#x60;useDisclosure&#x60; property is not returned in responses when getting envelope information..
VoidedDateTimeThe date and time the envelope or template was voided..
VoidedReasonThe reason the envelope or template was voided..

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.EnvelopeTemplateResult.Equals ( object  obj)
inline

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.EnvelopeTemplateResult.Equals ( EnvelopeTemplateResult  other)
inline

Returns true if EnvelopeTemplateResult instances are equal

Parameters
otherInstance of EnvelopeTemplateResult to be compared
Returns
Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.EnvelopeTemplateResult.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

string DocuSign.eSign.Model.EnvelopeTemplateResult.ToJson ( )
inline

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.EnvelopeTemplateResult.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AllowMarkup

string DocuSign.eSign.Model.EnvelopeTemplateResult.AllowMarkup
getset

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

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

◆ AllowReassign

string DocuSign.eSign.Model.EnvelopeTemplateResult.AllowReassign
getset

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

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

◆ AllowViewHistory

string DocuSign.eSign.Model.EnvelopeTemplateResult.AllowViewHistory
getset

◆ Asynchronous

string DocuSign.eSign.Model.EnvelopeTemplateResult.Asynchronous
getset

When set to true, the envelope is queued for processing and the value of the &#x60;status&#x60; property is set to &#39;Processing&#39;. Additionally, get status calls return &#39;Processing&#39; until completed.

When set to true, the envelope is queued for processing and the value of the &#x60;status&#x60; property is set to &#39;Processing&#39;. Additionally, get status calls return &#39;Processing&#39; until completed.

◆ AttachmentsUri

string DocuSign.eSign.Model.EnvelopeTemplateResult.AttachmentsUri
getset

◆ AuthoritativeCopy

string DocuSign.eSign.Model.EnvelopeTemplateResult.AuthoritativeCopy
getset

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

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

◆ AuthoritativeCopyDefault

string DocuSign.eSign.Model.EnvelopeTemplateResult.AuthoritativeCopyDefault
getset

◆ AutoNavigation

string DocuSign.eSign.Model.EnvelopeTemplateResult.AutoNavigation
getset

◆ BrandId

string DocuSign.eSign.Model.EnvelopeTemplateResult.BrandId
getset

◆ BrandLock

string DocuSign.eSign.Model.EnvelopeTemplateResult.BrandLock
getset

◆ CertificateUri

string DocuSign.eSign.Model.EnvelopeTemplateResult.CertificateUri
getset

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

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

◆ CompletedDateTime

string DocuSign.eSign.Model.EnvelopeTemplateResult.CompletedDateTime
getset

Specifies the date and time this item was completed.

Specifies the date and time this item was completed.

◆ Created

string DocuSign.eSign.Model.EnvelopeTemplateResult.Created
getset

◆ CreatedDateTime

string DocuSign.eSign.Model.EnvelopeTemplateResult.CreatedDateTime
getset

Indicates the date and time the item was created.

Indicates the date and time the item was created.

◆ CustomFields

CustomFields DocuSign.eSign.Model.EnvelopeTemplateResult.CustomFields
getset

Gets or Sets CustomFields

◆ CustomFieldsUri

string DocuSign.eSign.Model.EnvelopeTemplateResult.CustomFieldsUri
getset

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

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

◆ DeclinedDateTime

string DocuSign.eSign.Model.EnvelopeTemplateResult.DeclinedDateTime
getset

The date and time the recipient declined the document.

The date and time the recipient declined the document.

◆ DeletedDateTime

string DocuSign.eSign.Model.EnvelopeTemplateResult.DeletedDateTime
getset

Specifies the data and time the item was deleted.

Specifies the data and time the item was deleted.

◆ DeliveredDateTime

string DocuSign.eSign.Model.EnvelopeTemplateResult.DeliveredDateTime
getset

Reserved: For DocuSign use only.

Reserved: For DocuSign use only.

◆ Description

string DocuSign.eSign.Model.EnvelopeTemplateResult.Description
getset

◆ Documents

List<Document> DocuSign.eSign.Model.EnvelopeTemplateResult.Documents
getset

Complex element contains the details on the documents in the envelope.

Complex element contains the details on the documents in the envelope.

◆ DocumentsCombinedUri

string DocuSign.eSign.Model.EnvelopeTemplateResult.DocumentsCombinedUri
getset

◆ DocumentsUri

string DocuSign.eSign.Model.EnvelopeTemplateResult.DocumentsUri
getset

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

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

◆ EmailBlurb

string DocuSign.eSign.Model.EnvelopeTemplateResult.EmailBlurb
getset

◆ EmailSettings

EmailSettings DocuSign.eSign.Model.EnvelopeTemplateResult.EmailSettings
getset

Gets or Sets EmailSettings

◆ EmailSubject

string DocuSign.eSign.Model.EnvelopeTemplateResult.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.

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.EnvelopeTemplateResult.EnableWetSign
getset

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

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

◆ EnforceSignerVisibility

string DocuSign.eSign.Model.EnvelopeTemplateResult.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.

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.

◆ EnvelopeId

string DocuSign.eSign.Model.EnvelopeTemplateResult.EnvelopeId
getset

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

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

◆ EnvelopeIdStamping

string DocuSign.eSign.Model.EnvelopeTemplateResult.EnvelopeIdStamping
getset

When set to true, Envelope ID Stamping is enabled.

When set to true, Envelope ID Stamping is enabled.

◆ EnvelopeUri

string DocuSign.eSign.Model.EnvelopeTemplateResult.EnvelopeUri
getset

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

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

◆ FolderId

string DocuSign.eSign.Model.EnvelopeTemplateResult.FolderId
getset

◆ FolderName

string DocuSign.eSign.Model.EnvelopeTemplateResult.FolderName
getset

◆ FolderUri

string DocuSign.eSign.Model.EnvelopeTemplateResult.FolderUri
getset

◆ InitialSentDateTime

string DocuSign.eSign.Model.EnvelopeTemplateResult.InitialSentDateTime
getset

◆ Is21CFRPart11

string DocuSign.eSign.Model.EnvelopeTemplateResult.Is21CFRPart11
getset

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

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

◆ IsSignatureProviderEnvelope

string DocuSign.eSign.Model.EnvelopeTemplateResult.IsSignatureProviderEnvelope
getset

◆ LastModified

string DocuSign.eSign.Model.EnvelopeTemplateResult.LastModified
getset

◆ LastModifiedDateTime

string DocuSign.eSign.Model.EnvelopeTemplateResult.LastModifiedDateTime
getset

The date and time the item was last modified.

The date and time the item was last modified.

◆ LockInformation

LockInformation DocuSign.eSign.Model.EnvelopeTemplateResult.LockInformation
getset

Gets or Sets LockInformation

◆ MessageLock

string DocuSign.eSign.Model.EnvelopeTemplateResult.MessageLock
getset

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

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

◆ Name

string DocuSign.eSign.Model.EnvelopeTemplateResult.Name
getset

◆ Notification

Notification DocuSign.eSign.Model.EnvelopeTemplateResult.Notification
getset

Gets or Sets Notification

◆ NotificationUri

string DocuSign.eSign.Model.EnvelopeTemplateResult.NotificationUri
getset

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

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

◆ Owner

UserInfo DocuSign.eSign.Model.EnvelopeTemplateResult.Owner
getset

Gets or Sets Owner

◆ PageCount

int DocuSign.eSign.Model.EnvelopeTemplateResult.PageCount
getset

◆ ParentFolderUri

string DocuSign.eSign.Model.EnvelopeTemplateResult.ParentFolderUri
getset

◆ Password

string DocuSign.eSign.Model.EnvelopeTemplateResult.Password
getset

◆ PurgeState

string DocuSign.eSign.Model.EnvelopeTemplateResult.PurgeState
getset

◆ Recipients

Recipients DocuSign.eSign.Model.EnvelopeTemplateResult.Recipients
getset

Gets or Sets Recipients

◆ RecipientsLock

string DocuSign.eSign.Model.EnvelopeTemplateResult.RecipientsLock
getset

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

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

◆ RecipientsUri

string DocuSign.eSign.Model.EnvelopeTemplateResult.RecipientsUri
getset

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

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

◆ SentDateTime

string DocuSign.eSign.Model.EnvelopeTemplateResult.SentDateTime
getset

The date and time the envelope was sent.

The date and time the envelope was sent.

◆ Shared

string DocuSign.eSign.Model.EnvelopeTemplateResult.Shared
getset

When set to true, this custom tab is shared.

When set to true, this custom tab is shared.

◆ SignerCanSignOnMobile

string DocuSign.eSign.Model.EnvelopeTemplateResult.SignerCanSignOnMobile
getset

◆ SigningLocation

string DocuSign.eSign.Model.EnvelopeTemplateResult.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.

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

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.EnvelopeTemplateResult.StatusChangedDateTime
getset

The data and time the status changed.

The data and time the status changed.

◆ TemplateId

string DocuSign.eSign.Model.EnvelopeTemplateResult.TemplateId
getset

The unique identifier of the template. If this is not provided, DocuSign will generate a value.

The unique identifier of the template. If this is not provided, DocuSign will generate a value.

◆ TemplatesUri

string DocuSign.eSign.Model.EnvelopeTemplateResult.TemplatesUri
getset

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

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

◆ TransactionId

string DocuSign.eSign.Model.EnvelopeTemplateResult.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 &#x60;transactionId&#x60; property can be used determine an envelope&#39;s status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.

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 &#x60;transactionId&#x60; property can be used determine an envelope&#39;s status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.

◆ Uri

string DocuSign.eSign.Model.EnvelopeTemplateResult.Uri
getset

◆ UseDisclosure

string DocuSign.eSign.Model.EnvelopeTemplateResult.UseDisclosure
getset

When set to true, the disclosure is shown to recipients in accordance with the account&#39;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 &#x60;useDisclosure&#x60; property is not set, then the account&#39;s normal disclosure setting is used and the value of the &#x60;useDisclosure&#x60; property is not returned in responses when getting envelope information.

When set to true, the disclosure is shown to recipients in accordance with the account&#39;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 &#x60;useDisclosure&#x60; property is not set, then the account&#39;s normal disclosure setting is used and the value of the &#x60;useDisclosure&#x60; property is not returned in responses when getting envelope information.

◆ VoidedDateTime

string DocuSign.eSign.Model.EnvelopeTemplateResult.VoidedDateTime
getset

The date and time the envelope or template was voided.

The date and time the envelope or template was voided.

◆ VoidedReason

string DocuSign.eSign.Model.EnvelopeTemplateResult.VoidedReason
getset

The reason the envelope or template was voided.

The reason the envelope or template was voided.


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