FBSDKGraphRequest Class Reference
Inherits from | NSObject |
Declared in | FBSDKGraphRequest.h |
Overview
Represents a request to the Facebook Graph API.
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:
.
- See:FBSDKGraphErrorRecoveryProcessor
Properties
HTTPMethod
The HTTPMethod to use for the request, for example “GET” or “POST”.
@property (nonatomic, copy, readonly) NSString *HTTPMethod
Declared In
FBSDKGraphRequest.h
graphPath
The Graph API endpoint to use for the request, for example “me”.
@property (nonatomic, copy, readonly) NSString *graphPath
Declared In
FBSDKGraphRequest.h
parameters
The request parameters.
@property (nonatomic, strong, readonly) NSMutableDictionary *parameters
Declared In
FBSDKGraphRequest.h
Instance Methods
initWithGraphPath:parameters:
Initializes a new instance that use use [FBSDKAccessToken currentAccessToken]
.
- Parameter graphPath: the graph path (e.g., @“me”).
- Parameter 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 graphPath: the graph path (e.g., @“me”).
- Parameter parameters: the optional parameters dictionary.
- Parameter 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 graphPath: the graph path (e.g., @“me”).
- Parameter parameters: the optional parameters dictionary.
- Parameter tokenString: the token string to use. Specifying nil will cause no token to be used.
- Parameter version: the optional Graph API version (e.g., @“v2.0”). nil defaults to [FBSDKSettings graphAPIVersion]
.
- Parameter 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
Declared In
FBSDKGraphRequest.h
setGraphErrorRecoveryDisabled:
If set, disables the automatic error recovery mechanism. - Parameter 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