|
|||||||||
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(String friendListId,
String friendId)
Adds a friend to a friend list. |
String |
createFriendList(String name)
Creates a new friend list for the authenticated user. |
String |
createFriendList(String userId,
String name)
Creates a new friend list. |
void |
deleteFriendList(String friendListId)
Deletes a friend list. |
PagedList<FamilyMember> |
getFamily()
Retrieves a list of FamilyMember references for the authenticated user. |
PagedList<FamilyMember> |
getFamily(String userId)
Retrieves a list of FamilyMember references for the specified user. |
PagedList<String> |
getFriendIds()
Retrieves a list of the authenticating user's friends' IDs. |
PagedList<String> |
getFriendIds(String userId)
Retrieves a list of the authenticating user's friends' IDs. |
Reference |
getFriendList(String friendListId)
Retrieves a reference to the specified friend list. |
PagedList<Reference> |
getFriendListMembers(String friendListId)
Retrieves references for all users who are members of the specified friend list. |
PagedList<Reference> |
getFriendLists()
Retrieves a list of custom friend lists belonging to the authenticated user. |
PagedList<Reference> |
getFriendLists(String userId)
Retrieves a list of custom friend lists belonging to the specified user. |
PagedList<FacebookProfile> |
getFriendProfiles()
Retrieves the profile data for all of an authenticated user's friends. |
PagedList<FacebookProfile> |
getFriendProfiles(int offset,
int limit)
Deprecated. Use getFriendProfiles(PagingParameters) instead. |
PagedList<FacebookProfile> |
getFriendProfiles(PagingParameters pagedListParameters)
Retrieves profile data for the authenticated user's friends. |
PagedList<FacebookProfile> |
getFriendProfiles(String userId)
Retrieves profile data for all of an authenticated user's friends. |
PagedList<FacebookProfile> |
getFriendProfiles(String userId,
int offset,
int limit)
Deprecated. Use getFriendProfiles(String, PagingParameters) instead. |
PagedList<FacebookProfile> |
getFriendProfiles(String userId,
PagingParameters pagedListParameters)
Retrieves profile data for the specified user's friends. |
PagedList<Reference> |
getFriends()
Retrieves a list of user references for the authenticated user's friends. |
PagedList<Reference> |
getFriends(String userId)
Retrieves a list of user references for the specified user's friends. |
PagedList<Reference> |
getMutualFriends(String userId)
Retrieves a list of user references that the authenticated user and the specified user have in common as friends. |
PagedList<Reference> |
getSubscribedTo()
Retrieves a list of user reference for the users that the authenticated user is subscribed to. |
PagedList<Reference> |
getSubscribedTo(String userId)
Retrieves a list of user reference for the users that the specified user is subscribed to. |
PagedList<Reference> |
getSubscribers()
Retrieves a list of user reference for the users that are subscribed to the authenticated user. |
PagedList<Reference> |
getSubscribers(String userId)
Retrieves a list of user reference for the users that are subscribed to the specified user. |
void |
removeFromFriendList(String friendListId,
String friendId)
Removes a friend from a friend list. |
Method Detail |
---|
PagedList<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.PagedList<Reference> getFriendLists(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(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.PagedList<Reference> getFriendListMembers(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.String createFriendList(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.String createFriendList(String userId, 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(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(String friendListId, 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(String friendListId, 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.PagedList<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.PagedList<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.PagedList<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.@Deprecated PagedList<FacebookProfile> getFriendProfiles(int offset, int limit)
getFriendProfiles(PagingParameters)
instead.
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.PagedList<FacebookProfile> getFriendProfiles(PagingParameters pagedListParameters)
pagedListParameters
- the parameters defining the bounds of the list 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.PagedList<Reference> getFriends(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.PagedList<String> getFriendIds(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.PagedList<FacebookProfile> getFriendProfiles(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.@Deprecated PagedList<FacebookProfile> getFriendProfiles(String userId, int offset, int limit)
getFriendProfiles(String, PagingParameters)
instead.
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.PagedList<FacebookProfile> getFriendProfiles(String userId, PagingParameters pagedListParameters)
userId
- the user's IDpagedListParameters
- the parameters defining the bounds of the list 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.PagedList<FamilyMember> getFamily()
FamilyMember
s, each representing a Facebook user that the user is related to.
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.PagedList<FamilyMember> getFamily(String userId)
userId
- the ID of the user to retrieve family members for.
FamilyMember
s, each representing a Facebook user that the user is related to.
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.PagedList<Reference> getMutualFriends(String userId)
userId
- the ID of the user to check for common friendships with.
Reference
s, each representing a friend that the two users have in common.
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.PagedList<Reference> getSubscribedTo()
Reference
s, each representing a Facebook user that the user is subscribed to.
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.PagedList<Reference> getSubscribedTo(String userId)
userId
- the ID of the user to fetch subscriptions for.
Reference
s, each representing a Facebook user that the user is subscribed to.
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.PagedList<Reference> getSubscribers()
Reference
s, each representing a Facebook user that the user is subscribed to.
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.PagedList<Reference> getSubscribers(String userId)
userId
- the ID of the user to fetch subscriptions for.
Reference
s, each representing a Facebook user that the user is subscribed to.
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |