Inherits from NSObject
Declared in SFRestRequest.h

Overview

Request object used to send a REST request to Salesforce.com

Tasks

Other Methods

  •   method

    The HTTP method of the request

    property
  •   path

    The path of the request. For instance, “” (empty string), “v22.0/recent”, “v22.0/query”. Note that the path doesn’t have to start with a ‘/’. For instance, passing “v22.0/recent” is the same as passing “/v22.0/recent”.

    property
  •   queryParams

    The query parameters of the request (could be nil). Note that URL encoding of the parameters will automatically happen when the request is sent.

    property

Initialization

Properties

method

The HTTP method of the request

@property (nonatomic, assign) SFRestMethod method

Discussion

The HTTP method of the request

Declared In

SFRestRequest.h

path

The path of the request. For instance, “” (empty string), “v22.0/recent”, “v22.0/query”. Note that the path doesn’t have to start with a ‘/’. For instance, passing “v22.0/recent” is the same as passing “/v22.0/recent”.

@property (nonatomic, retain) NSString *path

Discussion

The path of the request. For instance, “” (empty string), “v22.0/recent”, “v22.0/query”. Note that the path doesn’t have to start with a ‘/’. For instance, passing “v22.0/recent” is the same as passing “/v22.0/recent”.

Do not pass URL encoded query parameters in the path. Use the queryParams property instead.

Declared In

SFRestRequest.h

queryParams

The query parameters of the request (could be nil). Note that URL encoding of the parameters will automatically happen when the request is sent.

@property (nonatomic, retain) NSDictionary *queryParams

Discussion

The query parameters of the request (could be nil). Note that URL encoding of the parameters will automatically happen when the request is sent.

Declared In

SFRestRequest.h

Class Methods

requestWithMethod:path:queryParams:

Creates an SFRestRequest object.

+ (id)requestWithMethod:(SFRestMethod)method path:(NSString *)path queryParams:(NSDictionary *)queryParams

Parameters

method

the HTTP method

path

the request path

queryParams

the parameters of the request (could be nil)

Discussion

Creates an SFRestRequest object.

Declared In

SFRestRequest.h