|
Spring Social Facebook | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface GroupOperations
Defines operations for retrieving data about groups and group members.
| Method Summary | |
|---|---|
Group |
getGroup(java.lang.String groupId)
Retrieve data for a specified group. |
byte[] |
getGroupImage(java.lang.String groupId)
Retrieves a group's image as an array of bytes. |
byte[] |
getGroupImage(java.lang.String groupId,
ImageType imageType)
Retrieves a group's image as an array of bytes. |
PagedList<FacebookProfile> |
getMemberProfiles(java.lang.String groupId)
Retrieves the profiles for the members of the specified group. |
PagedList<GroupMemberReference> |
getMembers(java.lang.String groupId)
Retrieves the members of the specified group. |
PagedList<GroupMembership> |
getMemberships()
Retrieves a list of group memberships for the authenticated user. |
PagedList<GroupMembership> |
getMemberships(java.lang.String userId)
Retrieves a list of group memberships for a specific user. |
PagedList<Group> |
search(java.lang.String query)
Search for groups. |
PagedList<Group> |
search(java.lang.String query,
int offset,
int limit)
Deprecated. Use search(String, PagingParameters) instead. |
PagedList<Group> |
search(java.lang.String query,
PagingParameters pagedListParameters)
Search for groups. |
| Method Detail |
|---|
Group getGroup(java.lang.String groupId)
groupId - the ID of the group
Group object
org.springframework.social.ApiException - if there is an error while communicating with Facebook.byte[] getGroupImage(java.lang.String groupId)
groupId - the group ID
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
byte[] getGroupImage(java.lang.String groupId,
ImageType imageType)
groupId - the group IDimageType - the image type (eg., small, normal, large. square)
org.springframework.social.ApiException - if there is an error while communicating with Facebook.PagedList<GroupMemberReference> getMembers(java.lang.String groupId)
groupId - the ID of the group
References, one for each member of the group.
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> getMemberProfiles(java.lang.String groupId)
groupId - the ID of the group
FacebookProfiles, one for each member of the group.
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<GroupMembership> getMemberships()
GroupMemberships, one for each group the user is a member of.
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.
org.springframework.social.InsufficientPermissionException - if the user has not granted "user_groups" permission.PagedList<GroupMembership> getMemberships(java.lang.String userId)
userId - the user ID to retrieve memberships for.
GroupMemberships, one for each group the user is a member of.
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.
org.springframework.social.InsufficientPermissionException - if the user has not granted "user_groups" or "friends_groups" permission.PagedList<Group> search(java.lang.String query)
query - the search query (e.g., "Spring User Group")
Groups matching the search query
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
@Deprecated
PagedList<Group> search(java.lang.String query,
int offset,
int limit)
search(String, PagingParameters) instead.
query - the search query (e.g., "Spring User Group")offset - the offset into the matching groups listlimit - the maximum number of groups to return
Groups matching the search query
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
PagedList<Group> search(java.lang.String query,
PagingParameters pagedListParameters)
query - the search query (e.g., "Spring User Group")pagedListParameters - the parameters defining the bounds of the list to return.
Groups matching the search query
org.springframework.social.ApiException - if there is an error while communicating with Facebook.
|
Spring Social Facebook | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||