org.springframework.social.facebook.api
Interface PlacesOperations

public interface PlacesOperations

Defines the operations for interacting with a user's Facebook checkins.

Method Summary

java.lang.String	checkin(java.lang.String placeId, double latitude, double longitude) Checks the authenticated user into the specified location.
java.lang.String	checkin(java.lang.String placeId, double latitude, double longitude, java.lang.String message, java.lang.String... tags) Checks the authenticated user into the specified location.
Checkin	getCheckin(java.lang.String checkinId) Retrieves details for a single checkin.
java.util.List<Checkin>	getCheckins() Retrieves a list of checkins for the authenticated user.
java.util.List<Checkin>	getCheckins(java.lang.String objectId) Retrieves a list of checkins for the specified object.

Method Detail

getCheckins

java.util.List<Checkin> getCheckins()

Retrieves a list of checkins for the authenticated user. Requires "user_checkins" or "friends_checkins" permission.

Returns:

a list Checkins for the user, or an empty list if not available.

getCheckins

java.util.List<Checkin> getCheckins(java.lang.String objectId)

Retrieves a list of checkins for the specified object. If the object is a user, this returns checkins for places the user has checked into. If the object is a page, then this returns checkins that the user's friends has made to the location that the page represents. Requires "user_checkins" or "friends_checkins" permission.

Parameters:

objectId - either a Facebook user ID or page ID

Returns:

a list Checkins, or an empty list if not available.

getCheckin

Checkin getCheckin(java.lang.String checkinId)

Retrieves details for a single checkin.

Parameters:

checkinId - the checkin ID

Returns:

a Checkin

checkin

java.lang.String checkin(java.lang.String placeId,
                         double latitude,
                         double longitude)

Checks the authenticated user into the specified location.

Parameters:

placeId - the ID of the place to check into.

latitude - the latitude of the place.

longitude - the longitude of the place.

Returns:

the ID of the checkin.

checkin

java.lang.String checkin(java.lang.String placeId,
                         double latitude,
                         double longitude,
                         java.lang.String message,
                         java.lang.String... tags)

Checks the authenticated user into the specified location.

Parameters:

placeId - the ID of the place to check into.

latitude - the latitude of the place.

longitude - the longitude of the place.

message - a message to post along with the checkin.

tags - a varargs list of user IDs to tag on the checkin.

Returns:

the ID of the checkin.