| | |
| | | |
| | | @class FBSDKAccessToken; |
| | | |
| | | /*! |
| | | @abstract Represents a request to the Facebook Graph API. |
| | | /** |
| | | Represents a request to the Facebook Graph API. |
| | | |
| | | @discussion `FBSDKGraphRequest` encapsulates the components of a request (the |
| | | |
| | | `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. |
| | | |
| | |
| | | |
| | | By default, FBSDKGraphRequest will attempt to recover any errors returned from |
| | | Facebook. You can disable this via `disableErrorRecovery:`. |
| | | @see FBSDKGraphErrorRecoveryProcessor |
| | | |
| | | - See:FBSDKGraphErrorRecoveryProcessor |
| | | */ |
| | | @interface FBSDKGraphRequest : NSObject |
| | | |
| | | /*! |
| | | @abstract Initializes a new instance that use use `[FBSDKAccessToken currentAccessToken]`. |
| | | @param graphPath the graph path (e.g., @"me"). |
| | | @param parameters the optional parameters dictionary. |
| | | /** |
| | | 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; |
| | | |
| | | /*! |
| | | @abstract Initializes a new instance that use use `[FBSDKAccessToken currentAccessToken]`. |
| | | @param graphPath the graph path (e.g., @"me"). |
| | | @param parameters the optional parameters dictionary. |
| | | @param HTTPMethod the optional HTTP method. nil defaults to @"GET". |
| | | /** |
| | | 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; |
| | | |
| | | /*! |
| | | @abstract Initializes a new instance. |
| | | @param graphPath the graph path (e.g., @"me"). |
| | | @param parameters the optional parameters dictionary. |
| | | @param tokenString the token string to use. Specifying nil will cause no token to be used. |
| | | @param version the optional Graph API version (e.g., @"v2.0"). nil defaults to FBSDK_TARGET_PLATFORM_VERSION. |
| | | @param HTTPMethod the optional HTTP method (e.g., @"POST"). nil defaults to @"GET". |
| | | /** |
| | | 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 |
| | |
| | | HTTPMethod:(NSString *)HTTPMethod |
| | | NS_DESIGNATED_INITIALIZER; |
| | | |
| | | /*! |
| | | @abstract The request parameters. |
| | | /** |
| | | The request parameters. |
| | | */ |
| | | @property (nonatomic, strong, readonly) NSMutableDictionary *parameters; |
| | | |
| | | /*! |
| | | @abstract The access token string used by the request. |
| | | /** |
| | | The access token string used by the request. |
| | | */ |
| | | @property (nonatomic, copy, readonly) NSString *tokenString; |
| | | |
| | | /*! |
| | | @abstract The Graph API endpoint to use for the request, for example "me". |
| | | /** |
| | | The Graph API endpoint to use for the request, for example "me". |
| | | */ |
| | | @property (nonatomic, copy, readonly) NSString *graphPath; |
| | | |
| | | /*! |
| | | @abstract The HTTPMethod to use for the request, for example "GET" or "POST". |
| | | /** |
| | | The HTTPMethod to use for the request, for example "GET" or "POST". |
| | | */ |
| | | @property (nonatomic, copy, readonly) NSString *HTTPMethod; |
| | | |
| | | /*! |
| | | @abstract The Graph API version to use (e.g., "v2.0") |
| | | /** |
| | | The Graph API version to use (e.g., "v2.0") |
| | | */ |
| | | @property (nonatomic, copy, readonly) NSString *version; |
| | | |
| | | /*! |
| | | @abstract If set, disables the automatic error recovery mechanism. |
| | | @param disable whether to disable the automatic error recovery mechanism |
| | | @discussion By default, non-batched FBSDKGraphRequest instances will automatically try to recover |
| | | /** |
| | | If set, disables the automatic error recovery mechanism. |
| | | - Parameter disable: whether to disable the automatic error recovery mechanism |
| | | |
| | | 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. |
| | |
| | | */ |
| | | - (void)setGraphErrorRecoveryDisabled:(BOOL)disable; |
| | | |
| | | /*! |
| | | @abstract Starts a connection to the Graph API. |
| | | @param handler The handler block to call when the request completes. |
| | | /** |
| | | Starts a connection to the Graph API. |
| | | - Parameter handler: The handler block to call when the request completes. |
| | | */ |
| | | - (FBSDKGraphRequestConnection *)startWithCompletionHandler:(FBSDKGraphRequestHandler)handler; |
| | | |