org.springframework.social.facebook.api
Interface FriendOperations


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.
 Reference createFriendList(java.lang.String name)
          Creates a new friend list for the authenticated user.
 Reference 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 the authenticated user's friends.
 java.util.List<FacebookProfile> getFriendProfiles(java.lang.String userId)
          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

getFriendLists

java.util.List<Reference> getFriendLists()
Retrieves a list of custom friend lists belonging to the authenticated user. Requires "read_friendlists" permission.

Returns:
a list References, each representing a friends list for the user, or an empty list if not available.

getFriendLists

java.util.List<Reference> getFriendLists(java.lang.String userId)
Retrieves a list of custom friend lists belonging to the specified user. Requires "read_friendlists" permission.

Parameters:
userId - the user's ID
Returns:
a list References, each representing a friends list for the user, or an empty list if not available.

getFriendList

Reference getFriendList(java.lang.String friendListId)
Retrieves a reference to the specified friend list.

Parameters:
friendListId - the friend list ID.
Returns:
a Reference to the requested friend list.

getFriendListMembers

java.util.List<Reference> getFriendListMembers(java.lang.String friendListId)
Retrieves references for all users who are members of the specified friend list.

Parameters:
friendListId - the friend list ID.
Returns:
a list of Reference, each representing a member of the friend list.

createFriendList

Reference createFriendList(java.lang.String name)
Creates a new friend list for the authenticated user.

Parameters:
name - the name of the friend list.
Returns:
a Reference to the newly created friend list.

createFriendList

Reference createFriendList(java.lang.String userId,
                           java.lang.String name)
Creates a new friend list.

Parameters:
userId - the user ID to create the friend list for.
name - the name of the friend list.
Returns:
a Reference to the newly created friend list.

deleteFriendList

void deleteFriendList(java.lang.String friendListId)
Deletes a friend list.

Parameters:
friendListId - the ID of the friend list to remove.

addToFriendList

void addToFriendList(java.lang.String friendListId,
                     java.lang.String friendId)
Adds a friend to a friend list.

Parameters:
friendListId - the friend list ID
friendId - The ID of the user to add to the list. The user must be a friend of the list's owner.

removeFromFriendList

void removeFromFriendList(java.lang.String friendListId,
                          java.lang.String friendId)
Removes a friend from a friend list.

Parameters:
friendListId - the friend list ID
friendId - The ID of the user to add to the list.

getFriends

java.util.List<Reference> getFriends()
Retrieves a list of user references for the authenticated user's friends.

Returns:
a list References, each representing a friend of the user, or an empty list if not available.

getFriendIds

java.util.List<java.lang.String> getFriendIds()
Retrieves a list of the authenticating user's friends' IDs.

Returns:
a list of Strings, where each entry is the ID of one of the user's friends.

getFriendProfiles

java.util.List<FacebookProfile> getFriendProfiles()
Retrieves profile data for the authenticated user's friends.

Returns:
a list FacebookProfiles, each representing a friend of the user, or an empty list if not available.

getFriends

java.util.List<Reference> getFriends(java.lang.String userId)
Retrieves a list of user references for the specified user's friends.

Parameters:
userId - the user's ID
Returns:
a list References, each representing a friend of the user, or an empty list if not available.

getFriendIds

java.util.List<java.lang.String> getFriendIds(java.lang.String userId)
Retrieves a list of the authenticating user's friends' IDs.

Parameters:
userId - the user's ID
Returns:
a list of Strings, where each entry is the ID of one of the user's friends.

getFriendProfiles

java.util.List<FacebookProfile> getFriendProfiles(java.lang.String userId)
Retrieves profile data for the specified user's friends.

Parameters:
userId - the user's ID
Returns:
a list FacebookProfiles, each representing a friend of the user, or an empty list if not available.