DSMEnvelopeTemplate Class Reference

#import <DSMEnvelopeTemplate.h>

Inheritance diagram for DSMEnvelopeTemplate:
DSMEnvelopeDefinition

Protected Types

enum  DSMDisclosureSetting { DSMDisclosureSettingUseAccountDisclosureSetting, DSMDisclosureSettingShownToRecipients, DSMDisclosureSettingNotShownToRecipients }
 

Properties

DSMEnvelopeTemplateDefinitionenvelopeTemplateDefinition
 The DSMEnvelopeTemplateDefinition class object. More...
 
NSArray< DSMDocument * > * documents
 The DSMDocument class object, details on the documents in the template. More...
 
DSMDocumentcombinedDocument
 The DSMDocument class object, combined pdf of all documents in template. More...
 
DSMRecipientsrecipients
 The DSMRecipients class object, list of recipients on template. More...
 
DSMNotificationnotification
 The DSMRecipients class object, list of recipients on template. More...
 
DSMCustomFieldscustomFields
 
DSMEmailSettingsemailSettings
 
NSString * 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 if an envelope status (i.e. was created or not) for cases where an internet connection was lost before the envelope status could be returned. [optional]. More...
 
NSString * 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. [optional]. More...
 
NSString * documentsUri
 Contains a URI for an endpoint that you can use to retrieve the documents. [optional]. More...
 
NSString * recipientsUri
 Contains a URI for an endpoint that you can use to retrieve the recipients. [optional]. More...
 
BOOL 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. [optional]. More...
 
NSString * envelopeUri
 Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. [optional]. More...
 
NSString * emailSubject
 Specifies the subject of the email that is sent to all recipients.
[ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. [optional]. More...
 
NSString * emailBlurb
 TODO:Doc. More...
 
NSString * envelopeId
 The envelope ID of the envelope. More...
 
NSString * signingLocation
 Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. [optional]. More...
 
NSString * customFieldsUri
 Contains a URI for an endpoint that you can use to retrieve the custom fields. [optional]. More...
 
BOOL envelopeIdStamping
 When set to true, Envelope ID Stamping is enabled. [optional]. More...
 
BOOL authoritativeCopy
 Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. [optional]. More...
 
NSString * notificationUri
 Contains a URI for an endpoint that you can use to retrieve the notifications. [optional]. More...
 
BOOL 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.
account must have Document Visibility enabled to use this. [optional]. More...
 
BOOL enableWetSign
 When set to true, the signer is allowed to print the document and sign it on paper. [optional]. More...
 
BOOL allowMarkup
 When set to true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this [optional]. More...
 
BOOL allowReassign
 TODO:Doc. More...
 
NSDate * createdDateTime
 Indicates the date and time the item was created. [optional]. More...
 
NSDate * lastModifiedDateTime
 The date and time the item was last modified. [optional]. More...
 
NSDate * deliveredDateTime
 For DocuSign use only. [optional]. More...
 
NSDate * sentDateTime
 The date and time the envelope was sent. [optional]. More...
 
NSDate * completedDateTime
 Specifies the date and time this item was completed. [optional]. More...
 
NSDate * voidedDateTime
 The date and time the envelope or template was voided. [optional]. More...
 
NSDate * cachedDateTime
 The date and time the envelope or template was cached. More...
 
NSString * voidedReason
 The reason the envelope or template was voided. [optional]. More...
 
NSDate * deletedDateTime
 Specifies the data and time the item was deleted. [optional]. More...
 
NSDate * declinedDateTime
 The date and time the recipient declined the document. [optional]. More...
 
NSDate * statusChangedDateTime
 The data and time the status changed. [optional]. More...
 
NSString * documentsCombinedUri
 Contains a URI for an endpoint that you can use to retrieve combined document. More...
 
NSString * certificateUri
 Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. [optional]. More...
 
NSString * templatesUri
 Contains a URI for an endpoint which you can use to retrieve the templates. [optional]. More...
 
BOOL messageLock
 When set to true, prevents senders from changing the contents of emailBlurb and emailSubject properties for the envelope.
, this prevents users from making changes to the contents of emailBlurb and emailSubject properties when correcting envelopes.
, 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. [optional]. More...
 
BOOL recipientsLock
 When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope. [optional]. More...
 
DSMDisclosureSetting disclosureSetting
 TODO. More...
 
NSString * purgeState
 TODO. More...
 
BOOL is21CFRPart11
 When set to true, indicates that this module is enabled on the account. [optional]. More...
 
BOOL autoNavigation
 TODO. More...
 
BOOL isSignatureProviderEnvelope
 TODO. More...
 
NSString * brandId
 TODO. More...
 
BOOL brandLock
 TODO. More...
 
NSInteger currentRoutingOrder
 TODO. More...
 

Member Enumeration Documentation

◆ DSMDisclosureSetting

- (enum) DSMDisclosureSetting
protected
Enumerator
DSMDisclosureSettingUseAccountDisclosureSetting 
DSMDisclosureSettingShownToRecipients 
DSMDisclosureSettingNotShownToRecipients 

Property Documentation

◆ allowMarkup

- (BOOL) allowMarkup
readwritenonatomicassign

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

◆ allowReassign

- (BOOL) allowReassign
readwritenonatomicassign

TODO:Doc.

◆ asynchronous

- (BOOL) asynchronous
readwritenonatomicassign

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. [optional].

◆ authoritativeCopy

- (BOOL) authoritativeCopy
readwritenonatomicassign

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

◆ autoNavigation

- (BOOL) autoNavigation
readwritenonatomicassign

TODO.

◆ brandId

- (NSString*) brandId
readwritenonatomiccopy

TODO.

◆ brandLock

- (BOOL) brandLock
readwritenonatomicassign

TODO.

◆ cachedDateTime

- (NSDate*) cachedDateTime
readwritenonatomiccopy

The date and time the envelope or template was cached.

◆ certificateUri

- (NSString*) certificateUri
readwritenonatomiccopy

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

◆ combinedDocument

- (DSMDocument*) combinedDocument
readwritenonatomicretain

The DSMDocument class object, combined pdf of all documents in template.

See also
DSMDocument.h

◆ completedDateTime

- (NSDate*) completedDateTime
readwritenonatomiccopy

Specifies the date and time this item was completed. [optional].

◆ createdDateTime

- (NSDate*) createdDateTime
readwritenonatomiccopy

Indicates the date and time the item was created. [optional].

◆ currentRoutingOrder

- (NSInteger) currentRoutingOrder
readwritenonatomicassign

TODO.

◆ customFields

- (DSMCustomFields*) customFields
readwritenonatomicretain

◆ customFieldsUri

- (NSString*) customFieldsUri
readwritenonatomiccopy

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

◆ declinedDateTime

- (NSDate*) declinedDateTime
readwritenonatomiccopy

The date and time the recipient declined the document. [optional].

◆ deletedDateTime

- (NSDate*) deletedDateTime
readwritenonatomiccopy

Specifies the data and time the item was deleted. [optional].

◆ deliveredDateTime

- (NSDate*) deliveredDateTime
readwritenonatomiccopy

For DocuSign use only. [optional].

◆ disclosureSetting

- (DSMDisclosureSetting) disclosureSetting
readwritenonatomicassign

TODO.

◆ documents

- (NSArray<DSMDocument *>*) documents
readwritenonatomiccopy

The DSMDocument class object, details on the documents in the template.

See also
DSMDocument.h

◆ documentsCombinedUri

- (NSString*) documentsCombinedUri
readwritenonatomiccopy

Contains a URI for an endpoint that you can use to retrieve combined document.

◆ documentsUri

- (NSString*) documentsUri
readwritenonatomiccopy

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

◆ emailBlurb

- (NSString*) emailBlurb
readwritenonatomiccopy

TODO:Doc.

◆ emailSettings

- (DSMEmailSettings*) emailSettings
readwritenonatomicretain

◆ emailSubject

- (NSString*) emailSubject
readwritenonatomiccopy

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

◆ enableWetSign

- (BOOL) enableWetSign
readwritenonatomicassign

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

◆ enforceSignerVisibility

- (BOOL) enforceSignerVisibility
readwritenonatomicassign

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.
account must have Document Visibility enabled to use this. [optional].

◆ envelopeId

- (NSString*) envelopeId
readwritenonatomiccopy

The envelope ID of the envelope.

◆ envelopeIdStamping

- (BOOL) envelopeIdStamping
readwritenonatomicassign

When set to true, Envelope ID Stamping is enabled. [optional].

◆ envelopeTemplateDefinition

- (DSMEnvelopeTemplateDefinition*) envelopeTemplateDefinition
readwritenonatomicretain

◆ envelopeUri

- (NSString*) envelopeUri
readwritenonatomiccopy

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

◆ is21CFRPart11

- (BOOL) is21CFRPart11
readwritenonatomicassign

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

◆ isSignatureProviderEnvelope

- (BOOL) isSignatureProviderEnvelope
readwritenonatomicassign

TODO.

◆ lastModifiedDateTime

- (NSDate*) lastModifiedDateTime
readwritenonatomiccopy

The date and time the item was last modified. [optional].

◆ messageLock

- (BOOL) messageLock
readwritenonatomicassign

When set to true, prevents senders from changing the contents of emailBlurb and emailSubject properties for the envelope.
, this prevents users from making changes to the contents of emailBlurb and emailSubject properties when correcting envelopes.
, 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. [optional].

◆ notification

- (DSMNotification*) notification
readwritenonatomicretain

The DSMRecipients class object, list of recipients on template.

See also
DSMRecipients.h

◆ notificationUri

- (NSString*) notificationUri
readwritenonatomiccopy

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

◆ purgeState

- (NSString*) purgeState
readwritenonatomiccopy

TODO.

◆ recipients

- (DSMRecipients*) recipients
readwritenonatomicretain

The DSMRecipients class object, list of recipients on template.

See also
DSMRecipients.h

◆ recipientsLock

- (BOOL) recipientsLock
readwritenonatomicassign

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

◆ recipientsUri

- (NSString*) recipientsUri
readwritenonatomiccopy

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

◆ sentDateTime

- (NSDate*) sentDateTime
readwritenonatomiccopy

The date and time the envelope was sent. [optional].

◆ signingLocation

- (NSString*) signingLocation
readwritenonatomiccopy

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

◆ status

- (NSString*) status
readwritenonatomiccopy

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. [optional].

◆ statusChangedDateTime

- (NSDate*) statusChangedDateTime
readwritenonatomiccopy

The data and time the status changed. [optional].

◆ templatesUri

- (NSString*) templatesUri
readwritenonatomiccopy

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

◆ transactionId

- (NSString*) transactionId
readwritenonatomiccopy

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 if an envelope status (i.e. was created or not) for cases where an internet connection was lost before the envelope status could be returned. [optional].

◆ voidedDateTime

- (NSDate*) voidedDateTime
readwritenonatomiccopy

The date and time the envelope or template was voided. [optional].

◆ voidedReason

- (NSString*) voidedReason
readwritenonatomiccopy

The reason the envelope or template was voided. [optional].


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