Package | Description |
---|---|
com.clxcommunications.xms |
This package contains a Java interface for the CLX Communications XMS API.
|
com.clxcommunications.xms.api |
A collection of classes that represent objects sent and received from the XMS
REST API.
|
Modifier and Type | Method and Description |
---|---|
void |
ApiConnection.deleteGroup(GroupId id)
Deletes the given group.
|
Future<Void> |
ApiConnection.deleteGroupAsync(GroupId id,
FutureCallback<Void> callback)
Asynchronously deletes the group with the given group ID.
|
GroupResult |
ApiConnection.fetchGroup(GroupId id)
Attempts to fetch the given group.
|
Future<GroupResult> |
ApiConnection.fetchGroupAsync(GroupId id,
FutureCallback<GroupResult> callback)
Asynchronously fetches the given group.
|
Set<String> |
ApiConnection.fetchGroupMembers(GroupId id)
Attempts to fetch the members of the given group synchronously.
|
Future<Set<String>> |
ApiConnection.fetchGroupMembersAsync(GroupId id,
FutureCallback<Set<String>> callback)
Asynchronously fetches the members of the given group.
|
Tags |
ApiConnection.fetchTags(GroupId id)
Fetches the tags of the group with the given identifier.
|
Future<Tags> |
ApiConnection.fetchTagsAsync(GroupId id,
FutureCallback<Tags> callback)
Fetches the tags of the group with the given identifier.
|
GroupResult |
ApiConnection.replaceGroup(GroupId id,
GroupCreate group)
Replaces the given group.
|
Future<GroupResult> |
ApiConnection.replaceGroupAsync(GroupId id,
GroupCreate group,
FutureCallback<GroupResult> callback)
Asynchronously replaces the group with the given group ID.
|
Tags |
ApiConnection.replaceTags(GroupId id,
Tags tags)
Replaces the tags of the group with the given identifier.
|
Future<Tags> |
ApiConnection.replaceTagsAsync(GroupId id,
Tags tags,
FutureCallback<Tags> callback)
Replaces the tags of the group with the given identifier.
|
GroupResult |
ApiConnection.updateGroup(GroupId id,
GroupUpdate group)
Updates the given group.
|
Future<GroupResult> |
ApiConnection.updateGroupAsync(GroupId id,
GroupUpdate group,
FutureCallback<GroupResult> callback)
Asynchronously updates the group with the given group ID.
|
Tags |
ApiConnection.updateTags(GroupId id,
TagsUpdate tags)
Updates the tags of the group with the given identifier.
|
Future<Tags> |
ApiConnection.updateTagsAsync(GroupId id,
TagsUpdate tags,
FutureCallback<Tags> callback)
Updates the tags of the group with the given identifier.
|
Modifier and Type | Method and Description |
---|---|
abstract GroupId |
GroupUpdate.addFromGroup()
Identifier of a group whose members should be added to this group.
|
abstract GroupId |
GroupResult.id()
The unique group ID that identifies this group.
|
static GroupId |
GroupId.of(String id)
Builds an immutable
GroupId having the given literal
representation. |
abstract GroupId |
GroupUpdate.removeFromGroup()
Identifier of a group whose members should be removed to this group.
|
Modifier and Type | Method and Description |
---|---|
abstract Set<GroupId> |
GroupUpdate.childGroupInsertions()
The child groups that should be added to this group.
|
abstract Set<GroupId> |
GroupUpdate.childGroupRemovals()
The child groups that should be removed from this group.
|
abstract Set<GroupId> |
GroupCreate.childGroups()
A collection of child groups that belong to this group.
|
abstract Set<GroupId> |
GroupResult.childGroups()
This group's child groups.
|
Modifier and Type | Method and Description |
---|---|
int |
GroupId.compareTo(GroupId o) |
Copyright © 2016–2019 CLX Communications. All rights reserved.