com.facebook

Class GraphResponse

java.lang.Object

com.facebook.GraphResponse

public class GraphResponse
extends java.lang.Object

Encapsulates the response, successful or otherwise, of a call to the Facebook platform.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphResponse.PagingDirection Indicates whether paging is being done forward or backward.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NON_JSON_RESPONSE_PROPERTY Property name of non-JSON results in the GraphObject.
static java.lang.String	SUCCESS_KEY

Constructor Summary

Constructors

Constructor and Description
GraphResponse(GraphRequest request, java.net.HttpURLConnection connection, FacebookRequestError error)
GraphResponse(GraphRequest request, java.net.HttpURLConnection connection, java.lang.String rawResponse, org.json.JSONArray graphObjects)
GraphResponse(GraphRequest request, java.net.HttpURLConnection connection, java.lang.String rawResponse, org.json.JSONObject graphObject)

Method Summary

Modifier and Type	Method and Description
java.net.HttpURLConnection	getConnection() Returns the HttpURLConnection that this response was generated from.
FacebookRequestError	getError() Returns information about any errors that may have occurred during the request.
org.json.JSONArray	getJSONArray() The response returned for this request, if it's in array form.
org.json.JSONObject	getJSONObject() The response returned for this request, if it's in object form.
java.lang.String	getRawResponse() Returns the server response as a String that this response is for.
GraphRequest	getRequest() Returns the request that this response is for.
GraphRequest	getRequestForPagedResults(GraphResponse.PagingDirection direction) If a Response contains results that contain paging information, returns a new Request that will retrieve the next page of results, in whichever direction is desired.
java.lang.String	toString() Provides a debugging string for this response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NON_JSON_RESPONSE_PROPERTY

public static final java.lang.String NON_JSON_RESPONSE_PROPERTY

Property name of non-JSON results in the GraphObject. Certain calls to Facebook result in a non-JSON response (e.g., the string literal "true" or "false"). To present a consistent way of accessing results, these are represented as a GraphObject with a single string property with this name.

See Also:

Constant Field Values

SUCCESS_KEY

public static final java.lang.String SUCCESS_KEY

See Also:

Constant Field Values

Constructor Detail

GraphResponse

public GraphResponse(GraphRequest request,
                     java.net.HttpURLConnection connection,
                     java.lang.String rawResponse,
                     org.json.JSONObject graphObject)

GraphResponse

public GraphResponse(GraphRequest request,
                     java.net.HttpURLConnection connection,
                     java.lang.String rawResponse,
                     org.json.JSONArray graphObjects)

GraphResponse

public GraphResponse(GraphRequest request,
                     java.net.HttpURLConnection connection,
                     FacebookRequestError error)

Method Detail

getError

public final FacebookRequestError getError()

Returns information about any errors that may have occurred during the request.

Returns:

the error from the server, or null if there was no server error

getJSONObject

public final org.json.JSONObject getJSONObject()

The response returned for this request, if it's in object form.

Returns:

the returned JSON object, or null if none was returned (or if the result was a JSON array)

getJSONArray

public final org.json.JSONArray getJSONArray()

The response returned for this request, if it's in array form.

Returns:

the returned JSON array, or null if none was returned (or if the result was a JSON object)

getConnection

public final java.net.HttpURLConnection getConnection()

Returns the HttpURLConnection that this response was generated from. If the response was retrieved from the cache, this will be null.

Returns:

the connection, or null

getRequest

public GraphRequest getRequest()

Returns the request that this response is for.

Returns:

the request that this response is for

getRawResponse

public java.lang.String getRawResponse()

Returns the server response as a String that this response is for.

Returns:

A String representation of the actual response from the server

getRequestForPagedResults

public GraphRequest getRequestForPagedResults(GraphResponse.PagingDirection direction)

If a Response contains results that contain paging information, returns a new Request that will retrieve the next page of results, in whichever direction is desired. If no paging information is available, returns null.

Parameters:

direction - enum indicating whether to page forward or backward

Returns:

a Request that will retrieve the next page of results in the desired direction, or null if no paging information is available

toString

public java.lang.String toString()

Provides a debugging string for this response.

Overrides:

toString in class java.lang.Object