RKRequest Class Reference
| Inherits from | NSObject |
| Declared in | RKRequest.h RKRequest.m |
Overview
Background Request Policy
On iOS 4.x and higher, UIKit provides support for continueing activities for a limited amount of time in the background. RestKit provides simple support for continuing a request when in the background.
Tasks
-
URLThe URL this request is loading
property -
resourcePathThe resourcePath portion of this loader’s URL
property -
methodThe HTTP verb the request is sent via
property -
paramsA serializable collection of parameters sent as the HTTP Body of the request
property -
delegateThe delegate to inform when the request is completed
property -
additionalHTTPHeadersA Dictionary of additional HTTP Headers to send with the request
property -
userDataAn opaque pointer to associate user defined data with the request.
property -
backgroundPolicyThe policy to take on transition to the background (iOS 4.x and higher only)
property -
usernameCredentials for HTTP AUTH Challenge
property -
URLRequestThe underlying NSMutableURLRequest sent for this request
property -
HTTPMethodThe HTTP method as a string used for this request
property -
+ requestWithURL:delegate:Return a REST request that is ready for dispatching
-
– initWithURL:Initialize a synchronous request
-
– initWithURL:delegate:Initialize a REST request and prepare it for dispatching
-
– prepareURLRequestSetup the NSURLRequest. The request must be prepared right before dispatching
-
– sendSend the request asynchronously. It will be added to the queue and dispatched as soon as possible.
-
– sendAsynchronouslyImmediately dispatch a request asynchronously, skipping the request queue
-
– sendSynchronouslySend the request synchronously and return a hydrated response object
-
– didFailLoadWithError:Callback performed to notify the request that the underlying NSURLConnection has failed with an error.
-
– didFinishLoad:Callback performed to notify the request that the underlying NSURLConnection has completed with a response.
-
– cancelCancels the underlying URL connection. This will send the requestDidCancel: delegate method if your delegate responds to it. It then nils out the delegate to ensure no more messages are sent to it.
-
– isGETReturns YES when this is a GET request
-
– isPOSTReturns YES when this is a POST request
-
– isPUTReturns YES when this is a PUT request
-
– isDELETEReturns YES when this is a DELETE request
-
– isLoadingReturns YES when this request is in-progress
-
– isLoadedReturns YES when this request has been completed
-
– wasSentToResourcePath:Returns YES when the request was sent to the specified resource path
Properties
HTTPMethod
The HTTP method as a string used for this request
@property (nonatomic, readonly) NSString *HTTPMethodDeclared In
RKRequest.hURL
The URL this request is loading
@property (nonatomic, readonly) NSURL *URLDeclared In
RKRequest.hURLRequest
The underlying NSMutableURLRequest sent for this request
@property (nonatomic, readonly) NSMutableURLRequest *URLRequestDeclared In
RKRequest.hadditionalHTTPHeaders
A Dictionary of additional HTTP Headers to send with the request
@property (nonatomic, retain) NSDictionary *additionalHTTPHeadersDeclared In
RKRequest.hbackgroundPolicy
The policy to take on transition to the background (iOS 4.x and higher only)
@property (nonatomic, assign) RKRequestBackgroundPolicy backgroundPolicyDiscussion
Default: RKRequestBackgroundPolicyCancel
Declared In
RKRequest.hdelegate
The delegate to inform when the request is completed
@property (nonatomic, assign) NSObject<RKRequestDelegate> *delegateDiscussion
If the object implements the RKRequestDelegate protocol, it will receive request lifecycle event messages.
Declared In
RKRequest.hmethod
The HTTP verb the request is sent via
@property (nonatomic, assign) RKRequestMethod methodDiscussion
@default RKRequestMethodGET
Declared In
RKRequest.hparams
A serializable collection of parameters sent as the HTTP Body of the request
@property (nonatomic, retain) NSObject<RKRequestSerializable> *paramsDeclared In
RKRequest.hresourcePath
The resourcePath portion of this loader’s URL
@property (nonatomic, readonly) NSString *resourcePathDeclared In
RKRequest.hInstance Methods
cancel
Cancels the underlying URL connection. This will send the requestDidCancel: delegate method if your delegate responds to it. It then nils out the delegate to ensure no more messages are sent to it.
- (void)cancelDeclared In
RKRequest.hdidFailLoadWithError:
Callback performed to notify the request that the underlying NSURLConnection has failed with an error.
- (void)didFailLoadWithError:(NSError *)errorDeclared In
RKRequest.hdidFinishLoad:
Callback performed to notify the request that the underlying NSURLConnection has completed with a response.
- (void)didFinishLoad:(RKResponse *)responseDeclared In
RKRequest.hinitWithURL:
Initialize a synchronous request
- (id)initWithURL:(NSURL *)URLDeclared In
RKRequest.hinitWithURL:delegate:
Initialize a REST request and prepare it for dispatching
- (id)initWithURL:(NSURL *)URL delegate:(id)delegateDeclared In
RKRequest.hprepareURLRequest
Setup the NSURLRequest. The request must be prepared right before dispatching
- (void)prepareURLRequestDeclared In
RKRequest.hsend
Send the request asynchronously. It will be added to the queue and dispatched as soon as possible.
- (void)sendDeclared In
RKRequest.hsendAsynchronously
Immediately dispatch a request asynchronously, skipping the request queue
- (void)sendAsynchronouslyDeclared In
RKRequest.h