VaultMobileSDK  18R3
iOS framework for Vault API
VEVVaultServerRequest.h
Go to the documentation of this file.
1 
5 #import <Foundation/Foundation.h>
6 #import "VEVVaultAPI.h"
7 #import "VEVVaultAuth.h"
8 
9 NS_ASSUME_NONNULL_BEGIN
10 
16 @interface VEVVaultServerRequest : NSObject
17 
34 - (instancetype)initWithEndpoint:(NSString*)endpoint vault:(VEVVault*)vault method:(VEVRequestMethod)method parameterEncoding:(VEVParameterEncoding)parameterEncoding parameters:( NSDictionary* _Nullable )parameters;
35 
36 /* The vault endpoint to execute the request
37  */
38 @property (strong, nonatomic, readonly) NSString *endpoint;
39 
40 /* The vault to execute the query one
41  */
42 @property (strong, nonatomic, readonly) VEVVault *vault;
43 
44 /* The HTTP method to use with the request
45  */
46 @property (nonatomic, readonly) VEVRequestMethod method;
47 
48 /* The parameter encoding to use with the parameters dictionary
49  */
50 @property (nonatomic, readonly) VEVParameterEncoding parameterEncoding;
51 
55 @property (strong, nonatomic, nullable) NSMutableDictionary *parameters;
56 
57 
58 @end
59 NS_ASSUME_NONNULL_END
Instances of this class may be instantiated directly in order to invoke arbitrary Vault endpoints...
Definition: VEVVaultServerRequest.h:16
VEVParameterEncoding
The encoding used by a request&#39;s params.
Definition: VEVVaultAPI.h:35
NSMutableDictionary * parameters
Dictionary that can be used to pass additional parameters to the Vault API.
Definition: VEVVaultServerRequest.h:55
An object type that refers to a particular Vault. VEVVaultAuth::currentUser tracks the authenticated ...
Definition: VEVVaultAuth.h:22
VEVRequestMethod
The HTTP method to use when invoking a request on Vault.
Definition: VEVVaultAPI.h:18