// Copyright (c) 2014-present, Facebook, Inc. All rights reserved. // // You are hereby granted a non-exclusive, worldwide, royalty-free license to use, // copy, modify, and distribute this software in source code or binary form for use // in connection with the web services and APIs provided by Facebook. // // As with any software that integrates with the Facebook platform, your use of // this software is subject to the Facebook Developer Principles and Policies // [http://developers.facebook.com/policy/]. This copyright notice shall be // included in all copies or substantial portions of the software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS // FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR // COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #import #import @class FBSDKGraphRequest; @class FBSDKGraphRequestConnection; /*! @typedef FBSDKGraphRequestHandler @abstract 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. @param 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. */ typedef void (^FBSDKGraphRequestHandler)(FBSDKGraphRequestConnection *connection, id result, NSError *error); /*! @protocol @abstract The `FBSDKGraphRequestConnectionDelegate` protocol defines the methods used to receive network activity progress information from a . */ @protocol FBSDKGraphRequestConnectionDelegate @optional /*! @method @abstract Tells the delegate the request connection will begin loading @discussion If the 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 */ - (void)requestConnectionWillBeginLoading:(FBSDKGraphRequestConnection *)connection; /*! @method @abstract Tells the delegate the request connection finished loading @discussion If the request connection completes without a network error occuring then this method is called. Invocation of this method does not indicate success of every 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 . This method is invoked after the completion handler for each . @param 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 @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 in some circumstances. Consult the `NSError` for the 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 @discussion The byte count arguments refer to the aggregated objects, not a particular . 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 */ - (void)requestConnection:(FBSDKGraphRequestConnection *)connection didSendBodyData:(NSInteger)bytesWritten totalBytesWritten:(NSInteger)totalBytesWritten totalBytesExpectedToWrite:(NSInteger)totalBytesExpectedToWrite; @end /*! @class FBSDKGraphRequestConnection @abstract The `FBSDKGraphRequestConnection` represents a single connection to Facebook to service a request. @discussion The request settings are encapsulated in a reusable object. The `FBSDKGraphRequestConnection` object encapsulates the concerns of a single communication e.g. starting a connection, canceling a connection, or batching requests. */ @interface FBSDKGraphRequestConnection : NSObject /*! @abstract The delegate object that receives updates. */ @property (nonatomic, assign) id delegate; /*! @abstract 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) @discussion This property can be used to inspect HTTP headers that were returned from the server. The property is nil until the request completes. If there was a response then this property will be non-nil during the FBSDKGraphRequestHandler callback. */ @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. @param defaultConnectionTimeout The timeout interval. */ + (void)setDefaultConnectionTimeout:(NSTimeInterval)defaultConnectionTimeout; /*! @methodgroup Adding requests */ /*! @method @abstract This method adds an 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. @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 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. The handler will be invoked on the main thread. @param name An optional name for this request. This can be used to feed the results of one request to the input of another 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. */ - (void)addRequest:(FBSDKGraphRequest *)request completionHandler:(FBSDKGraphRequestHandler)handler batchEntryName:(NSString *)name; /*! @method @abstract This method adds an 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. @param 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. */ - (void)addRequest:(FBSDKGraphRequest *)request completionHandler:(FBSDKGraphRequestHandler)handler batchParameters:(NSDictionary *)batchParameters; /*! @methodgroup Instance methods */ /*! @method @abstract 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 cancel prior to a start implies a cancellation of all requests associated with the connection. */ - (void)cancel; /*! @method @abstract 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. 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. 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 @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 */ - (void)overrideVersionPartWith:(NSString *)version; @end /*! @abstract 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 will be wrapped into a dictionary using this const as the key. This only applies for very few Graph API prior to v2.1. */ FBSDK_EXTERN NSString *const FBSDKNonJSONResponseProperty;