DSMDocument Class Reference

#import <DSMDocument.h>

Inheritance diagram for DSMDocument:

Properties

NSString * documentId
 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. [optional]. More...
 
NSString * uri
 TODO:Doc. More...
 
NSString * remoteUrl
 The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}]. [optional]. More...
 
NSString * name
 TODO:Doc. More...
 
NSString * password
 TODO:Doc. More...
 
BOOL transformPdfFields
 When set to true, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs. [optional]. More...
 
NSString * fileExtension
 The file extension type of the document. If the document is not a PDF it is converted to a PDF. [optional]. More...
 
NSString * order
 TODO:Doc. More...
 
NSString * pages
 TODO:Doc. More...
 
BOOL encryptedWithKeyManager
 When set to true, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance. [optional]. More...
 
NSString * documentBase64
 The document byte stream. This allows putting a base64 version of document bytes into an envelope. [optional]. More...
 
NSString * applyAnchorTabs
 TODO:Doc. More...
 
NSString * sandboxFilePath
 TODO:Doc. More...
 
NSData * pdf
 TODO:Doc. More...
 
NSString * display
 TODO:Doc. More...
 
NSString * signerMustAcknowledge
 TODO:Doc. More...
 
BOOL includeInDownload
 TODO:Doc. More...
 
NSSet< DSMNameValue * > * documentFields
 NSSet of DSMNameValue class object. More...
 

Property Documentation

◆ applyAnchorTabs

- (NSString*) applyAnchorTabs
readwritenonatomiccopy

TODO:Doc.

◆ display

- (NSString*) display
readwritenonatomiccopy

TODO:Doc.

◆ documentBase64

- (NSString*) documentBase64
readwritenonatomiccopy

The document byte stream. This allows putting a base64 version of document bytes into an envelope. [optional].

◆ documentFields

- (NSSet<DSMNameValue *>*) documentFields
readwritenonatomicretain

NSSet of DSMNameValue class object.

See also
DSMNameValue.h

◆ documentId

- (NSString*) documentId
readwritenonatomiccopy

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

◆ encryptedWithKeyManager

- (BOOL) encryptedWithKeyManager
readwritenonatomicassign

When set to true, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance. [optional].

◆ fileExtension

- (NSString*) fileExtension
readwritenonatomiccopy

The file extension type of the document. If the document is not a PDF it is converted to a PDF. [optional].

◆ includeInDownload

- (BOOL) includeInDownload
readwritenonatomicassign

TODO:Doc.

◆ name

- (NSString*) name
readwritenonatomiccopy

TODO:Doc.

◆ order

- (NSString*) order
readwritenonatomiccopy

TODO:Doc.

◆ pages

- (NSString*) pages
readwritenonatomiccopy

TODO:Doc.

◆ password

- (NSString*) password
readwritenonatomiccopy

TODO:Doc.

◆ pdf

- (NSData*) pdf
readwritenonatomiccopy

TODO:Doc.

◆ remoteUrl

- (NSString*) remoteUrl
readwritenonatomiccopy

The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}]. [optional].

◆ sandboxFilePath

- (NSString*) sandboxFilePath
readwritenonatomiccopy

TODO:Doc.

◆ signerMustAcknowledge

- (NSString*) signerMustAcknowledge
readwritenonatomiccopy

TODO:Doc.

◆ transformPdfFields

- (BOOL) transformPdfFields
readwritenonatomicassign

When set to true, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs. [optional].

◆ uri

- (NSString*) uri
readwritenonatomiccopy

TODO:Doc.


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