7 #import <Foundation/Foundation.h> 9 NS_ASSUME_NONNULL_BEGIN
12 @class VEVVaultServerQuery;
76 NSError * _Nullable error);
98 NSString * _Nullable MIMEType,
100 NSError * _Nullable error);
110 #pragma mark - Documents 155 NSError * _Nullable error);
168 NSError * _Nullable error);
180 NSError * _Nullable error);
192 NSError * _Nullable error);
203 NSError * _Nullable error);
214 NSError * _Nullable error);
215 #pragma clang diagnostic push 216 #pragma clang diagnostic ignored "-Wdocumentation" 252 #pragma clang diagnostic pop 286 - (void)requestVaultEndpoint:(NSString*)endpoint
289 parameters:(nullable
id)params
325 - (void)requestVaultMultipartFormEndpoint:(NSString*)endpoint
327 fileURL:(NSURL*)fileURL
328 isEncrypted:(BOOL)isEncrypted
330 parameters:(nullable
id)params
364 - (void)requestVaultDownloadFileEndpoint:(NSString*)endpoint
366 fileURL:(NSURL*)fileURL
367 encrypt:(BOOL)encrypt
368 parameters:(nullable
id)params
391 #pragma clang diagnostic push 392 #pragma clang diagnostic ignored "-Wdocumentation" 413 #pragma clang diagnostic pop 415 #pragma clang diagnostic push 416 #pragma clang diagnostic ignored "-Wdocumentation" 417 - (void)createDocumentWithFields:(NSDictionary *)fields
454 #pragma clang diagnostic pop 456 - (void)createDocumentWithFields:(nullable NSDictionary *)fields
458 fileURL:(NSURL *)fileURL
459 fileIsEncrypted:(BOOL)isEncrypted
481 - (void)updateDocument:(NSUInteger)documentId
482 fields:(NSDictionary *)fields
518 - (void)updateDocument:(NSUInteger)documentId
519 fields:(nullable NSDictionary *)fields
521 fileURL:(NSURL *)fileURL
522 fileIsEncrypted:(BOOL)isEncrypted
541 - (void)getDocument:(NSUInteger)documentId
545 #pragma clang diagnostic push 546 #pragma clang diagnostic ignored "-Wdocumentation" 567 #pragma clang diagnostic pop 568 -(void)getDocumentType:(NSString *)name
587 - (void)getDocumentProperties:(NSUInteger)documentId
608 NS_ASSUME_NONNULL_END
Instances of this class may be instantiated directly in order to invoke arbitrary Vault endpoints...
Definition: VEVVaultServerRequest.h:16
Sorts the results in descending order.
Definition: VEVVaultAPI.h:141
VEVParameterEncoding
The encoding used by a request's params.
Definition: VEVVaultAPI.h:35
void(^ VEVVaultAPIProgressHandler)(NSProgress *progress)
The block type to call back to the application after a chunk of data is uploaded or downloaded...
Definition: VEVVaultAPI.h:108
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...
Definition: VEVVaultAPI.h:191
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 complet...
Definition: VEVVaultAPI.h:73
void(^ VEVVaultAPIGetDocumentResultHandler)(NSDictionary *_Nullable response, NSError *_Nullable error)
The block type to call back to the application after retrieving the document information from Vault...
Definition: VEVVaultAPI.h:179
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...
Definition: VEVVaultAPI.h:167
Search both the contents and the document record fields.
Definition: VEVVaultAPI.h:123
Specifies request parameters are encoded with ContentType application/json.
Definition: VEVVaultAPI.h:45
Applies the default sort order for records being searched.
Definition: VEVVaultAPI.h:133
void(^ VEVVaultAPIGetDocumentTypeResultHandler)(NSDictionary *_Nullable response, NSError *_Nullable error)
The block type to call back to the application after retrieving document type information from Vault...
Definition: VEVVaultAPI.h:202
VEVSearchResultsSortOrder
Definition: VEVVaultAPI.h:128
Specifies request parameters are encoded with ContentType application/x-www-form-urlencoded.
Definition: VEVVaultAPI.h:40
Search the file contents only.
Definition: VEVVaultAPI.h:118
GET HTTP method.
Definition: VEVVaultAPI.h:22
An object type that refers to a particular Vault. VEVVaultAuth::currentUser tracks the authenticated ...
Definition: VEVVaultAuth.h:22
void(^ VEVVaultAPIResponseHandler)(NSDictionary *_Nullable response, NSError *_Nullable error)
The block type used to call back to the application after a request to Vault.
Definition: VEVVaultAPI.h:57
A singleton class that is used to interface to the Vault server and the methods here help to issue re...
Definition: VEVVaultAPI.h:253
POST HTTP method.
Definition: VEVVaultAPI.h:26
instancetype sharedInstance()
Return the singleton instance.
Sorts the results in ascending order.
Definition: VEVVaultAPI.h:137
VEVSearchScope
The scope to apply search keywords to when searching.
Definition: VEVVaultAPI.h:114
PUT HTTP method.
Definition: VEVVaultAPI.h:30
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...
Definition: VEVVaultAPI.h:213
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...
Definition: VEVVaultAPI.h:154
VEVRequestMethod
The HTTP method to use when invoking a request on Vault.
Definition: VEVVaultAPI.h:18
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...
Definition: VEVVaultAPI.h:96