FriendOperations (Spring Social Facebook 2.0.3.RELEASE API)

```
public interface FriendOperations
```
Defines operations for interacting with a user's friends and friend lists.

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`FriendList`	`getFriendList(String friendListId)` Retrieves a reference to the specified friend list.
`PagedList<FriendList>`	`getFriendLists()` Retrieves a list of custom friend lists belonging to the authenticated user.
`PagedList<User>`	`getFriendProfiles()` Retrieves the profile data for all of an authenticated user's friends.
`PagedList<User>`	`getFriendProfiles(PagingParameters pagedListParameters)` Retrieves profile data for the authenticated user's friends.
`PagedList<User>`	`getFriendProfiles(String userId)` Retrieves profile data for all of an authenticated user's friends.
`PagedList<User>`	`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<UserInvitableFriend>`	`getInvitableFriends()` Retrieves a list of the authenticated user's friends that can be invited.
`PagedList<UserTaggableFriend>`	`getTaggableFriends()` Retrieves a list of the authenticated user's friends that can be tagged in a post.

- Method Detail
  - getFriendLists
```
PagedList<FriendList> getFriendLists()
```
    Retrieves a list of custom friend lists belonging to the authenticated user. Requires "read_custom_friendlists" permission.
    
    Returns:
    a list References, each representing a friends list for the user, or an empty list if not available.
    
    Throws:
    
    org.springframework.social.ApiException - if there is an error while communicating with Facebook.
    
    org.springframework.social.InsufficientPermissionException - if the user has not granted "read_custom_friendlists" permission.
    
    org.springframework.social.MissingAuthorizationException - if FacebookTemplate was not created with an access token.
  - getFriendList
```
FriendList getFriendList(String friendListId)
```
    Retrieves a reference to the specified friend list.
    
    Parameters:
    friendListId - the friend list ID.
    
    Returns:
    a Reference to the requested friend list.
    
    Throws:
    
    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.
  - getFriends
```
PagedList<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.
    
    Throws:
    
    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.
  - getFriendIds
```
PagedList<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.
    
    Throws:
    
    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.
  - getFriendProfiles
```
PagedList<User> getFriendProfiles()
```
    Retrieves the profile data for all of an authenticated user's friends. The list of profiles is ordered by each user's Facebook ID.
    
    Returns:
    a list Users, each representing a friend of the user, or an empty list if not available.
    
    Throws:
    
    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.
  - getFriendProfiles
```
PagedList<User> getFriendProfiles(PagingParameters pagedListParameters)
```
    Retrieves profile data for the authenticated user's friends. The list of profiles is ordered by each user's Facebook ID.
    
    Parameters:
    pagedListParameters - the parameters defining the bounds of the list to return.
    
    Returns:
    a list Users, each representing a friend of the user, or an empty list if not available.
    
    Throws:
    
    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.
  - getFriends
```
PagedList<Reference> getFriends(String userId)
```
    Retrieves a list of user references for the specified user's friends. The list of profiles is ordered by each user's Facebook ID.
    
    Parameters:
    userId - the user's ID
    
    Returns:
    a list References, each representing a friend of the user, or an empty list if not available.
    
    Throws:
    
    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.
  - getFriendIds
```
PagedList<String> getFriendIds(String userId)
```
    Retrieves a list of the authenticating user's friends' IDs. The list of profiles is ordered by each user's Facebook ID.
    
    Parameters:
    userId - the user's ID
    
    Returns:
    a list of Strings, where each entry is the ID of one of the user's friends.
    
    Throws:
    
    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.
  - getFriendProfiles
```
PagedList<User> getFriendProfiles(String userId)
```
    Retrieves profile data for all of an authenticated user's friends. The list of profiles is ordered by each user's Facebook ID.
    
    Parameters:
    userId - the user's ID
    
    Returns:
    a list Users, each representing a friend of the user, or an empty list if not available.
    
    Throws:
    
    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.
  - getFriendProfiles
```
PagedList<User> getFriendProfiles(String userId,
                                PagingParameters pagedListParameters)
```
    Retrieves profile data for the specified user's friends. The list of profiles is ordered by each user's Facebook ID.
    
    Parameters:
    userId - the user's ID
    pagedListParameters - the parameters defining the bounds of the list to return.
    
    Returns:
    a list Users, each representing a friend of the user, or an empty list if not available.
    
    Throws:
    
    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.
  - getFamily
```
PagedList<FamilyMember> getFamily()
```
    Retrieves a list of FamilyMember references for the authenticated user.
    
    Returns:
    a list of FamilyMembers, each representing a Facebook user that the user is related to.
    
    Throws:
    
    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.
  - getFamily
```
PagedList<FamilyMember> getFamily(String userId)
```
    Retrieves a list of FamilyMember references for the specified user.
    
    Parameters:
    userId - the ID of the user to retrieve family members for.
    
    Returns:
    a list of FamilyMembers, each representing a Facebook user that the user is related to.
    
    Throws:
    
    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.
  - getInvitableFriends
```
PagedList<UserInvitableFriend> getInvitableFriends()
```
    Retrieves a list of the authenticated user's friends that can be invited.
    
    Returns:
    list of taggable friends
  - getTaggableFriends
```
PagedList<UserTaggableFriend> getTaggableFriends()
```
    Retrieves a list of the authenticated user's friends that can be tagged in a post.
    
    Returns:
    list of taggable friends

Interface FriendOperations

Method Summary

Method Detail

getFriendLists

getFriendList

getFriends

getFriendIds

getFriendProfiles

getFriendProfiles

getFriends

getFriendIds

getFriendProfiles

getFriendProfiles

getFamily

getFamily

getInvitableFriends

getTaggableFriends