|
Spring Social Yammer | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface GroupOperations
Sub-API for all Group related methods
| Field Summary | |
|---|---|
static java.lang.String |
SORT_BY_CREATED_AT
Convenience constant for sorting by created at |
static java.lang.String |
SORT_BY_CREATOR
Convenience constant for sorting by creator |
static java.lang.String |
SORT_BY_MEMBERS
Convenience constant for sorting by members |
static java.lang.String |
SORT_BY_MESSAGES
Convenience constant for sorting by messages |
static java.lang.String |
SORT_BY_PRIVACY
Convenience constant for sorting by privacy |
| Method Summary | |
|---|---|
void |
createGroup(java.lang.String name,
boolean isPrivate)
Create a new group |
Group |
getGroup(long groupId)
Returns the group with the given id |
java.util.List<Group> |
getGroups(int page,
java.lang.Character letter,
java.lang.String sortBy,
boolean reverse)
Retrieves a list of groups as specified by the parameters. |
void |
joinGroup(long groupId)
Join a group with given group id |
void |
leaveGroup(long groupId)
Join group with given group id |
| Field Detail |
|---|
static final java.lang.String SORT_BY_PRIVACY
static final java.lang.String SORT_BY_CREATED_AT
static final java.lang.String SORT_BY_MESSAGES
static final java.lang.String SORT_BY_CREATOR
static final java.lang.String SORT_BY_MEMBERS
| Method Detail |
|---|
java.util.List<Group> getGroups(int page,
java.lang.Character letter,
java.lang.String sortBy,
boolean reverse)
page - number. First page = 1letter - return groups beginning with the given lettersortBy - sort key. Valid values are "creator" | "members" | "privacy" |
"created_at" | "messages".
Use convenience constantsreverse - indicating whether sort should be reversed
List of GroupsGroup getGroup(long groupId)
groupId -
org.springframework.social.ResourceNotFoundException - if there is no group with the given id in the network
void createGroup(java.lang.String name,
boolean isPrivate)
name - of groupisPrivate - whether the group is public (anyone can join) or privatevoid leaveGroup(long groupId)
groupId -
org.springframework.social.ResourceNotFoundException - if you are not a member of that group or group does not existvoid joinGroup(long groupId)
groupId -
org.springframework.social.ResourceNotFoundException - if that group does not exist in your network
|
Spring Social Yammer | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||