public static interface GroupsWebService.Groups
Modifier and Type | Method and Description |
---|---|
java.util.concurrent.CompletableFuture<java.lang.Void> |
favorite(CurseGUID groupID) |
java.util.concurrent.CompletableFuture<GroupNotification> |
get(CurseGUID groupID,
boolean showDeletedChannels)
Returns detailed information about given group.
|
java.util.concurrent.CompletableFuture<java.util.List<GroupMemberContract>> |
getMembers(CurseGUID groupID,
boolean actives,
int page,
int pageSize)
Gets list of members for a group.
|
java.util.concurrent.CompletableFuture<java.lang.Void> |
leaveGroup(CurseGUID groupID) |
java.util.concurrent.CompletableFuture<java.util.List<GroupMemberContract>> |
searchMembers(CurseGUID groupID,
GroupMemberSearchRequest groupMemberSearchRequest)
Finds members of a group.
|
java.util.concurrent.CompletableFuture<java.lang.Void> |
unfavorite(CurseGUID groupID) |
@POST(value="groups/{groupID}/favorite") java.util.concurrent.CompletableFuture<java.lang.Void> favorite(@Path(value="groupID") CurseGUID groupID)
@POST(value="groups/{groupID}/unfavorite") java.util.concurrent.CompletableFuture<java.lang.Void> unfavorite(@Path(value="groupID") CurseGUID groupID)
@POST(value="groups/{groupID}/leave") java.util.concurrent.CompletableFuture<java.lang.Void> leaveGroup(@Path(value="groupID") CurseGUID groupID)
@GET(value="groups/{groupID}") java.util.concurrent.CompletableFuture<GroupNotification> get(@Path(value="groupID") CurseGUID groupID, @Query(value="showDeletedChannels") boolean showDeletedChannels)
groupID
- Group to get information forshowDeletedChannels
- true to include information about deleted channels@GET(value="groups/{groupID}/members") java.util.concurrent.CompletableFuture<java.util.List<GroupMemberContract>> getMembers(@Path(value="groupID") CurseGUID groupID, @Query(value="actives") boolean actives, @Query(value="page") int page, @Query(value="pageSize") int pageSize)
groupID
- Group to searchactives
- True to list active member, false to inactive memberspage
- pageSize
- Max amoung of search results. MAX 50. Larger makes server to return status code 400GroupMemberContract
s#searchMembers(CurseGUID, GroupMemberSearchRequest)}
@POST(value="groups/{groupID}/members/search") java.util.concurrent.CompletableFuture<java.util.List<GroupMemberContract>> searchMembers(@Path(value="groupID") CurseGUID groupID, @Body GroupMemberSearchRequest groupMemberSearchRequest)
Server seems to return results like String.startsWith(username) ignoring case. Null values in
groupMemberSearchRequest
are interpreted like missing values.
Note: behaviour might be changed. Current web application does not send empty values as nulls
groupID
- group to findgroupMemberSearchRequest
- Search query containing search term, sorting, page size and paginationGroupMemberContract
s containing matches#getMembers(CurseGUID, boolean, int, int)}