VaultMobileSDK  18R3
iOS framework for Vault API
Classes | Typedefs | Enumerations
VEVVaultAPI.h File Reference

Go to the source code of this file.

Classes

class  VEVVaultAPI
 A singleton class that is used to interface to the Vault server and the methods here help to issue requests and process responses. More...
 

Typedefs

typedef void(^ VEVVaultAPIResponseHandler) (NSDictionary *_Nullable response, NSError *_Nullable error)
 The block type used to call back to the application after a request to Vault. More...
 
typedef void(^ VEVVaultAPIUploadResultHandler) (NSDictionary *_Nullable response, NSURL *fileURL, NSString *username, NSError *_Nullable error)
 The block type used to call back to the application after a multipart request upload to Vault completes. More...
 
typedef void(^ VEVVaultAPIDownloadResultHandler) (NSDictionary *_Nullable response, NSURL *fileURL, NSString *_Nullable MIMEType, NSString *username, NSError *_Nullable error)
 The block type used to call back to the application after a download request to Vault completes. More...
 
typedef void(^ VEVVaultAPIProgressHandler) (NSProgress *progress)
 The block type to call back to the application after a chunk of data is uploaded or downloaded. More...
 
typedef void(^ VEVVaultAPICreateDocumentResultHandler) (NSDictionary *_Nullable response, NSError *_Nullable error)
 The block type to call back to the application after a new Vault document has been created, for example, after uploading an unclassified document. More...
 
typedef void(^ VEVVaultAPIUpdateDocumentResultHandler) (NSDictionary *_Nullable response, NSError *_Nullable error)
 The block type to call back to the application after an existing Vault document has been updated, for example, after uploading a PDF file to a placeholder document. More...
 
typedef void(^ VEVVaultAPIGetDocumentResultHandler) (NSDictionary *_Nullable response, NSError *_Nullable error)
 The block type to call back to the application after retrieving the document information from Vault. More...
 
typedef void(^ VEVVaultAPIGetDocumentsResultHandler) (NSDictionary *_Nullable response, NSError *_Nullable error)
 The block type to call back to the application after retrieving the list of document information from Vault. More...
 
typedef void(^ VEVVaultAPIGetDocumentTypeResultHandler) (NSDictionary *_Nullable response, NSError *_Nullable error)
 The block type to call back to the application after retrieving document type information from Vault. More...
 
typedef void(^ VEVVaultAPIGetDocumentPropertiesResultHandler) (NSDictionary *_Nullable response, NSError *_Nullable error)
 The block type to call back to the application after retrieving a document's properties from Vault. More...
 

Enumerations

enum  VEVRequestMethod { VEVRequestMethodGET = 1, VEVRequestMethodPOST = 2, VEVRequestMethodPUT = 3 }
 The HTTP method to use when invoking a request on Vault. More...
 
enum  VEVParameterEncoding { VEVFormURLEncoding = 1, VEVJSONEncoding = 2 }
 The encoding used by a request's params. More...
 
enum  VEVSearchScope { VEVSearchScopeContents = 1, VEVSearchScopeContentsAndFields = 2 }
 The scope to apply search keywords to when searching. More...
 
enum  VEVSearchResultsSortOrder { VEVSearchResultsSortOrderDefault = 0, VEVSearchResultsSortOrderAscending = 1, VEVSearchResultsSortOrderDescending = 2 }
 

Detailed Description

Typedef Documentation

◆ VEVVaultAPIResponseHandler

typedef void(^ VEVVaultAPIResponseHandler) (NSDictionary *_Nullable response, NSError *_Nullable error)

The block type used to call back to the application after a request to Vault.

Parameters
responseThe vault JSON response serialized to an NSDictionary object.
errorThe error object in the event an error occurred during the request.

◆ VEVVaultAPIUploadResultHandler

typedef void(^ VEVVaultAPIUploadResultHandler) (NSDictionary *_Nullable response, NSURL *fileURL, NSString *username, NSError *_Nullable error)

The block type used to call back to the application after a multipart request upload to Vault completes.

Parameters
responseThe vault JSON response for the upload serialized to an NSDictionary object.
fileURLThe file URL of the local document that was uploaded.
usernameThe username of the user who performed the upload.
errorThe error object in the event an error occurred during the request.

◆ VEVVaultAPIDownloadResultHandler

typedef void(^ VEVVaultAPIDownloadResultHandler) (NSDictionary *_Nullable response, NSURL *fileURL, NSString *_Nullable MIMEType, NSString *username, NSError *_Nullable error)

The block type used to call back to the application after a download request to Vault completes.

Parameters
responseThe vault JSON response for the download serialized to an NSDictionary object. This will only be set in the event a Vault server error occurs.
fileURLThe file URL of the local document location that the file was downloaded to.
MIMETypeThe MIMEType of the downloaded file.
usernameThe username of the user who performed the download.
errorThe error object in the event an error occurred during the request.

◆ VEVVaultAPIProgressHandler

typedef void(^ VEVVaultAPIProgressHandler) (NSProgress *progress)

The block type to call back to the application after a chunk of data is uploaded or downloaded.

Parameters
progressThe NSProgress that indicates the percent currently complete.

◆ VEVVaultAPICreateDocumentResultHandler

typedef void(^ VEVVaultAPICreateDocumentResultHandler) (NSDictionary *_Nullable response, NSError *_Nullable error)

The block type to call back to the application after a new Vault document has been created, for example, after uploading an unclassified document.

Parameters
responseThe vault JSON response serialized to an NSDictionary object.
errorThe error object in the event an error occurred creating the document.

◆ VEVVaultAPIUpdateDocumentResultHandler

typedef void(^ VEVVaultAPIUpdateDocumentResultHandler) (NSDictionary *_Nullable response, NSError *_Nullable error)

The block type to call back to the application after an existing Vault document has been updated, for example, after uploading a PDF file to a placeholder document.

Parameters
responseThe vault JSON response serialized to an NSDictionary object.
errorThe error object in the event an error occurred updating the document.

◆ VEVVaultAPIGetDocumentResultHandler

typedef void(^ VEVVaultAPIGetDocumentResultHandler) (NSDictionary *_Nullable response, NSError *_Nullable error)

The block type to call back to the application after retrieving the document information from Vault.

Parameters
responseThe vault JSON response serialized to an NSDictionary object.
errorThe error object in the event an error occurred while retrieving the document information.

◆ VEVVaultAPIGetDocumentsResultHandler

typedef void(^ VEVVaultAPIGetDocumentsResultHandler) (NSDictionary *_Nullable response, NSError *_Nullable error)

The block type to call back to the application after retrieving the list of document information from Vault.

Parameters
responseThe vault JSON response serialized to an NSDictionary object.
errorThe error object in the event an error occurred while retrieving the document information.

◆ VEVVaultAPIGetDocumentTypeResultHandler

typedef void(^ VEVVaultAPIGetDocumentTypeResultHandler) (NSDictionary *_Nullable response, NSError *_Nullable error)

The block type to call back to the application after retrieving document type information from Vault.

Parameters
responseThe Vault JSON response serialized to an NSDictionary object.
errorThe error object in the event an error occurred while retrieving the document type information.

◆ VEVVaultAPIGetDocumentPropertiesResultHandler

typedef void(^ VEVVaultAPIGetDocumentPropertiesResultHandler) (NSDictionary *_Nullable response, NSError *_Nullable error)

The block type to call back to the application after retrieving a document's properties from Vault.

Parameters
responseThe Vault JSON response serialized to an NSDictionary object.
errorThe error object in the event an error occurred while retrieving the document's properties.

Enumeration Type Documentation

◆ VEVRequestMethod

The HTTP method to use when invoking a request on Vault.

Enumerator
VEVRequestMethodGET 

GET HTTP method.

VEVRequestMethodPOST 

POST HTTP method.

VEVRequestMethodPUT 

PUT HTTP method.

◆ VEVParameterEncoding

The encoding used by a request's params.

Enumerator
VEVFormURLEncoding 

Specifies request parameters are encoded with ContentType application/x-www-form-urlencoded.

VEVJSONEncoding 

Specifies request parameters are encoded with ContentType application/json.

◆ VEVSearchScope

The scope to apply search keywords to when searching.

Enumerator
VEVSearchScopeContents 

Search the file contents only.

VEVSearchScopeContentsAndFields 

Search both the contents and the document record fields.

◆ VEVSearchResultsSortOrder

The sort order to apply to search list results.

Enumerator
VEVSearchResultsSortOrderDefault 

Applies the default sort order for records being searched.

VEVSearchResultsSortOrderAscending 

Sorts the results in ascending order.

VEVSearchResultsSortOrderDescending 

Sorts the results in descending order.