public static final int MAXIMUM_BATCH_SIZE

The maximum number of requests that can be submitted in a single batch. This limit is enforced on the service side by the Facebook platform, not by the Request class.

public GraphRequest()

Constructs a request without an access token, graph path, or any other parameters.

public GraphRequest(AccessToken accessToken,
                    java.lang.String graphPath)

Constructs a request with an access token to retrieve a particular graph path. An access token need not be provided, in which case the request is sent without an access token and thus is not executed in the context of any particular user. Only certain graph requests can be expected to succeed in this case.

public GraphRequest(AccessToken accessToken,
                    java.lang.String graphPath,
                    Bundle parameters,
                    HttpMethod httpMethod)

Constructs a request with a specific AccessToken, graph path, parameters, and HTTP method. An access token need not be provided, in which case the request is sent without an access token and thus is not executed in the context of any particular user. Only certain graph requests can be expected to succeed in this case. Depending on the httpMethod parameter, the object at the graph path may be retrieved, created, or deleted.

public GraphRequest(AccessToken accessToken,
                    java.lang.String graphPath,
                    Bundle parameters,
                    HttpMethod httpMethod,
                    GraphRequest.Callback callback)

Constructs a request with a specific access token, graph path, parameters, and HTTP method. An access token need not be provided, in which case the request is sent without an access token and thus is not executed in the context of any particular user. Only certain graph requests can be expected to succeed in this case. Depending on the httpMethod parameter, the object at the graph path may be retrieved, created, or deleted.

public static GraphRequest newDeleteObjectRequest(AccessToken accessToken,
                                                  java.lang.String id,
                                                  GraphRequest.Callback callback)

Creates a new Request configured to delete a resource through the Graph API.

public static GraphRequest newMeRequest(AccessToken accessToken,
                                        GraphRequest.GraphJSONObjectCallback callback)

Creates a new Request configured to retrieve a user's own profile.

public static GraphRequest newPostRequest(AccessToken accessToken,
                                          java.lang.String graphPath,
                                          JSONObject graphObject,
                                          GraphRequest.Callback callback)

Creates a new Request configured to post a GraphObject to a particular graph path, to either create or update the object at that path.

public static GraphRequest newMyFriendsRequest(AccessToken accessToken,
                                               GraphRequest.GraphJSONArrayCallback callback)

Creates a new Request configured to retrieve a user's friend list.

public static GraphRequest newGraphPathRequest(AccessToken accessToken,
                                               java.lang.String graphPath,
                                               GraphRequest.Callback callback)

Creates a new Request configured to retrieve a particular graph path.

public static GraphRequest newPlacesSearchRequest(AccessToken accessToken,
                                                  Location location,
                                                  int radiusInMeters,
                                                  int resultsLimit,
                                                  java.lang.String searchText,
                                                  GraphRequest.GraphJSONArrayCallback callback)

Creates a new Request that is configured to perform a search for places near a specified location via the Graph API. At least one of location or searchText must be specified.

public static GraphRequest newUploadPhotoRequest(AccessToken accessToken,
                                                 java.lang.String graphPath,
                                                 Bitmap image,
                                                 java.lang.String caption,
                                                 Bundle params,
                                                 GraphRequest.Callback callback)

Creates a new Request configured to upload a photo to the specified graph path.

public static GraphRequest newUploadPhotoRequest(AccessToken accessToken,
                                                 java.lang.String graphPath,
                                                 java.io.File file,
                                                 java.lang.String caption,
                                                 Bundle params,
                                                 GraphRequest.Callback callback)
                                          throws java.io.FileNotFoundException

Creates a new Request configured to upload a photo to the specified graph path. The photo will be read from the specified file.

public static GraphRequest newUploadPhotoRequest(AccessToken accessToken,
                                                 java.lang.String graphPath,
                                                 Uri photoUri,
                                                 java.lang.String caption,
                                                 Bundle params,
                                                 GraphRequest.Callback callback)
                                          throws java.io.FileNotFoundException

Creates a new Request configured to upload a photo to the specified graph path. The photo will be read from the specified Uri.

public static GraphRequest newCustomAudienceThirdPartyIdRequest(AccessToken accessToken,
                                                                Context context,
                                                                java.lang.String applicationId,
                                                                GraphRequest.Callback callback)

Creates a new Request configured to retrieve an App User ID for the app's Facebook user. Callers will send this ID back to their own servers, collect up a set to create a Facebook Custom Audience with, and then use the resultant Custom Audience to target ads. The GraphObject in the response will include a "custom_audience_third_party_id" property, with the value being the ID retrieved. This ID is an encrypted encoding of the Facebook user's ID and the invoking Facebook app ID. Multiple calls with the same user will return different IDs, thus these IDs cannot be used to correlate behavior across devices or applications, and are only meaningful when sent back to Facebook for creating Custom Audiences. The ID retrieved represents the Facebook user identified in the following way: if the specified access token (or active access token if `null`) is valid, the ID will represent the user associated with the active access token; otherwise the ID will represent the user logged into the native Facebook app on the device. A `null` ID will be provided into the callback if a) there is no native Facebook app, b) no one is logged into it, or c) the app has previously called FacebookSdk#setLimitEventAndDataUsage(android.content.Context, boolean) ;} with `true` for this user. You must call this method from a background thread for it to work properly.

public static GraphRequest newCustomAudienceThirdPartyIdRequest(AccessToken accessToken,
                                                                Context context,
                                                                GraphRequest.Callback callback)

Creates a new Request configured to retrieve an App User ID for the app's Facebook user. Callers will send this ID back to their own servers, collect up a set to create a Facebook Custom Audience with, and then use the resultant Custom Audience to target ads. The GraphObject in the response will include a "custom_audience_third_party_id" property, with the value being the ID retrieved. This ID is an encrypted encoding of the Facebook user's ID and the invoking Facebook app ID. Multiple calls with the same user will return different IDs, thus these IDs cannot be used to correlate behavior across devices or applications, and are only meaningful when sent back to Facebook for creating Custom Audiences. The ID retrieved represents the Facebook user identified in the following way: if the specified access token (or active access token if `null`) is valid, the ID will represent the user associated with the active access token; otherwise the ID will represent the user logged into the native Facebook app on the device. A `null` ID will be provided into the callback if a) there is no native Facebook app, b) no one is logged into it, or c) the app has previously called FacebookSdk#setLimitEventAndDataUsage(android.content.Context, boolean) with `true` for this user. You must call this method from a background thread for it to work properly.

public final JSONObject getGraphObject()

Returns the GraphObject, if any, associated with this request.

public final void setGraphObject(JSONObject graphObject)

Sets the GraphObject associated with this request. This is meaningful only for POST requests.

public final java.lang.String getGraphPath()

Returns the graph path of this request, if any.

public final void setGraphPath(java.lang.String graphPath)

Sets the graph path of this request.

public final HttpMethod getHttpMethod()

Returns the HttpMethod to use for this request.

public final void setHttpMethod(HttpMethod httpMethod)

Sets the HttpMethod to use for this request.

public final java.lang.String getVersion()

Returns the version of the API that this request will use. By default this is the current API at the time the SDK is released.

public final void setVersion(java.lang.String version)

Set the version to use for this request. By default the version will be the current API at the time the SDK is released. Only use this if you need to explicitly override.

public final void setSkipClientToken(boolean skipClientToken)

This is an internal function that is not meant to be used by developers.

public final Bundle getParameters()

Returns the parameters for this request.

public final void setParameters(Bundle parameters)

Sets the parameters for this request.

public final AccessToken getAccessToken()

Returns the access token associated with this request.

public final void setAccessToken(AccessToken accessToken)

Sets the access token to use for this request.

public final java.lang.String getBatchEntryName()

Returns the name of this requests entry in a batched request.

public final void setBatchEntryName(java.lang.String batchEntryName)

Sets the name of this request's entry in a batched request. This value is only used if this request is submitted as part of a batched request. It can be used to specified dependencies between requests. See Batch Requests in the Graph API documentation for more details.

public final java.lang.String getBatchEntryDependsOn()

Returns the name of the request that this request entry explicitly depends on in a batched request.

public final void setBatchEntryDependsOn(java.lang.String batchEntryDependsOn)

Sets the name of the request entry that this request explicitly depends on in a batched request. This value is only used if this request is submitted as part of a batched request. It can be used to specified dependencies between requests. See Batch Requests in the Graph API documentation for more details.

public final boolean getBatchEntryOmitResultOnSuccess()

Returns whether or not this batch entry will return a response if it is successful. Only applies if another request entry in the batch specifies this entry as a dependency.

public final void setBatchEntryOmitResultOnSuccess(boolean batchEntryOmitResultOnSuccess)

Sets whether or not this batch entry will return a response if it is successful. Only applies if another request entry in the batch specifies this entry as a dependency. See Batch Requests in the Graph API documentation for more details.

public static final java.lang.String getDefaultBatchApplicationId()

Gets the default Facebook application ID that will be used to submit batched requests. Batched requests require an application ID, so either at least one request in a batch must provide an access token or the application ID must be specified explicitly.

public static final void setDefaultBatchApplicationId(java.lang.String applicationId)

Sets the default application ID that will be used to submit batched requests if none of those requests specifies an access token. Batched requests require an application ID, so either at least one request in a batch must specify an access token or the application ID must be specified explicitly.

public final GraphRequest.Callback getCallback()

Returns the callback which will be called when the request finishes.

public final void setCallback(GraphRequest.Callback callback)

Sets the callback which will be called when the request finishes.

public final void setTag(java.lang.Object tag)

Sets the tag on the request; this is an application-defined object that can be used to distinguish between different requests. Its value has no effect on the execution of the request.

public final java.lang.Object getTag()

Gets the tag on the request; this is an application-defined object that can be used to distinguish between different requests. Its value has no effect on the execution of the request.

public final GraphResponse executeAndWait()

Executes this request on the current thread and blocks while waiting for the response. This should only be called if you have transitioned off the UI thread.

public final GraphRequestAsyncTask executeAsync()

Executes the request asynchronously. This function will return immediately, and the request will be processed on a separate thread. In order to process result of a request, or determine whether a request succeeded or failed, a callback must be specified (see the setCallback method). This should only be called from the UI thread.

public static java.net.HttpURLConnection toHttpConnection(GraphRequest... requests)

Serializes one or more requests but does not execute them. The resulting HttpURLConnection can be executed explicitly by the caller.

public static java.net.HttpURLConnection toHttpConnection(java.util.Collection<GraphRequest> requests)

Serializes one or more requests but does not execute them. The resulting HttpURLConnection can be executed explicitly by the caller.

public static java.net.HttpURLConnection toHttpConnection(GraphRequestBatch requests)

Serializes one or more requests but does not execute them. The resulting HttpURLConnection can be executed explicitly by the caller.

public static GraphResponse executeAndWait(GraphRequest request)

Executes a single request on the current thread and blocks while waiting for the response. This should only be used if you have transitioned off the UI thread.

public static java.util.List<GraphResponse> executeBatchAndWait(GraphRequest... requests)

Executes requests on the current thread as a single batch and blocks while waiting for the response. This should only be used if you have transitioned off the UI thread.

public static java.util.List<GraphResponse> executeBatchAndWait(java.util.Collection<GraphRequest> requests)

Executes requests as a single batch on the current thread and blocks while waiting for the responses. This should only be used if you have transitioned off the UI thread.

public static java.util.List<GraphResponse> executeBatchAndWait(GraphRequestBatch requests)

Executes requests on the current thread as a single batch and blocks while waiting for the responses. This should only be used if you have transitioned off the UI thread.

public static GraphRequestAsyncTask executeBatchAsync(GraphRequest... requests)

Executes requests as a single batch asynchronously. This function will return immediately, and the requests will be processed on a separate thread. In order to process results of a request, or determine whether a request succeeded or failed, a callback must be specified (see the setCallback method). This should only be called from the UI thread.

public static GraphRequestAsyncTask executeBatchAsync(java.util.Collection<GraphRequest> requests)

Executes requests as a single batch asynchronously. This function will return immediately, and the requests will be processed on a separate thread. In order to process results of a request, or determine whether a request succeeded or failed, a callback must be specified (see the setCallback method). This should only be called from the UI thread.

public static GraphRequestAsyncTask executeBatchAsync(GraphRequestBatch requests)

Executes requests as a single batch asynchronously. This function will return immediately, and the requests will be processed on a separate thread. In order to process results of a request, or determine whether a request succeeded or failed, a callback must be specified (see the setCallback method). This should only be called from the UI thread.

public static java.util.List<GraphResponse> executeConnectionAndWait(java.net.HttpURLConnection connection,
                                                                     java.util.Collection<GraphRequest> requests)

Executes requests that have already been serialized into an HttpURLConnection. No validation is done that the contents of the connection actually reflect the serialized requests, so it is the caller's responsibility to ensure that it will correctly generate the desired responses. This should only be called if you have transitioned off the UI thread.

public static java.util.List<GraphResponse> executeConnectionAndWait(java.net.HttpURLConnection connection,
                                                                     GraphRequestBatch requests)

Executes requests that have already been serialized into an HttpURLConnection. No validation is done that the contents of the connection actually reflect the serialized requests, so it is the caller's responsibility to ensure that it will correctly generate the desired responses. This should only be called if you have transitioned off the UI thread.

public static GraphRequestAsyncTask executeConnectionAsync(java.net.HttpURLConnection connection,
                                                           GraphRequestBatch requests)

Asynchronously executes requests that have already been serialized into an HttpURLConnection. No validation is done that the contents of the connection actually reflect the serialized requests, so it is the caller's responsibility to ensure that it will correctly generate the desired responses. This function will return immediately, and the requests will be processed on a separate thread. In order to process results of a request, or determine whether a request succeeded or failed, a callback must be specified (see the setCallback method). This should only be called from the UI thread.

public static GraphRequestAsyncTask executeConnectionAsync(Handler callbackHandler,
                                                           java.net.HttpURLConnection connection,
                                                           GraphRequestBatch requests)

Asynchronously executes requests that have already been serialized into an HttpURLConnection. No validation is done that the contents of the connection actually reflect the serialized requests, so it is the caller's responsibility to ensure that it will correctly generate the desired responses. This function will return immediately, and the requests will be processed on a separate thread. In order to process results of a request, or determine whether a request succeeded or failed, a callback must be specified (see the setCallback method) This should only be called from the UI thread.