FBSDKGraphRequest - Documentation

FBSDKGraphRequest

A more recent version of this class is available. Check out the latest version.

Represents a request to the Facebook Graph API.

Discussion:

FBSDKGraphRequest encapsulates the components of a request (the Graph API path, the parameters, error recovery behavior) and should be used in conjunction with FBSDKGraphRequestConnection to issue the request. Nearly all Graph APIs require an access token. Unless specified, the [FBSDKAccessToken currentAccessToken] is used. Therefore, most requests will require login first (see FBSDKLoginManager in FBSDKLoginKit.framework). A - start method is provided for convenience for single requests. By default, FBSDKGraphRequest will attempt to recover any errors returned from Facebook. You can disable this via disableErrorRecovery:.

Superclass:	`NSObject`
Declared in:	`FBSDKGraphRequest.h`

Properties

graphPath

The Graph API endpoint to use for the request, for example "me".

@property (nonatomic,
    copy,
    readonly) NSString *graphPath;

Declared In: FBSDKGraphRequest.h

HTTPMethod

The HTTPMethod to use for the request, for example "GET" or "POST".

@property (nonatomic,
    copy,
    readonly) NSString *HTTPMethod;

Declared In: FBSDKGraphRequest.h

parameters

The request parameters.

@property (nonatomic,
    strong,
    readonly) NSMutableDictionary *parameters;

Declared In: FBSDKGraphRequest.h

tokenString

The access token string used by the request.

@property (nonatomic,
    copy,
    readonly) NSString *tokenString;

Declared In: FBSDKGraphRequest.h

version

The Graph API version to use (e.g., "v2.0")

@property (nonatomic,
    copy,
    readonly) NSString *version;

Declared In: FBSDKGraphRequest.h

Instance Methods

initWithGraphPath:parameters:

Initializes a new instance that use use [FBSDKAccessToken currentAccessToken].

Parameter	Description
`graphPath`	The graph path (e.g., @"me").
`parameters`	The optional parameters dictionary.

- (instancetype)

`initWithGraphPath:`	`(NSString *)graphPath`
`parameters:`	`(NSDictionary *)parameters;`

Declared In: FBSDKGraphRequest.h

initWithGraphPath:parameters:HTTPMethod:

Initializes a new instance that use use [FBSDKAccessToken currentAccessToken].

Parameter	Description
`graphPath`	The graph path (e.g., @"me").
`parameters`	The optional parameters dictionary.
`HTTPMethod`	The optional HTTP method. nil defaults to @"GET".

- (instancetype)

`initWithGraphPath:`	`(NSString *)graphPath`
`parameters:`	`(NSDictionary *)parameters`
`HTTPMethod:`	`(NSString *)HTTPMethod;`

Declared In: FBSDKGraphRequest.h

initWithGraphPath:parameters:tokenString:version:HTTPMethod:

Initializes a new instance.

Parameter	Description
`graphPath`	The graph path (e.g., @"me").
`parameters`	The optional parameters dictionary.
`tokenString`	The token string to use. Specifying nil will cause no token to be used.
`version`	The optional Graph API version (e.g., @"v2.0"). nil defaults to FBSDK_TARGET_PLATFORM_VERSION.
`HTTPMethod`	The optional HTTP method (e.g., @"POST"). nil defaults to @"GET".

- (instancetype)

`initWithGraphPath:`	`(NSString *)graphPath`
`parameters:`	`(NSDictionary *)parameters`
`tokenString:`	`(NSString *)tokenString`
`version:`	`(NSString *)version`
`HTTPMethod:`	`(NSString *)HTTPMethod`
	`NS_DESIGNATED_INITIALIZER;`

Declared In: FBSDKGraphRequest.h

setGraphErrorRecoveryDisabled:

If set, disables the automatic error recovery mechanism.

Parameter	Description
`disable`	Whether to disable the automatic error recovery mechanism

- (void) setGraphErrorRecoveryDisabled:(BOOL)disable;

Discussion:

By default, non-batched FBSDKGraphRequest instances will automatically try to recover from errors by constructing a FBSDKGraphErrorRecoveryProcessor instance that re-issues the request on successful recoveries. The re-issued request will call the same handler as the receiver but may occur with a different FBSDKGraphRequestConnection instance. This will override [FBSDKSettings setGraphErrorRecoveryDisabled:].

Declared In: FBSDKGraphRequest.h

startWithCompletionHandler:

Starts a connection to the Graph API.

Parameter	Description
`handler`	The handler block to call when the request completes.

- (FBSDKGraphRequestConnection *) startWithCompletionHandler:(FBSDKGraphRequestHandler)handler;

Declared In: FBSDKGraphRequest.h