org.springframework.social.facebook.api

Interface PageOperations

public interface PageOperations

Interface defining operations that can be performed on a Facebook pages.

Method Summary

Methods

Modifier and Type	Method and Description
Facebook	facebookOperations(String pageId) Returns a Facebook instance that will act on behalf of the given page.
String	getAccessToken(String pageId) Returns the access token for a given page.
Account	getAccount(String pageId) Returns an Account object for the user's access to the given page.
PagedList<Account>	getAccounts() Retrieves a list of Account objects for the pages that the authenticated user is an administrator.
Page	getPage(String pageId) Retrieves data for a page.
boolean	isPageAdmin(String pageId) Checks whether the logged-in user for this session is an admin of the page with the given page ID.
String	post(PagePostData post) Posts to a page's feed as a page administrator.
String	post(String pageId, String message) Deprecated. Use PostData instead.
String	post(String pageId, String message, FacebookLink link) Deprecated. Use PostData instead.
String	postPhoto(String pageId, String albumId, Resource photo) Posts a photo to a page's album as the page administrator.
String	postPhoto(String pageId, String albumId, Resource photo, String caption) Posts a photo to a page's album as the page administrator.
PagedList<Page>	search(String query) Searches for pages that match a given query.
PagedList<Page>	searchPlaces(String query, double latitude, double longitude, long distance) Searches for places near a given coordinate.
void	updatePage(PageUpdate pageUpdate) Updates page information.

Method Detail

getPage

Page getPage(String pageId)

Retrieves data for a page.

Parameters:

pageId - the page ID.

Returns:

a Page

updatePage

void updatePage(PageUpdate pageUpdate)

Updates page information. Requires that the application is granted "manage_pages" permission and that the authenticated user be an administrator of the page.

Parameters:

pageUpdate - a PageUpdate object that carries the fields to update on the page.

isPageAdmin

boolean isPageAdmin(String pageId)

Checks whether the logged-in user for this session is an admin of the page with the given page ID. Requires "manage_pages" permission.

Parameters:

pageId - the page ID

Returns:

true if the authenticated user is an admin of the specified page.

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

org.springframework.social.InsufficientPermissionException - if the user has not granted "manage_pages" permission.

org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.

getAccounts

PagedList<Account> getAccounts()

Retrieves a list of Account objects for the pages that the authenticated user is an administrator. Requires "manage_pages" permission.

Returns:

a paged list of accounts

post

@Deprecated
String post(String pageId,
                     String message)

Deprecated. Use PostData instead.

Posts a message to a page's feed as a page administrator. Requires that the application is granted "manage_pages" permission and that the authenticated user be an administrator of the page. To post to the page's feed as the authenticated user, use FeedOperations.post(String, String) instead.

Parameters:

pageId - the page ID

message - the message to post

Returns:

the ID of the new feed entry

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

org.springframework.social.InsufficientPermissionException - if the user has not granted "manage_pages" permission.

PageAdministrationException - if the user is not a page administrator.

org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.

post

@Deprecated
String post(String pageId,
                     String message,
                     FacebookLink link)

Deprecated. Use PostData instead.

Posts a link to the page's feed as a page administrator. Requires that the application is granted "manage_pages" permission and that the authenticated user be an administrator of the page. To post a link to the page's feed as the authenticated user, use FeedOperations.postLink(String, String, FacebookLink) instead.

Parameters:

pageId - the page ID

message - a message to send with the link.

link - the link details

Returns:

the ID of the new feed entry.

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

org.springframework.social.InsufficientPermissionException - if the user has not granted "manage_pages" permission.

PageAdministrationException - if the user is not a page administrator.

org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.

post

String post(PagePostData post)

Posts to a page's feed as a page administrator. Requires that the application is granted "manage_pages" permission and that the authenticated user be an administrator of the page. To post to the page's feed as the authenticated user, use FeedOperations.post(String, String) instead.

Parameters:

post - A PagePostData with the post's payload.

Returns:

the ID of the new feed entry

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

org.springframework.social.InsufficientPermissionException - if the user has not granted "manage_pages" permission.

PageAdministrationException - if the user is not a page administrator.

org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.

postPhoto

String postPhoto(String pageId,
               String albumId,
               Resource photo)

Posts a photo to a page's album as the page administrator. Requires that the application is granted "manage_pages" permission and that the authenticated user be an administrator of the page.

Parameters:

pageId - the page ID

albumId - the album ID

photo - A Resource for the photo data. The given Resource must implement the getFilename() method (such as FileSystemResource or ClassPathResource).

Returns:

the ID of the photo.

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

org.springframework.social.InsufficientPermissionException - if the user has not granted "manage_pages" permission.

PageAdministrationException - if the user is not a page administrator.

org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.

postPhoto

String postPhoto(String pageId,
               String albumId,
               Resource photo,
               String caption)

Posts a photo to a page's album as the page administrator. Requires that the application is granted "manage_pages" permission and that the authenticated user be an administrator of the page.

Parameters:

pageId - the page ID

albumId - the album ID

photo - A Resource for the photo data. The given Resource must implement the getFilename() method (such as FileSystemResource or ClassPathResource).

caption - A caption describing the photo.

Returns:

the ID of the photo.

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

org.springframework.social.InsufficientPermissionException - if the user has not granted "manage_pages" permission.

PageAdministrationException - if the user is not a page administrator.

org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.

search

PagedList<Page> search(String query)

Searches for pages that match a given query.

Parameters:

query - the search query

Returns:

a list of Pages matching the search

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.

searchPlaces

PagedList<Page> searchPlaces(String query,
                           double latitude,
                           double longitude,
                           long distance)

Searches for places near a given coordinate.

Parameters:

query - the search query (e.g., "Burritos")

latitude - the latitude of the point to search near

longitude - the longitude of the point to search near

distance - the radius to search within (in feet)

Returns:

a list of Pages matching the search

Throws:

org.springframework.social.ApiException - if there is an error while communicating with Facebook.

org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.

getAccessToken

String getAccessToken(String pageId)

Returns the access token for a given page. This makes it possible to perform operations on behalf of a page that aren't already covered by PageOperations methods.

Parameters:

pageId - the page to fetch the access token for

Returns:

the page access token

getAccount

Account getAccount(String pageId)

Returns an Account object for the user's access to the given page.

Parameters:

pageId - the page to fetch the Account details for

Returns:

an Account object for the given page ID

facebookOperations

Facebook facebookOperations(String pageId)

Returns a Facebook instance that will act on behalf of the given page.

Parameters:

pageId - the page to create a Facebook instance for.

Returns:

a Facebook instance for the page.