lipengwei
2020-05-27 7cdaa24f3ba637804aca9247ae809c4cc1acc6ed
frameworks/FBSDKCoreKit.framework/Headers/FBSDKGraphRequest.h
@@ -20,12 +20,27 @@
#import <FBSDKCoreKit/FBSDKGraphRequestConnection.h>
NS_ASSUME_NONNULL_BEGIN
@class FBSDKAccessToken;
/*!
 @abstract Represents a request to the Facebook Graph API.
/// typedef for FBSDKHTTPMethod
typedef NSString *const FBSDKHTTPMethod NS_TYPED_EXTENSIBLE_ENUM NS_SWIFT_NAME(HTTPMethod);
 @discussion `FBSDKGraphRequest` encapsulates the components of a request (the
/// 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.
 `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.
@@ -37,84 +52,107 @@
 By default, FBSDKGraphRequest will attempt to recover any errors returned from
 Facebook. You can disable this via `disableErrorRecovery:`.
 @see FBSDKGraphErrorRecoveryProcessor
 */
NS_SWIFT_NAME(GraphRequest)
@interface FBSDKGraphRequest : NSObject
/*!
 @abstract Initializes a new instance that use use `[FBSDKAccessToken currentAccessToken]`.
- (instancetype)init NS_UNAVAILABLE;
+ (instancetype)new NS_UNAVAILABLE;
/**
 Initializes a new instance that use use `[FBSDKAccessToken currentAccessToken]`.
 @param graphPath the graph path (e.g., @"me").
 */
- (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
                       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.
 */
- (instancetype)initWithGraphPath:(NSString *)graphPath
                       parameters:(NSDictionary *)parameters;
                       parameters:(NSDictionary<NSString *, id> *)parameters;
/*!
 @abstract Initializes a new instance that use use `[FBSDKAccessToken currentAccessToken]`.
/**
  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".
 @param method the HTTP method. Empty String defaults to @"GET".
 */
- (instancetype)initWithGraphPath:(NSString *)graphPath
                       parameters:(NSDictionary *)parameters
                       HTTPMethod:(NSString *)HTTPMethod;
                       parameters:(NSDictionary<NSString *, id> *)parameters
                       HTTPMethod:(FBSDKHTTPMethod)method;
/*!
 @abstract Initializes a new instance.
/**
  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".
 @param version the optional Graph API version (e.g., @"v2.0"). nil defaults to `[FBSDKSettings graphAPIVersion]`.
 @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;
/*!
 @abstract The request parameters.
/**
  The request parameters.
 */
@property (nonatomic, strong, readonly) NSMutableDictionary *parameters;
@property (nonatomic, copy) NSDictionary<NSString *, id> *parameters;
/*!
 @abstract The access token string used by the request.
/**
  The access token string used by the request.
 */
@property (nonatomic, copy, readonly) NSString *tokenString;
@property (nonatomic, copy, readonly, nullable) 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;
@property (nonatomic, copy, readonly) FBSDKHTTPMethod 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.
/**
  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
 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:].
 */
- (void)setGraphErrorRecoveryDisabled:(BOOL)disable;
- (void)setGraphErrorRecoveryDisabled:(BOOL)disable
NS_SWIFT_NAME(setGraphErrorRecovery(disabled:));
/*!
 @abstract Starts a connection to the Graph API.
/**
  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