org.springframework.social.facebook.api

Interface GraphApi

All Known Subinterfaces:

Facebook

All Known Implementing Classes:

FacebookTemplate

public interface GraphApi

Defines low-level operations against Facebook's Graph API

Field Summary

Fields

Modifier and Type	Field and Description
static String	GRAPH_API_URL Deprecated. Use getBaseGraphApiUrl() instead.

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(String objectId) Deletes an object.
void	delete(String objectId, String connectionName) Deletes an object connection.
void	delete(String objectId, String connectionName, MultiValueMap<String,String> data) Deletes an object connection.
<T> PagedList<T>	fetchConnections(String objectId, String connectionName, Class<T> type, MultiValueMap<String,String> queryParameters) Fetches connections, extracting them into a collection of the given Java type Requires appropriate permission to fetch the object connection.
<T> PagedList<T>	fetchConnections(String objectId, String connectionName, Class<T> type, MultiValueMap<String,String> queryParameters, String... fields) Fetches connections, extracting them into a collection of the given Java type Requires appropriate permission to fetch the object connection.
<T> PagedList<T>	fetchConnections(String objectId, String connectionName, Class<T> type, String... fields) Fetches connections, extracting them into a collection of the given Java type Requires appropriate permission to fetch the object connection.
byte[]	fetchImage(String objectId, String connectionName, ImageType imageType) Fetches an image as an array of bytes.
byte[]	fetchImage(String objectId, String connectionName, Integer width, Integer height) Fetches an image as an array of bytes.
<T> T	fetchObject(String objectId, Class<T> type) Fetches an object, extracting it into the given Java type Requires appropriate permission to fetch the object.
<T> T	fetchObject(String objectId, Class<T> type, MultiValueMap<String,String> queryParameters) Fetches an object, extracting it into the given Java type Requires appropriate permission to fetch the object.
<T> T	fetchObject(String objectId, Class<T> type, String... fields) Fetches an object, extracting it into the given Java type Requires appropriate permission to fetch the object.
String	getApplicationNamespace()
String	getBaseGraphApiUrl()
void	post(String objectId, MultiValueMap<String,Object> data) Publishes data to an object.
void	post(String objectId, String connectionName, MultiValueMap<String,Object> data) Publishes data to an object's connection.
String	publish(String objectId, String connectionName, MultiValueMap<String,Object> data) Publishes data to an object's connection.

Field Detail

GRAPH_API_URL

@Deprecated
static final String GRAPH_API_URL

Deprecated. Use getBaseGraphApiUrl() instead.

See Also:

Constant Field Values

Method Detail

fetchObject

<T> T fetchObject(String objectId,
                Class<T> type)

Fetches an object, extracting it into the given Java type Requires appropriate permission to fetch the object.

Type Parameters:

T - The Java type to bind the Facebook object to

Parameters:

objectId - the Facebook object's ID

type - the Java type to fetch

Returns:

an Java object representing the requested Facebook object.

fetchObject

<T> T fetchObject(String objectId,
                Class<T> type,
                String... fields)

Fetches an object, extracting it into the given Java type Requires appropriate permission to fetch the object.

Type Parameters:

T - The Java type to bind the Facebook object to

Parameters:

objectId - the Facebook object's ID

type - the Java type to fetch

fields - the fields to include in the response.

Returns:

an Java object representing the requested Facebook object.

fetchObject

<T> T fetchObject(String objectId,
                Class<T> type,
                MultiValueMap<String,String> queryParameters)

Fetches an object, extracting it into the given Java type Requires appropriate permission to fetch the object.

Type Parameters:

T - The Java type to bind the Facebook object to

Parameters:

objectId - the Facebook object's ID

type - the Java type to fetch

queryParameters - query parameters to include in the request

Returns:

an Java object representing the requested Facebook object.

fetchConnections

<T> PagedList<T> fetchConnections(String objectId,
                                String connectionName,
                                Class<T> type,
                                String... fields)

Fetches connections, extracting them into a collection of the given Java type Requires appropriate permission to fetch the object connection.

Type Parameters:

T - The Java type to bind the Facebook object to

Parameters:

objectId - the ID of the object to retrieve the connections for.

connectionName - the connection name.

type - the Java type of each connection.

fields - the fields to include in the response.

Returns:

a list of Java objects representing the Facebook objects in the connections.

fetchConnections

<T> PagedList<T> fetchConnections(String objectId,
                                String connectionName,
                                Class<T> type,
                                MultiValueMap<String,String> queryParameters)

Fetches connections, extracting them into a collection of the given Java type Requires appropriate permission to fetch the object connection.

Type Parameters:

T - The Java type to bind the Facebook object to

Parameters:

objectId - the ID of the object to retrieve the connections for.

connectionName - the connection name.

type - the Java type of each connection.

queryParameters - query parameters to include in the request

Returns:

a list of Java objects representing the Facebook objects in the connections.

fetchConnections

<T> PagedList<T> fetchConnections(String objectId,
                                String connectionName,
                                Class<T> type,
                                MultiValueMap<String,String> queryParameters,
                                String... fields)

Fetches connections, extracting them into a collection of the given Java type Requires appropriate permission to fetch the object connection.

Type Parameters:

T - The Java type to bind the Facebook object to

Parameters:

objectId - the ID of the object to retrieve the connections for.

connectionName - the connection name.

type - the Java type of each connection.

queryParameters - query parameters to include in the request

fields - the fields to include in the response.

Returns:

a list of Java objects representing the Facebook objects in the connections.

fetchImage

byte[] fetchImage(String objectId,
                String connectionName,
                ImageType imageType)

Fetches an image as an array of bytes.

Parameters:

objectId - the object ID

connectionName - the connection name

imageType - the type of image to retrieve (eg., small, normal, large, or square)

Returns:

an image as an array of bytes.

fetchImage

byte[] fetchImage(String objectId,
                String connectionName,
                Integer width,
                Integer height)

Fetches an image as an array of bytes.

Parameters:

objectId - the object ID

connectionName - the connection name

width - desired width of the image (optional)

height - desired height of the image (optional)

Returns:

an image as an array of bytes.

publish

String publish(String objectId,
             String connectionName,
             MultiValueMap<String,Object> data)

Publishes data to an object's connection. Requires appropriate permission to publish to the object connection.

Parameters:

objectId - the object ID to publish to.

connectionName - the connection name to publish to.

data - the data to publish to the connection.

Returns:

the ID of the newly published object.

post

void post(String objectId,
        MultiValueMap<String,Object> data)

Publishes data to an object. Requires appropriate permission to publish to the object connection. This differs from publish() only in that it doesn't attempt to extract the ID from the response. This is because some publish operations do not return an ID in the response.

Parameters:

objectId - the object ID to publish to.

data - the data to publish to the object.

post

void post(String objectId,
        String connectionName,
        MultiValueMap<String,Object> data)

Publishes data to an object's connection. Requires appropriate permission to publish to the object connection. This differs from publish() only in that it doesn't attempt to extract the ID from the response. This is because some publish operations do not return an ID in the response.

Parameters:

objectId - the object ID to publish to.

connectionName - the connection name to publish to.

data - the data to publish to the connection.

delete

void delete(String objectId)

Deletes an object. Requires appropriate permission to delete the object.

Parameters:

objectId - the object ID

delete

void delete(String objectId,
          String connectionName)

Deletes an object connection. Requires appropriate permission to delete the object connection.

Parameters:

objectId - the object ID

connectionName - the connection name

delete

void delete(String objectId,
          String connectionName,
          MultiValueMap<String,String> data)

Deletes an object connection. Requires appropriate permission to delete the object connection.

Parameters:

objectId - the object ID

connectionName - the connection name

data - parameters for the delete request

getApplicationNamespace

String getApplicationNamespace()

Returns:

The application namespace associated with this GraphApi instance. Useful for interacting with Facebook's OpenGraph actions. May be null if no namespace was specified.

getBaseGraphApiUrl

String getBaseGraphApiUrl()

Returns:

The base URL for the Graph API.