|
Spring Social Facebook | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 up to 25 recent checkins for the authenticated user. |
java.util.List<Checkin> |
getCheckins(int offset,
int limit)
Retrieves a list of checkins for the authenticated user. |
java.util.List<Checkin> |
getCheckins(java.lang.String objectId)
Retrieves a list of up to 25 recent checkins for the specified object. |
java.util.List<Checkin> |
getCheckins(java.lang.String objectId,
int offset,
int limit)
Retrieves a list of checkins for the specified object. |
java.util.List<Page> |
search(java.lang.String query,
double latitude,
double longitude,
long distance)
Searches for places near a given coordinate. |
Method Detail |
---|
java.util.List<Checkin> getCheckins()
Checkin
s for the user, or an empty list if not available.
org.springframework.social.ApiException
- if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException
- if the user has not granted "user_checkins" or "friends_checkins" permission.
org.springframework.social.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.java.util.List<Checkin> getCheckins(int offset, int limit)
offset
- the offset into the list of checkinslimit
- the maximum number of checkins to return
Checkin
s for the user, or an empty list if not available.
org.springframework.social.ApiException
- if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException
- if the user has not granted "user_checkins" or "friends_checkins" permission.
org.springframework.social.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.java.util.List<Checkin> getCheckins(java.lang.String objectId)
objectId
- either a Facebook user ID or page ID
Checkin
s, or an empty list if not available.
org.springframework.social.ApiException
- if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException
- if the user has not granted "user_checkins" or "friends_checkins" permission.
org.springframework.social.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.java.util.List<Checkin> getCheckins(java.lang.String objectId, int offset, int limit)
objectId
- either a Facebook user ID or page IDoffset
- the offset into the list of checkinslimit
- the maximum number of checkins to return
Checkin
s, or an empty list if not available.
org.springframework.social.ApiException
- if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException
- if the user has not granted "user_checkins" or "friends_checkins" permission.
org.springframework.social.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.Checkin getCheckin(java.lang.String checkinId)
checkinId
- the checkin ID
Checkin
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.java.lang.String checkin(java.lang.String placeId, double latitude, double longitude)
placeId
- the ID of the place to check into.latitude
- the latitude of the place.longitude
- the longitude of the place.
org.springframework.social.ApiException
- if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException
- if the user has not granted "publish_checkins" permission.
org.springframework.social.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.java.lang.String checkin(java.lang.String placeId, double latitude, double longitude, java.lang.String message, java.lang.String... tags)
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.
org.springframework.social.ApiException
- if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException
- if the user has not granted "publish_checkins" permission.
org.springframework.social.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.java.util.List<Page> search(java.lang.String query, double latitude, double longitude, long distance)
query
- the search query (e.g., "Burritos")latitude
- the latitude of the point to search nearlongitude
- the longitude of the point to search neardistance
- the radius to search within (in feet)
Page
s matching the search
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.
|
Spring Social Facebook | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |