org.springframework.social.facebook.api

Interface UserOperations

public interface UserOperations

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	PROFILE_FIELDS

Method Summary

Methods

Modifier and Type	Method and Description
List<UserIdForApp>	getIdsForBusiness() Fetches IDs that the user has on any applications associated with the calling application via Facebook's Business Mapping API.
List<PlaceTag>	getTaggedPlaces() Fetches a list of places that the user has checked into or has been tagged at.
List<Permission>	getUserPermissions() Retrieves a list of permissions that the application has been granted for the authenticated user.
User	getUserProfile() Retrieves the profile for the authenticated user.
User	getUserProfile(String userId) Retrieves the profile for the specified user.
byte[]	getUserProfileImage() Retrieves the user's profile image.
byte[]	getUserProfileImage(ImageType imageType) Retrieves the user's profile image.
byte[]	getUserProfileImage(Integer width, Integer height) Retrieves the user's profile image.
byte[]	getUserProfileImage(String userId) Retrieves the user's profile image.
byte[]	getUserProfileImage(String userId, ImageType imageType) Retrieves the user's profile image.
byte[]	getUserProfileImage(String userId, Integer width, Integer height) Retrieves the user's profile image.
PagedList<Reference>	search(String query) Searches for users.

Field Detail

PROFILE_FIELDS

static final String[] PROFILE_FIELDS

Method Detail

getUserProfile

User getUserProfile()

Retrieves the profile for the authenticated user.

Returns:

the user's profile information.

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.

getUserProfile

User getUserProfile(String userId)

Retrieves the profile for the specified user.

Parameters:

userId - the Facebook user ID to retrieve profile data for.

Returns:

the user's profile information.

Throws:

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

getUserProfileImage

byte[] getUserProfileImage()

Retrieves the user's profile image. Returns the image in Facebook's "normal" type.

Returns:

an array of bytes containing the user's profile image.

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.

getUserProfileImage

byte[] getUserProfileImage(String userId)

Retrieves the user's profile image. Returns the image in Facebook's "normal" type.

Parameters:

userId - the Facebook user ID.

Returns:

an array of bytes containing the user's profile image.

Throws:

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

getUserProfileImage

byte[] getUserProfileImage(ImageType imageType)

Retrieves the user's profile image.

Parameters:

imageType - the image type (eg., small, normal, large. square)

Returns:

an array of bytes containing the user's profile image.

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.

getUserProfileImage

byte[] getUserProfileImage(String userId,
                         ImageType imageType)

Retrieves the user's profile image.

Parameters:

userId - the Facebook user ID.

imageType - the image type (eg., small, normal, large. square)

Returns:

an array of bytes containing the user's profile image.

Throws:

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

getUserProfileImage

byte[] getUserProfileImage(Integer width,
                         Integer height)

Retrieves the user's profile image. When height and width are both used, the image will be scaled as close to the dimensions as possible and then cropped down.

Parameters:

width - the desired image width

height - the desired image height

Returns:

an array of bytes containing the user's profile image.

Throws:

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

getUserProfileImage

byte[] getUserProfileImage(String userId,
                         Integer width,
                         Integer height)

Retrieves the user's profile image. When height and width are both used, the image will be scaled as close to the dimensions as possible and then cropped down.

Parameters:

userId - the Facebook user ID.

width - the desired image width

height - the desired image height

Returns:

an array of bytes containing the user's profile image.

Throws:

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

getUserPermissions

List<Permission> getUserPermissions()

Retrieves a list of permissions that the application has been granted for the authenticated user.

Returns:

the permissions granted for the user.

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.

getIdsForBusiness

List<UserIdForApp> getIdsForBusiness()

Fetches IDs that the user has on any applications associated with the calling application via Facebook's Business Mapping API.

Returns:

a list of ID-to-application mapping that the user has on related applications.

getTaggedPlaces

List<PlaceTag> getTaggedPlaces()

Fetches a list of places that the user has checked into or has been tagged at.

Returns:

a list of place tags for the user.

search

PagedList<Reference> search(String query)

Searches for users.

Parameters:

query - the search query (e.g., "Michael Scott")

Returns:

a list of References, each representing a user who matched the given query.

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.