|
Spring Social Facebook | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FriendOperations
Defines operations for interacting with a user's friends and friend lists.
Method Summary | |
---|---|
void |
addToFriendList(java.lang.String friendListId,
java.lang.String friendId)
Adds a friend to a friend list. |
java.lang.String |
createFriendList(java.lang.String name)
Creates a new friend list for the authenticated user. |
java.lang.String |
createFriendList(java.lang.String userId,
java.lang.String name)
Creates a new friend list. |
void |
deleteFriendList(java.lang.String friendListId)
Deletes a friend list. |
java.util.List<java.lang.String> |
getFriendIds()
Retrieves a list of the authenticating user's friends' IDs. |
java.util.List<java.lang.String> |
getFriendIds(java.lang.String userId)
Retrieves a list of the authenticating user's friends' IDs. |
Reference |
getFriendList(java.lang.String friendListId)
Retrieves a reference to the specified friend list. |
java.util.List<Reference> |
getFriendListMembers(java.lang.String friendListId)
Retrieves references for all users who are members of the specified friend list. |
java.util.List<Reference> |
getFriendLists()
Retrieves a list of custom friend lists belonging to the authenticated user. |
java.util.List<Reference> |
getFriendLists(java.lang.String userId)
Retrieves a list of custom friend lists belonging to the specified user. |
java.util.List<FacebookProfile> |
getFriendProfiles()
Retrieves profile data for up to 100 of the authenticated user's friends. |
java.util.List<FacebookProfile> |
getFriendProfiles(int offset,
int limit)
Retrieves profile data for the authenticated user's friends. |
java.util.List<FacebookProfile> |
getFriendProfiles(java.lang.String userId)
Retrieves profile data for up to 100 of the specified user's friends. |
java.util.List<FacebookProfile> |
getFriendProfiles(java.lang.String userId,
int offset,
int limit)
Retrieves profile data for the specified user's friends. |
java.util.List<Reference> |
getFriends()
Retrieves a list of user references for the authenticated user's friends. |
java.util.List<Reference> |
getFriends(java.lang.String userId)
Retrieves a list of user references for the specified user's friends. |
void |
removeFromFriendList(java.lang.String friendListId,
java.lang.String friendId)
Removes a friend from a friend list. |
Method Detail |
---|
java.util.List<Reference> getFriendLists()
Reference
s, each representing a friends list 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 "read_friendlists" permission.
org.springframework.social.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.java.util.List<Reference> getFriendLists(java.lang.String userId)
userId
- the user's ID
Reference
s, each representing a friends list 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 "read_friendlists" permission.
org.springframework.social.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.Reference getFriendList(java.lang.String friendListId)
friendListId
- the friend list ID.
Reference
to the requested friend list.
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.util.List<Reference> getFriendListMembers(java.lang.String friendListId)
friendListId
- the friend list ID.
Reference
, each representing a member of the friend list.
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 createFriendList(java.lang.String name)
name
- the name of the friend list.
org.springframework.social.ApiException
- if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException
- if the user has not granted "manage_friendlists" permission.
org.springframework.social.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.java.lang.String createFriendList(java.lang.String userId, java.lang.String name)
userId
- the user ID to create the friend list for.name
- the name of the friend list.
org.springframework.social.ApiException
- if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException
- if the user has not granted "manage_friendlists" permission.
org.springframework.social.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.void deleteFriendList(java.lang.String friendListId)
friendListId
- the ID of the friend list to remove.
org.springframework.social.ApiException
- if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException
- if the user has not granted "manage_friendlists" permission.
org.springframework.social.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.void addToFriendList(java.lang.String friendListId, java.lang.String friendId)
friendListId
- the friend list IDfriendId
- The ID of the user to add to the list. The user must be a friend of the list's owner.
org.springframework.social.ApiException
- if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException
- if the user has not granted "manage_friendlists" permission.
org.springframework.social.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.void removeFromFriendList(java.lang.String friendListId, java.lang.String friendId)
friendListId
- the friend list IDfriendId
- The ID of the user to add to the list.
org.springframework.social.ApiException
- if there is an error while communicating with Facebook.
org.springframework.social.InsufficientPermissionException
- if the user has not granted "manage_friendlists" permission.
org.springframework.social.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.java.util.List<Reference> getFriends()
Reference
s, each representing a friend of 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.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.java.util.List<java.lang.String> getFriendIds()
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.util.List<FacebookProfile> getFriendProfiles()
FacebookProfile
s, each representing a friend of 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.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.java.util.List<FacebookProfile> getFriendProfiles(int offset, int limit)
offset
- the offset into the friends list to start retrieving profiles.limit
- the maximum number of profiles to return.
FacebookProfile
s, each representing a friend of 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.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.java.util.List<Reference> getFriends(java.lang.String userId)
userId
- the user's ID
Reference
s, each representing a friend of 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.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.java.util.List<java.lang.String> getFriendIds(java.lang.String userId)
userId
- the user's ID
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.util.List<FacebookProfile> getFriendProfiles(java.lang.String userId)
userId
- the user's ID
FacebookProfile
s, each representing a friend of 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.MissingAuthorizationException
- if FacebookTemplate was not created with an access token.java.util.List<FacebookProfile> getFriendProfiles(java.lang.String userId, int offset, int limit)
userId
- the user's IDoffset
- the offset into the friends list to start retrieving profiles.limit
- the maximum number of profiles to return.
FacebookProfile
s, each representing a friend of 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.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 |