From afd70759b9bf1bd99c9a5f3578ce2c5474090340 Mon Sep 17 00:00:00 2001 From: Wuyx <1139965056@qq.com> Date: Tue, 17 Jan 2017 12:12:30 +0800 Subject: [PATCH] WAFbImpl --- frameworks/FBSDKCoreKit.framework/Headers/FBSDKGraphRequestConnection.h | 194 ++++++++++++++++++++++++------------------------ 1 files changed, 96 insertions(+), 98 deletions(-) diff --git a/frameworks/FBSDKCoreKit.framework/Headers/FBSDKGraphRequestConnection.h b/frameworks/FBSDKCoreKit.framework/Headers/FBSDKGraphRequestConnection.h index 79ffb3f..3eca584 100644 --- a/frameworks/FBSDKCoreKit.framework/Headers/FBSDKGraphRequestConnection.h +++ b/frameworks/FBSDKCoreKit.framework/Headers/FBSDKGraphRequestConnection.h @@ -23,108 +23,107 @@ @class FBSDKGraphRequest; @class FBSDKGraphRequestConnection; -/*! - @typedef FBSDKGraphRequestHandler +/** + FBSDKGraphRequestHandler - @abstract - A block that is passed to addRequest to register for a callback with the results of that + A block that is passed to addRequest to register for a callback with the results of that request once the connection completes. - @discussion + + Pass a block of this type when calling addRequest. This will be called once the request completes. The call occurs on the UI thread. - @param connection The `FBSDKGraphRequestConnection` that sent the request. + - Parameter connection: The `FBSDKGraphRequestConnection` that sent the request. - @param result The result of the request. This is a translation of + - Parameter result: The result of the request. This is a translation of JSON data to `NSDictionary` and `NSArray` objects. This is nil if there was an error. - @param error The `NSError` representing any error that occurred. + - Parameter error: The `NSError` representing any error that occurred. */ typedef void (^FBSDKGraphRequestHandler)(FBSDKGraphRequestConnection *connection, id result, NSError *error); -/*! +/** @protocol - @abstract - The `FBSDKGraphRequestConnectionDelegate` protocol defines the methods used to receive network + The `FBSDKGraphRequestConnectionDelegate` protocol defines the methods used to receive network activity progress information from a <FBSDKGraphRequestConnection>. */ @protocol FBSDKGraphRequestConnectionDelegate <NSObject> @optional -/*! +/** @method - @abstract - Tells the delegate the request connection will begin loading + Tells the delegate the request connection will begin loading - @discussion + + If the <FBSDKGraphRequestConnection> is created using one of the convenience factory methods prefixed with start, the object returned from the convenience method has already begun loading and this method will not be called when the delegate is set. - @param connection The request connection that is starting a network request + - Parameter connection: The request connection that is starting a network request */ - (void)requestConnectionWillBeginLoading:(FBSDKGraphRequestConnection *)connection; -/*! +/** @method - @abstract - Tells the delegate the request connection finished loading + Tells the delegate the request connection finished loading - @discussion - If the request connection completes without a network error occuring then this method is called. + + + If the request connection completes without a network error occurring then this method is called. Invocation of this method does not indicate success of every <FBSDKGraphRequest> made, only that the request connection has no further activity. Use the error argument passed to the FBSDKGraphRequestHandler block to determine success or failure of each <FBSDKGraphRequest>. This method is invoked after the completion handler for each <FBSDKGraphRequest>. - @param connection The request connection that successfully completed a network request + - Parameter connection: The request connection that successfully completed a network request */ - (void)requestConnectionDidFinishLoading:(FBSDKGraphRequestConnection *)connection; -/*! +/** @method - @abstract - Tells the delegate the request connection failed with an error + Tells the delegate the request connection failed with an error - @discussion + + If the request connection fails with a network error then this method is called. The `error` argument specifies why the network connection failed. The `NSError` object passed to the FBSDKGraphRequestHandler block may contain additional information. - @param connection The request connection that successfully completed a network request - @param error The `NSError` representing the network error that occurred, if any. May be nil + - Parameter connection: The request connection that successfully completed a network request + - Parameter error: The `NSError` representing the network error that occurred, if any. May be nil in some circumstances. Consult the `NSError` for the <FBSDKGraphRequest> for reliable failure information. */ - (void)requestConnection:(FBSDKGraphRequestConnection *)connection didFailWithError:(NSError *)error; -/*! +/** @method - @abstract - Tells the delegate how much data has been sent and is planned to send to the remote host + Tells the delegate how much data has been sent and is planned to send to the remote host - @discussion + + The byte count arguments refer to the aggregated <FBSDKGraphRequest> objects, not a particular <FBSDKGraphRequest>. Like `NSURLConnection`, the values may change in unexpected ways if data needs to be resent. - @param connection The request connection transmitting data to a remote host - @param bytesWritten The number of bytes sent in the last transmission - @param totalBytesWritten The total number of bytes sent to the remote host - @param totalBytesExpectedToWrite The total number of bytes expected to send to the remote host + - Parameter connection: The request connection transmitting data to a remote host + - Parameter bytesWritten: The number of bytes sent in the last transmission + - Parameter totalBytesWritten: The total number of bytes sent to the remote host + - Parameter totalBytesExpectedToWrite: The total number of bytes expected to send to the remote host */ - (void)requestConnection:(FBSDKGraphRequestConnection *)connection didSendBodyData:(NSInteger)bytesWritten @@ -133,13 +132,12 @@ @end -/*! - @class FBSDKGraphRequestConnection +/** - @abstract - The `FBSDKGraphRequestConnection` represents a single connection to Facebook to service a request. + The `FBSDKGraphRequestConnection` represents a single connection to Facebook to service a request. - @discussion + + The request settings are encapsulated in a reusable <FBSDKGraphRequest> object. The `FBSDKGraphRequestConnection` object encapsulates the concerns of a single communication e.g. starting a connection, canceling a connection, or batching requests. @@ -147,22 +145,21 @@ */ @interface FBSDKGraphRequestConnection : NSObject -/*! - @abstract - The delegate object that receives updates. +/** + The delegate object that receives updates. */ -@property (nonatomic, assign) id<FBSDKGraphRequestConnectionDelegate> delegate; +@property (nonatomic, weak) id<FBSDKGraphRequestConnectionDelegate> delegate; -/*! - @abstract Gets or sets the timeout interval to wait for a response before giving up. +/** + Gets or sets the timeout interval to wait for a response before giving up. */ @property (nonatomic) NSTimeInterval timeout; -/*! - @abstract - The raw response that was returned from the server. (readonly) +/** + The raw response that was returned from the server. (readonly) - @discussion + + This property can be used to inspect HTTP headers that were returned from the server. @@ -171,57 +168,56 @@ */ @property (nonatomic, retain, readonly) NSHTTPURLResponse *URLResponse; -/*! +/** @methodgroup Class methods */ -/*! +/** @method - @abstract - This method sets the default timeout on all FBSDKGraphRequestConnection instances. Defaults to 60 seconds. + This method sets the default timeout on all FBSDKGraphRequestConnection instances. Defaults to 60 seconds. - @param defaultConnectionTimeout The timeout interval. + - Parameter defaultConnectionTimeout: The timeout interval. */ + (void)setDefaultConnectionTimeout:(NSTimeInterval)defaultConnectionTimeout; -/*! +/** @methodgroup Adding requests */ -/*! +/** @method - @abstract - This method adds an <FBSDKGraphRequest> object to this connection. + This method adds an <FBSDKGraphRequest> object to this connection. - @param request A request to be included in the round-trip when start is called. - @param handler A handler to call back when the round-trip completes or times out. + - Parameter request: A request to be included in the round-trip when start is called. + - Parameter handler: A handler to call back when the round-trip completes or times out. - @discussion + + The completion handler is retained until the block is called upon the completion or cancellation of the connection. */ - (void)addRequest:(FBSDKGraphRequest *)request completionHandler:(FBSDKGraphRequestHandler)handler; -/*! +/** @method - @abstract - This method adds an <FBSDKGraphRequest> object to this connection. + This method adds an <FBSDKGraphRequest> object to this connection. - @param request A request to be included in the round-trip when start is called. + - Parameter request: A request to be included in the round-trip when start is called. - @param handler A handler to call back when the round-trip completes or times out. + - Parameter handler: A handler to call back when the round-trip completes or times out. The handler will be invoked on the main thread. - @param name An optional name for this request. This can be used to feed + - Parameter name: An optional name for this request. This can be used to feed the results of one request to the input of another <FBSDKGraphRequest> in the same `FBSDKGraphRequestConnection` as described in [Graph API Batch Requests]( https://developers.facebook.com/docs/reference/api/batch/ ). - @discussion + + The completion handler is retained until the block is called upon the completion or cancellation of the connection. This request can be named to allow for using the request's response in a subsequent request. @@ -230,21 +226,21 @@ completionHandler:(FBSDKGraphRequestHandler)handler batchEntryName:(NSString *)name; -/*! +/** @method - @abstract - This method adds an <FBSDKGraphRequest> object to this connection. + This method adds an <FBSDKGraphRequest> object to this connection. - @param request A request to be included in the round-trip when start is called. + - Parameter request: A request to be included in the round-trip when start is called. - @param handler A handler to call back when the round-trip completes or times out. + - Parameter handler: A handler to call back when the round-trip completes or times out. - @param batchParameters The optional dictionary of parameters to include for this request + - Parameter batchParameters: The optional dictionary of parameters to include for this request as described in [Graph API Batch Requests]( https://developers.facebook.com/docs/reference/api/batch/ ). Examples include "depends_on", "name", or "omit_response_on_success". - @discussion + + The completion handler is retained until the block is called upon the completion or cancellation of the connection. This request can be named to allow for using the request's response in a subsequent request. @@ -253,18 +249,18 @@ completionHandler:(FBSDKGraphRequestHandler)handler batchParameters:(NSDictionary *)batchParameters; -/*! +/** @methodgroup Instance methods */ -/*! +/** @method - @abstract - Signals that a connection should be logically terminated as the + Signals that a connection should be logically terminated as the application is no longer interested in a response. - @discussion + + Synchronously calls any handlers indicating the request was cancelled. Cancel does not guarantee that the request-related processing will cease. It does promise that all handlers will complete before the cancel returns. A call to @@ -273,52 +269,54 @@ */ - (void)cancel; -/*! +/** @method - @abstract - This method starts a connection with the server and is capable of handling all of the + This method starts a connection with the server and is capable of handling all of the requests that were added to the connection. - @discussion By default, a connection is scheduled on the current thread in the default mode when it is created. + + By default, a connection is scheduled on the current thread in the default mode when it is created. See `setDelegateQueue:` for other options. This method cannot be called twice for an `FBSDKGraphRequestConnection` instance. */ - (void)start; -/*! - @abstract Determines the operation queue that is used to call methods on the connection's delegate. - @param queue The operation queue to use when calling delegate methods. - @discussion By default, a connection is scheduled on the current thread in the default mode when it is created. +/** + Determines the operation queue that is used to call methods on the connection's delegate. + - Parameter queue: The operation queue to use when calling delegate methods. + + By default, a connection is scheduled on the current thread in the default mode when it is created. You cannot reschedule a connection after it has started. This is very similar to `[NSURLConnection setDelegateQueue:]`. */ - (void)setDelegateQueue:(NSOperationQueue *)queue; -/*! +/** @method - @abstract - Overrides the default version for a batch request + Overrides the default version for a batch request - @discussion + + The SDK automatically prepends a version part, such as "v2.0" to API paths in order to simplify API versioning for applications. If you want to override the version part while using batch requests on the connection, call this method to set the version for the batch request. - @param version This is a string in the form @"v2.0" which will be used for the version part of an API path + - Parameter version: This is a string in the form @"v2.0" which will be used for the version part of an API path */ - (void)overrideVersionPartWith:(NSString *)version; @end -/*! - @abstract The key in the result dictionary for requests to old versions of the Graph API +/** + The key in the result dictionary for requests to old versions of the Graph API whose response is not a JSON object. - @discussion When a request returns a non-JSON response (such as a "true" literal), that response + + When a request returns a non-JSON response (such as a "true" literal), that response will be wrapped into a dictionary using this const as the key. This only applies for very few Graph API prior to v2.1. */ -- Gitblit v1.8.0