public interface GroupApi
| Modifier and Type | Interface and Description |
|---|---|
static class |
GroupApi.NotImplemented
A default implementation which allows source compatibility when adding new methods to the
interface.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addGroups(String... groups)
Adds subgroups to this group.
|
void |
addMembers(String... members)
Add members to a group.
|
List<? extends GroupAuditEventInfo> |
auditLog()
Returns the audit log of the group.
|
String |
description() |
void |
description(String description)
Set group decsription.
|
GroupInfo |
detail() |
GroupInfo |
get() |
List<GroupInfo> |
includedGroups()
Lists the subgroups of this group.
|
void |
index()
Reindexes the group.
|
List<AccountInfo> |
members()
List group members, non-recursively.
|
List<AccountInfo> |
members(boolean recursive)
List group members.
|
String |
name() |
void |
name(String name)
Set group name.
|
GroupOptionsInfo |
options() |
void |
options(GroupOptionsInfo options)
Set group options.
|
GroupInfo |
owner() |
void |
owner(String owner)
Set group owner.
|
void |
removeGroups(String... groups)
Removes subgroups from this group.
|
void |
removeMembers(String... members)
Remove members from a group.
|
GroupInfo get() throws RestApiException
ListGroupsOptions set.RestApiExceptionGroupInfo detail() throws RestApiException
ListGroupsOptions set.RestApiExceptionString name() throws RestApiException
RestApiExceptionvoid name(String name) throws RestApiException
name - new name.RestApiExceptionGroupInfo owner() throws RestApiException
RestApiExceptionvoid owner(String owner) throws RestApiException
owner - identifier of new group owner.RestApiExceptionString description() throws RestApiException
RestApiExceptionvoid description(String description) throws RestApiException
description - new description.RestApiExceptionGroupOptionsInfo options() throws RestApiException
RestApiExceptionvoid options(GroupOptionsInfo options) throws RestApiException
options - new options.RestApiExceptionList<AccountInfo> members() throws RestApiException
RestApiExceptionList<AccountInfo> members(boolean recursive) throws RestApiException
recursive - whether to recursively included groups.RestApiExceptionvoid addMembers(String... members) throws RestApiException
members - list of member identifiers, in any format accepted by Accounts.id(String)RestApiExceptionvoid removeMembers(String... members) throws RestApiException
members - list of member identifiers, in any format accepted by Accounts.id(String)RestApiExceptionList<GroupInfo> includedGroups() throws RestApiException
RestApiExceptionvoid addGroups(String... groups) throws RestApiException
groups - list of group identifiers, in any format accepted by Groups.id(String)RestApiExceptionvoid removeGroups(String... groups) throws RestApiException
groups - list of group identifiers, in any format accepted by Groups.id(String)RestApiExceptionList<? extends GroupAuditEventInfo> auditLog() throws RestApiException
RestApiExceptionvoid index()
throws RestApiException
Only supported for internal groups.
RestApiExceptionCopyright © 2018. All rights reserved.