DocuSign CSharp Docs
|
EnvelopeTemplateResult More...
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 `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' 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< Document > | Documents [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 `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... | |
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 `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 | Uri [get, set] |
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 | 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... | |
|
inline |
Initializes a new instance of the EnvelopeTemplateResult class.
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 | . |
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 | . |
AuthoritativeCopy | Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.. |
AuthoritativeCopyDefault | . |
AutoNavigation | . |
BrandId | . |
BrandLock | . |
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.. |
Created | . |
CreatedDateTime | Indicates the date and time the item was created.. |
CustomFields | CustomFields. |
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.. |
Description | . |
Documents | Complex element contains the details on the documents in the envelope.. |
DocumentsCombinedUri | . |
DocumentsUri | Contains a URI for an endpoint that you can use to retrieve the documents.. |
EmailBlurb | . |
EmailSettings | EmailSettings. |
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.. |
EnvelopeId | The envelope ID of the envelope status that failed to post.. |
EnvelopeIdStamping | When set to true, Envelope ID Stamping is enabled.. |
EnvelopeUri | Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.. |
FolderId | . |
FolderName | . |
FolderUri | . |
InitialSentDateTime | . |
Is21CFRPart11 | When set to true, indicates that this module is enabled on the account.. |
IsSignatureProviderEnvelope | . |
LastModified | . |
LastModifiedDateTime | The date and time the item was last modified.. |
LockInformation | LockInformation. |
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.. |
Name | . |
Notification | Notification. |
NotificationUri | Contains a URI for an endpoint that you can use to retrieve the notifications.. |
Owner | Owner. |
PageCount | . |
ParentFolderUri | . |
Password | . |
PurgeState | . |
Recipients | 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.. |
SentDateTime | The date and time the envelope was sent.. |
Shared | When set to true, this custom tab is shared.. |
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.. |
TemplateId | The unique identifier of the template. If this is not provided, DocuSign will generate a value. . |
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.. |
Uri | . |
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.. |
VoidedDateTime | The date and time the envelope or template was voided.. |
VoidedReason | The reason the envelope or template was voided.. |
|
inline |
Returns true if objects are equal
obj | Object to be compared |
|
inline |
Returns true if EnvelopeTemplateResult instances are equal
other | Instance of EnvelopeTemplateResult to be compared |
|
inline |
Gets the hash code
|
inline |
Returns the JSON string presentation of the object
|
inline |
Returns the string presentation of the object
|
getset |
|
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.
|
getset |
|
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.
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.
|
getset |
|
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.
|
getset |
|
getset |
|
getset |
|
getset |
|
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.
|
getset |
Specifies the date and time this item was completed.
Specifies the date and time this item was completed.
|
getset |
|
getset |
Indicates the date and time the item was created.
Indicates the date and time the item was created.
|
getset |
Gets or Sets CustomFields
|
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.
|
getset |
The date and time the recipient declined the document.
The date and time the recipient declined the document.
|
getset |
Specifies the data and time the item was deleted.
Specifies the data and time the item was deleted.
|
getset |
|
getset |
Complex element contains the details on the documents in the envelope.
Complex element contains the details on the documents in the envelope.
|
getset |
|
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.
|
getset |
|
getset |
Gets or Sets EmailSettings
|
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.
|
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.
|
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.
|
getset |
The envelope ID of the envelope status that failed to post.
The envelope ID of the envelope status that failed to post.
|
getset |
|
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.
|
getset |
|
getset |
|
getset |
|
getset |
|
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.
|
getset |
|
getset |
|
getset |
The date and time the item was last modified.
The date and time the item was last modified.
|
getset |
Gets or Sets LockInformation
|
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.
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.
|
getset |
|
getset |
Gets or Sets Notification
|
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.
|
getset |
Gets or Sets Owner
|
getset |
|
getset |
|
getset |
|
getset |
|
getset |
Gets or Sets Recipients
|
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.
|
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.
|
getset |
The date and time the envelope was sent.
The date and time the envelope was sent.
|
getset |
When set to true, this custom tab is shared.
When set to true, this custom tab is shared.
|
getset |
|
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.
|
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.
|
getset |
The data and time the status changed.
The data and time the status changed.
|
getset |
|
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.
|
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.
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.
|
getset |
|
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.
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.
|
getset |
The date and time the envelope or template was voided.
The date and time the envelope or template was voided.
|
getset |
The reason the envelope or template was voided.
The reason the envelope or template was voided.