| | |
| | | |
| | | #import <FBSDKCoreKit/FBSDKGraphRequestConnection.h> |
| | | |
| | | NS_ASSUME_NONNULL_BEGIN |
| | | |
| | | @class FBSDKAccessToken; |
| | | |
| | | /// typedef for FBSDKHTTPMethod |
| | | typedef NSString *const FBSDKHTTPMethod NS_TYPED_EXTENSIBLE_ENUM NS_SWIFT_NAME(HTTPMethod); |
| | | |
| | | /// GET Request |
| | | FOUNDATION_EXPORT FBSDKHTTPMethod FBSDKHTTPMethodGET NS_SWIFT_NAME(get); |
| | | |
| | | /// POST Request |
| | | FOUNDATION_EXPORT FBSDKHTTPMethod FBSDKHTTPMethodPOST NS_SWIFT_NAME(post); |
| | | |
| | | /// DELETE Request |
| | | FOUNDATION_EXPORT FBSDKHTTPMethod FBSDKHTTPMethodDELETE NS_SWIFT_NAME(delete); |
| | | |
| | | /** |
| | | Represents a request to the Facebook Graph API. |
| | |
| | | |
| | | @see FBSDKGraphErrorRecoveryProcessor |
| | | */ |
| | | NS_SWIFT_NAME(GraphRequest) |
| | | @interface FBSDKGraphRequest : NSObject |
| | | |
| | | - (instancetype)init NS_UNAVAILABLE; |
| | |
| | | /** |
| | | Initializes a new instance that use use `[FBSDKAccessToken currentAccessToken]`. |
| | | @param graphPath the graph path (e.g., @"me"). |
| | | @param parameters the optional parameters dictionary. |
| | | */ |
| | | - (instancetype)initWithGraphPath:(NSString *)graphPath; |
| | | |
| | | /** |
| | | Initializes a new instance that use use `[FBSDKAccessToken currentAccessToken]`. |
| | | @param graphPath the graph path (e.g., @"me"). |
| | | @param method the HTTP method. Empty String defaults to @"GET". |
| | | */ |
| | | - (instancetype)initWithGraphPath:(NSString *)graphPath |
| | | parameters:(NSDictionary *)parameters; |
| | | HTTPMethod:(FBSDKHTTPMethod)method; |
| | | |
| | | /** |
| | | 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". |
| | | */ |
| | | - (instancetype)initWithGraphPath:(NSString *)graphPath |
| | | parameters:(NSDictionary *)parameters |
| | | HTTPMethod:(NSString *)HTTPMethod; |
| | | parameters:(NSDictionary<NSString *, id> *)parameters; |
| | | |
| | | /** |
| | | Initializes a new instance that use use `[FBSDKAccessToken currentAccessToken]`. |
| | | @param graphPath the graph path (e.g., @"me"). |
| | | @param parameters the optional parameters dictionary. |
| | | @param method the HTTP method. Empty String defaults to @"GET". |
| | | */ |
| | | - (instancetype)initWithGraphPath:(NSString *)graphPath |
| | | parameters:(NSDictionary<NSString *, id> *)parameters |
| | | HTTPMethod:(FBSDKHTTPMethod)method; |
| | | |
| | | /** |
| | | Initializes a new instance. |
| | |
| | | @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 `[FBSDKSettings graphAPIVersion]`. |
| | | @param HTTPMethod the optional HTTP method (e.g., @"POST"). nil defaults to @"GET". |
| | | @param method the HTTP method. Empty String defaults to @"GET". |
| | | */ |
| | | - (instancetype)initWithGraphPath:(NSString *)graphPath |
| | | parameters:(NSDictionary *)parameters |
| | | tokenString:(NSString *)tokenString |
| | | version:(NSString *)version |
| | | HTTPMethod:(NSString *)HTTPMethod |
| | | parameters:(NSDictionary<NSString *, id> *)parameters |
| | | tokenString:(nullable NSString *)tokenString |
| | | version:(nullable NSString *)version |
| | | HTTPMethod:(FBSDKHTTPMethod)method |
| | | NS_DESIGNATED_INITIALIZER; |
| | | |
| | | /** |
| | | The request parameters. |
| | | */ |
| | | @property (nonatomic, strong, readonly) NSMutableDictionary *parameters; |
| | | @property (nonatomic, copy) NSDictionary<NSString *, id> *parameters; |
| | | |
| | | /** |
| | | The access token string used by the request. |
| | | */ |
| | | @property (nonatomic, copy, readonly) NSString *tokenString; |
| | | @property (nonatomic, copy, readonly, nullable) NSString *tokenString; |
| | | |
| | | /** |
| | | The Graph API endpoint to use for the request, for example "me". |
| | |
| | | /** |
| | | The HTTPMethod to use for the request, for example "GET" or "POST". |
| | | */ |
| | | @property (nonatomic, copy, readonly) NSString *HTTPMethod; |
| | | @property (nonatomic, copy, readonly) FBSDKHTTPMethod HTTPMethod; |
| | | |
| | | /** |
| | | The Graph API version to use (e.g., "v2.0") |
| | |
| | | |
| | | This will override [FBSDKSettings setGraphErrorRecoveryDisabled:]. |
| | | */ |
| | | - (void)setGraphErrorRecoveryDisabled:(BOOL)disable; |
| | | - (void)setGraphErrorRecoveryDisabled:(BOOL)disable |
| | | NS_SWIFT_NAME(setGraphErrorRecovery(disabled:)); |
| | | |
| | | /** |
| | | Starts a connection to the Graph API. |
| | | @param handler The handler block to call when the request completes. |
| | | */ |
| | | - (FBSDKGraphRequestConnection *)startWithCompletionHandler:(FBSDKGraphRequestHandler)handler; |
| | | - (FBSDKGraphRequestConnection *)startWithCompletionHandler:(nullable FBSDKGraphRequestBlock)handler; |
| | | |
| | | @end |
| | | |
| | | NS_ASSUME_NONNULL_END |