VPNURequest
A special request class used by
VPNUTransport.
Discussion
A request object is constructed with one of the factory methods. Most API requests should be constructed using APIRequestWithAction: or APIRequestWithAction:andParams: methods. The newly created request must then be passed as a parameter to sendRequest:error: or cURLSendRequest:error: methods of VPNUTransport class instance.
Extends: NSObject
Declared in: VPNURequest.h
Class Methods
APIRequestWithAction:
+ (instancetype)APIRequestWithAction:(NSString *)action;
Same as
APIRequestWithAction:andParams: but does not use any extra parameters.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
APIRequestWithAction:andParams:
+ (instancetype)APIRequestWithAction:(NSString *)action andParams:(NSDictionary *)params;
Creates and returns a newly constructed
VPNURequest object for API-related routines using a specified action.
Parameters
- action
- One of the predefined action strings associated with the new request. Cannot be
nil. - params
- A dictionary containing additional parameters for the request. Can be
nil.
Return value
The newly constructed VPNURequest object or nil if construction fails.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
authRequestWithAction:
+ (instancetype)authRequestWithAction:(NSString *)action;
Same as
authRequestWithAction:andParams: but does not use any extra parameters.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
authRequestWithAction:andParams:
+ (instancetype)authRequestWithAction:(NSString *)action andParams:(NSDictionary *)params;
Creates and returns a newly constructed
VPNURequest object for authorization-related routines using a specified action.
Parameters
- action
- One of the predefined action strings associated with the new request. Cannot be
nil. - params
- A dictionary containing additional parameters for the request. Can be
nil.
Return value
The newly constructed VPNURequest object or nil if construction fails.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
setApplicationBundleID:
+ (void)setApplicationBundleID:(NSString *)bundleID;
Explicitly indicate bundle ID.
Parameters
- Your
- application bundle ID.
setApplicationID:
+ (void)setApplicationID:(NSString *)appID;
Sets the application ID needed for request signing
Parameters
- appID
- Your application ID.
setApplicationSecret:
+ (void)setApplicationSecret:(NSString *)appSecret;
Sets the application secret key needed for request signing
Parameters
- appSecret
- Your application secret key.
Instance Methods
parameterObjectForKey:
- (id)parameterObjectForKey:(NSString *)key;
Returns the value object associated with a given key in the parameters dictionary of the request.
Parameters
- key
- The key for which to return the corresponding object value. Must not be
nil.
Return value
The value object associated with key in the parameters dictionary of the request, or nil if no object is associated with key.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
setParameterObject:forKey:
- (void)setParameterObject:(id)object forKey:(NSString *)key;
Adds a given key-value pair to the parameters dictionary of the request.
Parameters
- object
- The value for
key. Must be ofNSStringorNSNumberclass. Must not benil. - key
- The key for value. Must not be
nil.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
Properties
timeoutInterval
@property (nonatomic) NSTimeInterval timeoutInterval;
The timeout interval specifies the limit on the idle interval alloted to a request in the process of loading. Default value is 10.0.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
useSession
@property (nonatomic) BOOL useSession;
Indicates if the request should use current session. Default value is YES.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.