Index (SDK for CLX XMS 1.0.2 API)

A B C D E F G H I J K M N O P Q R S T U V W

A

ABORTED - Static variable in class com.clxcommunications.xms.api.DeliveryStatus: Message was aborted before reaching SMSC.
add() - Method in class com.clxcommunications.xms.api.AutoUpdate: The keyword trigger used to add a member.
add(String, String) - Method in class com.clxcommunications.xms.api.AutoUpdate.Builder: The keyword trigger to use for adding a number to a group.
addFromGroup() - Method in class com.clxcommunications.xms.api.GroupUpdate: Identifier of a group whose members should be added to this group.
ApiConnection - Class in com.clxcommunications.xms: An abstract representation of an XMS connection.
ApiConnection.Builder - Class in com.clxcommunications.xms: A builder of API connections.
ApiError - Class in com.clxcommunications.xms.api: API object containing an error response.
ApiError() - Constructor for class com.clxcommunications.xms.api.ApiError
ApiError.Code - Class in com.clxcommunications.xms.api: A collection of known error codes.
ApiException - Exception in com.clxcommunications.xms: Base class for all exceptions specific to the CLX SDK.
ApiException() - Constructor for exception com.clxcommunications.xms.ApiException: Construct a new API exception having no message and no cause.
ApiException(String) - Constructor for exception com.clxcommunications.xms.ApiException: Construct a new API exception having the given message and no cause.
ApiException(Throwable) - Constructor for exception com.clxcommunications.xms.ApiException: Construct a new API exception having no message and the given cause.
ApiException(String, Throwable) - Constructor for exception com.clxcommunications.xms.ApiException: Construct a new API exception having the given message and cause.
ApiHttpAsyncClient - Class in com.clxcommunications.xms: An asynchronous HTTP client used in API connections.
ApiObjectMapper - Class in com.clxcommunications.xms: A Jackson object mapper suitable for use with the CLX REST API objects.
ApiObjectMapper() - Constructor for class com.clxcommunications.xms.ApiObjectMapper: Creates an object mapper suitable for the CLX REST API.
ApiObjectMapper(boolean) - Constructor for class com.clxcommunications.xms.ApiObjectMapper: Creates an object mapper suitable for the CLX REST API.
ARTIFACT_ID - Static variable in class com.clxcommunications.xms.Version: The Maven artifact ID of this SDK.
at() - Method in class com.clxcommunications.xms.api.RecipientDeliveryReport: Time when the message reached it's final state.
AutoUpdate - Class in com.clxcommunications.xms.api: Describes auto updates of groups.
AutoUpdate() - Constructor for class com.clxcommunications.xms.api.AutoUpdate
autoUpdate() - Method in class com.clxcommunications.xms.api.GroupCreate: Describes how this group is auto updated through user interaction.
autoUpdate() - Method in class com.clxcommunications.xms.api.GroupResult: Describes how this group is auto updated through user interaction.
autoUpdate() - Method in class com.clxcommunications.xms.api.GroupUpdate: Describes how this group should be auto updated.
autoUpdate(AutoUpdate) - Method in class com.clxcommunications.xms.api.GroupUpdate.Builder: Updates the group auto update to the one given.
autoUpdate() - Static method in class com.clxcommunications.xms.ClxApi: Returns a freshly created builder of auto update definitions.
AutoUpdate.Builder - Class in com.clxcommunications.xms.api: A builder of auto update descriptions.

B

batchBinarySms() - Static method in class com.clxcommunications.xms.ClxApi: Returns a freshly created batch SMS builder for binary messages.
batchBinarySmsUpdate() - Static method in class com.clxcommunications.xms.ClxApi: Returns a freshly created builder for binary message updates.
BatchDeliveryReport - Class in com.clxcommunications.xms.api: A batch delivery report.
BatchDeliveryReport() - Constructor for class com.clxcommunications.xms.api.BatchDeliveryReport
BatchDeliveryReport.Builder - Class in com.clxcommunications.xms.api: A builder of batch delivery reports.
BatchDeliveryReport.Status - Class in com.clxcommunications.xms.api: A description of the messages having a given delivery state.
BatchDeliveryReport.Status.Builder - Class in com.clxcommunications.xms.api: A builder of batch delivery report statuses.
BatchDeliveryReportParams - Class in com.clxcommunications.xms: Describes the a filter that restricts and controls how a batch delivery report is returned.
BatchDeliveryReportParams() - Constructor for class com.clxcommunications.xms.BatchDeliveryReportParams
batchDeliveryReportParams() - Static method in class com.clxcommunications.xms.ClxApi: Returns a freshly created batch delivery report parameter builder.
BatchDeliveryReportParams.Builder - Class in com.clxcommunications.xms: A builder of batch delivery report filters.
BatchDeliveryReportParams.ReportType - Enum in com.clxcommunications.xms: The delivery report types that can be retrieved.
BatchFilter - Class in com.clxcommunications.xms: Describes a filter for limiting results when fetching batches.
BatchFilter() - Constructor for class com.clxcommunications.xms.BatchFilter
batchFilter() - Static method in class com.clxcommunications.xms.ClxApi: Returns a freshly created builder of batch filters.
BatchFilter.Builder - Class in com.clxcommunications.xms: A builder of batch filters.
batchId() - Method in class com.clxcommunications.xms.api.BatchDeliveryReport: Identifier of the batch to which this delivery report refers.
BatchId - Class in com.clxcommunications.xms.api: Representation of a batch identifier.
BatchId() - Constructor for class com.clxcommunications.xms.api.BatchId
batchId() - Method in class com.clxcommunications.xms.api.RecipientDeliveryReport: The batch to which this delivery report belongs
batchTextSms() - Static method in class com.clxcommunications.xms.ClxApi: Returns a freshly created batch SMS builder for text messages.
batchTextSmsUpdate() - Static method in class com.clxcommunications.xms.ClxApi: Returns a freshly created builder for text message updates.
body() - Method in class com.clxcommunications.xms.api.MoBinarySms: The binary message body.
body() - Method in class com.clxcommunications.xms.api.MoTextSms: The textual message body.
body() - Method in class com.clxcommunications.xms.api.MtBatchBinarySmsCreate: The binary message body.
body() - Method in class com.clxcommunications.xms.api.MtBatchBinarySmsResult: The binary message body.
body() - Method in class com.clxcommunications.xms.api.MtBatchBinarySmsUpdate: The updated binary message body.
body() - Method in class com.clxcommunications.xms.api.MtBatchDryRunResult.PerRecipient: The message body sent to this recipient.
body() - Method in class com.clxcommunications.xms.api.MtBatchTextSmsCreate: The message text or template.
body() - Method in class com.clxcommunications.xms.api.MtBatchTextSmsResult: The message text or template.
body() - Method in class com.clxcommunications.xms.api.MtBatchTextSmsUpdate: The updated batch message body.
build() - Method in class com.clxcommunications.xms.ApiConnection.Builder: Builds a new, initially stopped, ApiConnection.
builder() - Static method in class com.clxcommunications.xms.api.AutoUpdate: Creates a builder of AutoUpdate instances.
builder() - Static method in class com.clxcommunications.xms.api.BatchDeliveryReport: Creates a builder of BatchDeliveryReport instances.
builder() - Static method in class com.clxcommunications.xms.api.BatchDeliveryReport.Status: Creates a builder of BatchDeliveryReport.Status instances.
builder() - Static method in class com.clxcommunications.xms.api.GroupCreate: Creates a builder of GroupCreate instances.
builder() - Static method in class com.clxcommunications.xms.api.GroupResult: Creates a builder of GroupResult instances.
builder() - Static method in class com.clxcommunications.xms.api.GroupUpdate: Creates a builder of GroupUpdate instances.
builder() - Static method in class com.clxcommunications.xms.api.MoBinarySms: Creates a builder of MoBinarySms instances.
builder() - Static method in class com.clxcommunications.xms.api.MoTextSms: Creates a builder of MoTextSms instances.
builder() - Static method in class com.clxcommunications.xms.api.MtBatchBinarySmsCreate: Creates a builder of MtBatchBinarySmsCreate instances.
builder() - Static method in class com.clxcommunications.xms.api.MtBatchBinarySmsResult: Creates a builder of MtBatchBinarySmsResult instances.
builder() - Static method in class com.clxcommunications.xms.api.MtBatchBinarySmsUpdate: Creates a builder of MtBatchBinarySmsUpdate instances.
builder() - Static method in class com.clxcommunications.xms.api.MtBatchDryRunResult: Creates a builder of MtBatchDryRunResult instances.
builder() - Static method in class com.clxcommunications.xms.api.MtBatchDryRunResult.PerRecipient: Creates a builder of MtBatchDryRunResult.PerRecipient instances.
builder() - Static method in class com.clxcommunications.xms.api.MtBatchTextSmsCreate: Creates a builder of MtBatchTextSmsCreate instances.
builder() - Static method in class com.clxcommunications.xms.api.MtBatchTextSmsResult: Creates a builder of MtBatchTextSmsResult instances.
builder() - Static method in class com.clxcommunications.xms.api.MtBatchTextSmsUpdate: Creates a builder of MtBatchTextSmsUpdate instances.
builder() - Static method in class com.clxcommunications.xms.api.PagedBatchResult: Creates a builder of PagedBatchResult instances.
builder() - Static method in class com.clxcommunications.xms.api.PagedGroupResult: Creates a builder of PagedGroupResult instances.
builder() - Static method in class com.clxcommunications.xms.api.PagedInboundsResult: Creates a builder of PagedInboundsResult instances.
builder() - Static method in class com.clxcommunications.xms.api.ParameterValues: Creates a builder of ParameterValues instances.
builder() - Static method in class com.clxcommunications.xms.api.RecipientDeliveryReport: Creates a builder of RecipientDeliveryReport instances.
builder() - Static method in class com.clxcommunications.xms.api.TagsUpdate: Creates a builder of TagsUpdate instances.
builder() - Static method in class com.clxcommunications.xms.ApiConnection: Returns a fresh builder of API connections.
builder() - Static method in class com.clxcommunications.xms.BatchDeliveryReportParams: Creates a builder of BatchDeliveryReportParams instances.
builder() - Static method in class com.clxcommunications.xms.BatchFilter: Creates a builder of BatchFilter instances.
builder() - Static method in class com.clxcommunications.xms.GroupFilter: Creates a builder of GroupFilter instances.
builder() - Static method in class com.clxcommunications.xms.InboundsFilter: Creates a builder of InboundsFilter instances.

C

callbackUrl(URI) - Method in class com.clxcommunications.xms.api.MtBatchBinarySmsUpdate.Builder: Updates the callback URL.
callbackUrl() - Method in class com.clxcommunications.xms.api.MtBatchSmsCreate: The URL to which batch callbacks should be sent.
callbackUrl() - Method in class com.clxcommunications.xms.api.MtBatchSmsResult: The URL to which batch callbacks are sent.
callbackUrl() - Method in class com.clxcommunications.xms.api.MtBatchSmsUpdate: Description of how to update the batch callback URL.
callbackUrl(URI) - Method in class com.clxcommunications.xms.api.MtBatchTextSmsUpdate.Builder: Updates the callback URL.
callbackWrapper() - Method in class com.clxcommunications.xms.ApiConnection: The future callback wrapper to use in all API calls.
CallbackWrapper - Interface in com.clxcommunications.xms: This interface provides a method for wrapping a FutureCallback such that additional logic can be introduced to the callback.
cancelBatch(BatchId) - Method in class com.clxcommunications.xms.ApiConnection: Cancels the batch with the given batch ID.
cancelBatchAsync(BatchId, FutureCallback<MtBatchSmsResult>) - Method in class com.clxcommunications.xms.ApiConnection: Cancels the batch with the given batch ID.
canceled() - Method in class com.clxcommunications.xms.api.MtBatchSmsResult: Whether this batch has been canceled.
check() - Method in class com.clxcommunications.xms.api.MtBatchSmsCreate
check() - Method in class com.clxcommunications.xms.api.MtBatchSmsUpdate: Validates that this object is in a correct state.
check() - Method in class com.clxcommunications.xms.ApiConnection: Validates that this object is in a coherent state.
check() - Method in class com.clxcommunications.xms.BatchFilter: Verifies that the object is in a reasonable state.
check() - Method in class com.clxcommunications.xms.GroupFilter
check() - Method in class com.clxcommunications.xms.InboundsFilter: Verifies that this filter is in a reasonable state.
childGroupInsertions() - Method in class com.clxcommunications.xms.api.GroupUpdate: The child groups that should be added to this group.
childGroupRemovals() - Method in class com.clxcommunications.xms.api.GroupUpdate: The child groups that should be removed from this group.
childGroups() - Method in class com.clxcommunications.xms.api.GroupCreate: A collection of child groups that belong to this group.
childGroups() - Method in class com.clxcommunications.xms.api.GroupResult: This group's child groups.
close() - Method in class com.clxcommunications.xms.ApiConnection: Closes this API connection and releases associated resources.
close() - Method in class com.clxcommunications.xms.ApiHttpAsyncClient: Closes this client and releases any held resources.
ClxApi - Class in com.clxcommunications.xms: A collection of convenient static methods for building XMS objects.
ClxApi() - Constructor for class com.clxcommunications.xms.ClxApi
code() - Method in class com.clxcommunications.xms.api.ApiError: The machine readable error code.
Code() - Constructor for class com.clxcommunications.xms.api.ApiError.Code
code() - Method in class com.clxcommunications.xms.api.BatchDeliveryReport.Status: The delivery status code.
code() - Method in class com.clxcommunications.xms.api.RecipientDeliveryReport: The delivery report error code of the message.
codes() - Method in class com.clxcommunications.xms.BatchDeliveryReportParams: A set of status codes that should be fetched.
com.clxcommunications.xms - package com.clxcommunications.xms: This package contains a Java interface for the CLX Communications XMS API.
com.clxcommunications.xms.api - package com.clxcommunications.xms.api: A collection of classes that represent objects sent and received from the XMS REST API.
compareTo(BatchId) - Method in class com.clxcommunications.xms.api.BatchId
compareTo(GroupId) - Method in class com.clxcommunications.xms.api.GroupId
ConcurrentException - Exception in com.clxcommunications.xms: An exception that wraps checked exceptions.
ConcurrentException(Throwable) - Constructor for exception com.clxcommunications.xms.ConcurrentException: Builds a new concurrent exception object.
CONFLICT_GROUP_NAME - Static variable in class com.clxcommunications.xms.api.ApiError.Code: When creating a group with a name that already exists.
CONFLICT_SEND_AT - Static variable in class com.clxcommunications.xms.api.ApiError.Code: When deleting a message that has already been sent out.
content() - Method in class com.clxcommunications.xms.api.Page: The page content.
content() - Method in class com.clxcommunications.xms.api.PagedBatchResult
content() - Method in class com.clxcommunications.xms.api.PagedGroupResult
content() - Method in class com.clxcommunications.xms.api.PagedInboundsResult
count() - Method in class com.clxcommunications.xms.api.BatchDeliveryReport.Status: The number of individual messages in this status bucket.
createBatch(MtBatchTextSmsCreate) - Method in class com.clxcommunications.xms.ApiConnection: Creates the given batch and schedules it for submission.
createBatch(MtBatchBinarySmsCreate) - Method in class com.clxcommunications.xms.ApiConnection: Creates the given batch and schedules it for submission.
createBatchAsync(MtBatchTextSmsCreate, FutureCallback<MtBatchTextSmsResult>) - Method in class com.clxcommunications.xms.ApiConnection: Asynchronously creates the given text batch and schedules it for submission.
createBatchAsync(MtBatchBinarySmsCreate, FutureCallback<MtBatchBinarySmsResult>) - Method in class com.clxcommunications.xms.ApiConnection: Asynchronously creates the given binary batch and schedules it for submission.
createBatchDryRun(MtBatchSmsCreate, Boolean, Integer) - Method in class com.clxcommunications.xms.ApiConnection: Attempts to perform a dry run of the given batch.
createBatchDryRunAsync(MtBatchSmsCreate, Boolean, Integer, FutureCallback<MtBatchDryRunResult>) - Method in class com.clxcommunications.xms.ApiConnection: Asynchronously performs a dry run of the given batch.
createdAt() - Method in class com.clxcommunications.xms.api.GroupResult: The time at which this group was created
createdAt() - Method in class com.clxcommunications.xms.api.MtBatchSmsResult: The time when this batch was created.
createGroup(GroupCreate) - Method in class com.clxcommunications.xms.ApiConnection: Attempts to create the given group synchronously.
createGroupAsync(GroupCreate, FutureCallback<GroupResult>) - Method in class com.clxcommunications.xms.ApiConnection: Asynchronously creates the given group.

D

DEFAULT_ENDPOINT - Static variable in class com.clxcommunications.xms.ApiConnection: The default endpoint of this API connection.
defaultValue() - Method in class com.clxcommunications.xms.api.ParameterValues: The default substitution.
deleteGroup(GroupId) - Method in class com.clxcommunications.xms.ApiConnection: Deletes the given group.
deleteGroupAsync(GroupId, FutureCallback<Void>) - Method in class com.clxcommunications.xms.ApiConnection: Asynchronously deletes the group with the given group ID.
DELIVERED - Static variable in class com.clxcommunications.xms.api.DeliveryStatus: Message has been delivered.
deliveryReport(ReportType) - Method in class com.clxcommunications.xms.api.MtBatchBinarySmsUpdate.Builder: Updates the delivery report type of this batch.
deliveryReport() - Method in class com.clxcommunications.xms.api.MtBatchSmsCreate: The type of delivery report to request for this batch.
deliveryReport() - Method in class com.clxcommunications.xms.api.MtBatchSmsResult: The type of delivery report used for this batch.
deliveryReport() - Method in class com.clxcommunications.xms.api.MtBatchSmsUpdate: Description of how to update the batch delivery report value.
deliveryReport(ReportType) - Method in class com.clxcommunications.xms.api.MtBatchTextSmsUpdate.Builder: Updates the delivery report type of this batch.
DeliveryStatus - Class in com.clxcommunications.xms.api: Describes the different types of delivery reports supported by XMS.
DeliveryStatus() - Constructor for class com.clxcommunications.xms.api.DeliveryStatus
DISPATCHED - Static variable in class com.clxcommunications.xms.api.DeliveryStatus: Message has been dispatched and accepted for delivery by the SMSC.

E

elements() - Method in class com.clxcommunications.xms.PagedFetcher: Returns an iterable object that traverses all fetched elements across all associated pages.
encoding() - Method in class com.clxcommunications.xms.api.MtBatchDryRunResult.PerRecipient: The message encoding that will be applied for this recipient.
endDate() - Method in class com.clxcommunications.xms.BatchFilter: Limits results to batches send before this date.
endDate() - Method in class com.clxcommunications.xms.InboundsFilter: Limits results to inbound messages send before this date.
endpoint(String) - Method in class com.clxcommunications.xms.ApiConnection.Builder: Initializes the endpoint from the given URL string.
endpoint() - Method in class com.clxcommunications.xms.ApiConnection: The base endpoint of the XMS API.
endpointHost() - Method in class com.clxcommunications.xms.ApiConnection: The HTTP host providing the XMS API.
ErrorResponseException - Exception in com.clxcommunications.xms: Exception representing an error response from XMS.
exceptionDropper - Static variable in interface com.clxcommunications.xms.CallbackWrapper: A callback wrapper that catches and logs exceptions thrown within the wrapped callback at the ERROR level.
execute(HttpAsyncRequestProducer, HttpAsyncResponseConsumer<T>, HttpContext, FutureCallback<T>) - Method in class com.clxcommunications.xms.ApiHttpAsyncClient
execute(HttpAsyncRequestProducer, HttpAsyncResponseConsumer<T>, FutureCallback<T>) - Method in class com.clxcommunications.xms.ApiHttpAsyncClient
execute(HttpHost, HttpRequest, HttpContext, FutureCallback<HttpResponse>) - Method in class com.clxcommunications.xms.ApiHttpAsyncClient
execute(HttpHost, HttpRequest, FutureCallback<HttpResponse>) - Method in class com.clxcommunications.xms.ApiHttpAsyncClient
execute(HttpUriRequest, HttpContext, FutureCallback<HttpResponse>) - Method in class com.clxcommunications.xms.ApiHttpAsyncClient
execute(HttpUriRequest, FutureCallback<HttpResponse>) - Method in class com.clxcommunications.xms.ApiHttpAsyncClient
expireAt(OffsetDateTime) - Method in class com.clxcommunications.xms.api.MtBatchBinarySmsUpdate.Builder: Updates the batch expire time.
expireAt() - Method in class com.clxcommunications.xms.api.MtBatchSmsCreate: The time at which this batch will expire.
expireAt() - Method in class com.clxcommunications.xms.api.MtBatchSmsResult: The time when this batch will expire.
expireAt() - Method in class com.clxcommunications.xms.api.MtBatchSmsUpdate: Description of how to update the batch expire at value.
expireAt(OffsetDateTime) - Method in class com.clxcommunications.xms.api.MtBatchTextSmsUpdate.Builder: Updates the batch expire time.
EXPIRED - Static variable in class com.clxcommunications.xms.api.DeliveryStatus: Message expired before delivery.

F

FAILED - Static variable in class com.clxcommunications.xms.api.DeliveryStatus: Message failed to be delivered.
fetchBatch(BatchId) - Method in class com.clxcommunications.xms.ApiConnection: Fetches the given batch.
fetchBatchAsync(BatchId, FutureCallback<MtBatchSmsResult>) - Method in class com.clxcommunications.xms.ApiConnection: Fetches a batch with the given batch ID.
fetchBatches(BatchFilter) - Method in class com.clxcommunications.xms.ApiConnection: Creates a page fetcher to retrieve a paged list of batches.
fetchDeliveryReport(BatchId, BatchDeliveryReportParams) - Method in class com.clxcommunications.xms.ApiConnection: Fetches a delivery report for the batch with the given batch ID.
fetchDeliveryReport(BatchId, String) - Method in class com.clxcommunications.xms.ApiConnection: Fetches a delivery report for the batch with the given batch ID and recipient.
fetchDeliveryReportAsync(BatchId, BatchDeliveryReportParams, FutureCallback<BatchDeliveryReport>) - Method in class com.clxcommunications.xms.ApiConnection: Fetches a delivery report for the batch with the given batch ID.
fetchDeliveryReportAsync(BatchId, String, FutureCallback<RecipientDeliveryReport>) - Method in class com.clxcommunications.xms.ApiConnection: Fetches a delivery report for the batch with the given batch ID and recipient.
fetchGroup(GroupId) - Method in class com.clxcommunications.xms.ApiConnection: Attempts to fetch the given group.
fetchGroupAsync(GroupId, FutureCallback<GroupResult>) - Method in class com.clxcommunications.xms.ApiConnection: Asynchronously fetches the given group.
fetchGroupMembers(GroupId) - Method in class com.clxcommunications.xms.ApiConnection: Attempts to fetch the members of the given group synchronously.
fetchGroupMembersAsync(GroupId, FutureCallback<Set<String>>) - Method in class com.clxcommunications.xms.ApiConnection: Asynchronously fetches the members of the given group.
fetchGroups(GroupFilter) - Method in class com.clxcommunications.xms.ApiConnection: Creates a page fetcher to retrieve a paged list of groups.
fetchInbound(String) - Method in class com.clxcommunications.xms.ApiConnection: Fetches the inbound message having the given identifier.
fetchInboundAsync(String, FutureCallback<MoSms>) - Method in class com.clxcommunications.xms.ApiConnection: Fetches the inbound message having the given identifier.
fetchInbounds(InboundsFilter) - Method in class com.clxcommunications.xms.ApiConnection: Creates a page fetcher to retrieve a paged list of inbound messages.
fetchTags(BatchId) - Method in class com.clxcommunications.xms.ApiConnection: Fetches the tags of the batch with the given batch ID.
fetchTags(GroupId) - Method in class com.clxcommunications.xms.ApiConnection: Fetches the tags of the group with the given identifier.
fetchTagsAsync(BatchId, FutureCallback<Tags>) - Method in class com.clxcommunications.xms.ApiConnection: Fetches the tags of the batch with the given batch ID.
fetchTagsAsync(GroupId, FutureCallback<Tags>) - Method in class com.clxcommunications.xms.ApiConnection: Fetches the tags of the group with the given identifier.
firstWord() - Method in class com.clxcommunications.xms.api.KeywordPair: The first keyword.
FULL - Static variable in class com.clxcommunications.xms.api.ReportType: A full delivery report is desired or available.
fullReport() - Method in class com.clxcommunications.xms.BatchDeliveryReportParams.Builder: Request a full delivery report.

G

getCode() - Method in exception com.clxcommunications.xms.ErrorResponseException: The machine readable error code.
getPath() - Method in exception com.clxcommunications.xms.NotFoundException: Returns the REST API path that did not exist.
getResponse() - Method in exception com.clxcommunications.xms.UnexpectedResponseException: Returns the HTTP response that could not be handled.
getText() - Method in exception com.clxcommunications.xms.ErrorResponseException: The human readable error text.
GROUP_ID - Static variable in class com.clxcommunications.xms.Version: The Maven group ID of this SDK.
GroupCreate - Class in com.clxcommunications.xms.api: A class describing parameters available during group creation.
GroupCreate() - Constructor for class com.clxcommunications.xms.api.GroupCreate
groupCreate() - Static method in class com.clxcommunications.xms.ClxApi: Returns a freshly created builder of groups.
GroupCreate.Builder - Class in com.clxcommunications.xms.api: A builder of group creation descriptions.
groupFilter() - Static method in class com.clxcommunications.xms.ClxApi: Returns a freshly created builder of group filters.
GroupFilter - Class in com.clxcommunications.xms: Describes a filter for limiting results when fetching groups.
GroupFilter() - Constructor for class com.clxcommunications.xms.GroupFilter
GroupFilter.Builder - Class in com.clxcommunications.xms: A builder of group filters.
GroupId - Class in com.clxcommunications.xms.api: Representation of a group identifier.
GroupId() - Constructor for class com.clxcommunications.xms.api.GroupId
GroupResult - Class in com.clxcommunications.xms.api: Objects of this class contain information about a group.
GroupResult() - Constructor for class com.clxcommunications.xms.api.GroupResult
GroupResult.Builder - Class in com.clxcommunications.xms.api: A builder of group results.
GroupUpdate - Class in com.clxcommunications.xms.api: A description of updates that should be applied to a group.
GroupUpdate() - Constructor for class com.clxcommunications.xms.api.GroupUpdate
groupUpdate() - Static method in class com.clxcommunications.xms.ClxApi: Returns a freshly created builder of group updates.
GroupUpdate.Builder - Class in com.clxcommunications.xms.api: A builder of group updates.

H

httpClient() - Method in class com.clxcommunications.xms.ApiConnection: The HTTP client used by this connection.

I

id() - Method in class com.clxcommunications.xms.api.BatchId: The literal string representation of this batch identifier.
id() - Method in class com.clxcommunications.xms.api.GroupId: The literal string representation of this group identifier.
id() - Method in class com.clxcommunications.xms.api.GroupResult: The unique group ID that identifies this group.
id() - Method in class com.clxcommunications.xms.api.MoSms: The unique message identifier.
id() - Method in class com.clxcommunications.xms.api.MtBatchSmsResult: The unique batch identifier.
identity - Static variable in interface com.clxcommunications.xms.CallbackWrapper: The identity callback wrapper.
inboundsFilter() - Static method in class com.clxcommunications.xms.ClxApi: Returns a freshly created builder of inbound message filters.
InboundsFilter - Class in com.clxcommunications.xms: Describes a filter for limiting results when fetching inbound messages.
InboundsFilter() - Constructor for class com.clxcommunications.xms.InboundsFilter
InboundsFilter.Builder - Class in com.clxcommunications.xms: A builder of inbound messages filter.
isEmpty() - Method in class com.clxcommunications.xms.api.Page: Whether this page is empty, i.e., does not contain any elements.
isRunning() - Method in class com.clxcommunications.xms.ApiHttpAsyncClient: Whether this client is started.
isSet() - Method in class com.clxcommunications.xms.UpdateValue: Whether this update value is set or unset.
iterator() - Method in class com.clxcommunications.xms.api.Page: Returns an iterator that traverses the content of this page.
iterator() - Method in class com.clxcommunications.xms.api.Tags: Returns an iterator over this set of tags.

J

join(String, String...) - Static method in class com.clxcommunications.xms.Utils: Convenience method that joins the given strings using the given delimiter.
join(String, Iterable<String>) - Static method in class com.clxcommunications.xms.Utils: Convenience method that joins the given strings using the given delimiter.

K

keyword() - Method in class com.clxcommunications.xms.api.MoTextSms: The keyword provided with this MO message, if available.
KeywordPair - Class in com.clxcommunications.xms.api: A pair containing the first and second word of a group auto update trigger.
KeywordPair() - Constructor for class com.clxcommunications.xms.api.KeywordPair

M

memberInsertions() - Method in class com.clxcommunications.xms.api.GroupUpdate: The MSISDNs that should be added to this group.
memberRemovals() - Method in class com.clxcommunications.xms.api.GroupUpdate: The MSISDNs that should be removed from this group.
members() - Method in class com.clxcommunications.xms.api.GroupCreate: The MSISDNs that belong to this group.
MoBinarySms - Class in com.clxcommunications.xms.api: A binary mobile originated SMS message.
MoBinarySms() - Constructor for class com.clxcommunications.xms.api.MoBinarySms
MoBinarySms.Builder - Class in com.clxcommunications.xms.api: A builder of binary MO messages.
modifiedAt() - Method in class com.clxcommunications.xms.api.GroupResult: The time at which this group was last modified.
modifiedAt() - Method in class com.clxcommunications.xms.api.MtBatchSmsResult: The time when this batch was last modified.
MoSms - Class in com.clxcommunications.xms.api: Base class for mobile originated messages.
MoTextSms - Class in com.clxcommunications.xms.api: A mobile originated (MO) message with textual content.
MoTextSms() - Constructor for class com.clxcommunications.xms.api.MoTextSms
MoTextSms.Builder - Class in com.clxcommunications.xms.api: A builder of text MO messages.
MtBatchBinarySmsCreate - Class in com.clxcommunications.xms.api: Container of all necessary parameters to create a binary SMS batch message.
MtBatchBinarySmsCreate() - Constructor for class com.clxcommunications.xms.api.MtBatchBinarySmsCreate
MtBatchBinarySmsCreate.Builder - Class in com.clxcommunications.xms.api: A builder of binary batch messages.
MtBatchBinarySmsResult - Class in com.clxcommunications.xms.api: Objects of this class contain information about a binary SMS batch.
MtBatchBinarySmsResult() - Constructor for class com.clxcommunications.xms.api.MtBatchBinarySmsResult
MtBatchBinarySmsResult.Builder - Class in com.clxcommunications.xms.api: Builder of binary batch results.
MtBatchBinarySmsUpdate - Class in com.clxcommunications.xms.api: A description of updates that can be applied to a binary SMS batch message.
MtBatchBinarySmsUpdate() - Constructor for class com.clxcommunications.xms.api.MtBatchBinarySmsUpdate
MtBatchBinarySmsUpdate.Builder - Class in com.clxcommunications.xms.api: A builder of binary batch message updates.
MtBatchDryRunResult - Class in com.clxcommunications.xms.api: The result of a message batch dry-run.
MtBatchDryRunResult() - Constructor for class com.clxcommunications.xms.api.MtBatchDryRunResult
MtBatchDryRunResult.Builder - Class in com.clxcommunications.xms.api: A builder of batch dry-run results.
MtBatchDryRunResult.PerRecipient - Class in com.clxcommunications.xms.api: A per-recipient dry-run result.
MtBatchDryRunResult.PerRecipient.Builder - Class in com.clxcommunications.xms.api: A builder of per-recipient dry-run results.
MtBatchSmsCreate - Class in com.clxcommunications.xms.api: Base class for mobile terminated batch messages.
MtBatchSmsCreate() - Constructor for class com.clxcommunications.xms.api.MtBatchSmsCreate
MtBatchSmsResult - Class in com.clxcommunications.xms.api: Base class for batch description classes.
MtBatchSmsUpdate - Class in com.clxcommunications.xms.api: Objects of this type can be used to update previously submitted MT batches.
MtBatchSmsUpdate() - Constructor for class com.clxcommunications.xms.api.MtBatchSmsUpdate
MtBatchTextSmsCreate - Class in com.clxcommunications.xms.api: Container of all necessary parameters to create a text SMS batch message.
MtBatchTextSmsCreate() - Constructor for class com.clxcommunications.xms.api.MtBatchTextSmsCreate
MtBatchTextSmsCreate.Builder - Class in com.clxcommunications.xms.api: A builder of textual batch messages.
MtBatchTextSmsResult - Class in com.clxcommunications.xms.api: Objects of this class contain information about a textual SMS batch.
MtBatchTextSmsResult() - Constructor for class com.clxcommunications.xms.api.MtBatchTextSmsResult
MtBatchTextSmsResult.Builder - Class in com.clxcommunications.xms.api: Builder of textual batch results.
MtBatchTextSmsUpdate - Class in com.clxcommunications.xms.api: A description of updates that can be applied to a text SMS batch message.
MtBatchTextSmsUpdate() - Constructor for class com.clxcommunications.xms.api.MtBatchTextSmsUpdate
MtBatchTextSmsUpdate.Builder - Class in com.clxcommunications.xms.api: A builder of text batch message updates.

N

name() - Method in class com.clxcommunications.xms.api.GroupCreate: The group name.
name() - Method in class com.clxcommunications.xms.api.GroupResult: The group name.
name(String) - Method in class com.clxcommunications.xms.api.GroupUpdate.Builder: Updates the group name to the given name.
name() - Method in class com.clxcommunications.xms.api.GroupUpdate: The group name.
NONE - Static variable in class com.clxcommunications.xms.api.ReportType: No delivery report is desired or available.
NotFoundException - Exception in com.clxcommunications.xms: Exception thrown when an API connection receives a 404 response from the REST API.
NotFoundException(String) - Constructor for exception com.clxcommunications.xms.NotFoundException: Creates a new not found exception.
numberOfMessages() - Method in class com.clxcommunications.xms.api.MtBatchDryRunResult: The total number of individual messages of the batch.
numberOfParts() - Method in class com.clxcommunications.xms.api.MtBatchDryRunResult.PerRecipient: The number of message parts that were sent to this recipient.
numberOfRecipients() - Method in class com.clxcommunications.xms.api.MtBatchDryRunResult: The total number of batch recipients.

O

of(String, String) - Static method in class com.clxcommunications.xms.api.ApiError: Creates a new API error object from the given code and text.
of(String) - Static method in class com.clxcommunications.xms.api.BatchId: Builds an immutable BatchId having the given literal representation.
of(String) - Static method in class com.clxcommunications.xms.api.DeliveryStatus: Creates a delivery status object from the given string representation.
of(String) - Static method in class com.clxcommunications.xms.api.GroupId: Builds an immutable GroupId having the given literal representation.
of(String, String) - Static method in class com.clxcommunications.xms.api.KeywordPair: Builder of keyword pairs.
of(String) - Static method in class com.clxcommunications.xms.api.ReportType: Builds an immutable ReportType having the given literal representation.
of(Iterable<String>) - Static method in class com.clxcommunications.xms.api.Tags: Constructs a new tag collection containing the given tags.
of(String...) - Static method in class com.clxcommunications.xms.api.Tags: Constructs a new tag collection containing the given tags.
of() - Static method in class com.clxcommunications.xms.ApiHttpAsyncClient: Creates a new asynchronous HTTP client suitable for communicating with XMS.
operator() - Method in class com.clxcommunications.xms.api.MoSms: The MCCMNC of the originating operator, if available.
operator() - Method in class com.clxcommunications.xms.api.RecipientDeliveryReport: The operator MCCMNC, if available.
operatorStatusAt() - Method in class com.clxcommunications.xms.api.RecipientDeliveryReport: The message timestamp as recorded by the network operator, if message dispatched.

P

Page<T> - Class in com.clxcommunications.xms.api: A page within a paged XMS response.
Page() - Constructor for class com.clxcommunications.xms.api.Page
page() - Method in class com.clxcommunications.xms.api.Page: The page number of this page.
PagedBatchResult - Class in com.clxcommunications.xms.api: A page within a paged batch listing.
PagedBatchResult() - Constructor for class com.clxcommunications.xms.api.PagedBatchResult
PagedBatchResult.Builder - Class in com.clxcommunications.xms.api: A builder of batch result pages.
PagedFetcher<T> - Class in com.clxcommunications.xms: Used for API calls that emits their result over multiple pages.
PagedFetcher() - Constructor for class com.clxcommunications.xms.PagedFetcher
PagedGroupResult - Class in com.clxcommunications.xms.api: A page within a paged group listing.
PagedGroupResult() - Constructor for class com.clxcommunications.xms.api.PagedGroupResult
PagedGroupResult.Builder - Class in com.clxcommunications.xms.api: A builder of group result pages.
PagedInboundsResult - Class in com.clxcommunications.xms.api: A page within a paged inbound messages listing.
PagedInboundsResult() - Constructor for class com.clxcommunications.xms.api.PagedInboundsResult
PagedInboundsResult.Builder - Class in com.clxcommunications.xms.api: A builder of inbound messages result pages.
pages() - Method in class com.clxcommunications.xms.PagedFetcher: Returns an iterable object that fetches and traverses all matching pages.
pageSize() - Method in class com.clxcommunications.xms.BatchFilter: The requested number of entries per page.
pageSize() - Method in class com.clxcommunications.xms.GroupFilter: The requested number of entries per page.
pageSize() - Method in class com.clxcommunications.xms.InboundsFilter: The requested number of entries per page.
parameters() - Method in class com.clxcommunications.xms.api.MtBatchTextSmsCreate: The message template parameter substitutions.
parameters() - Method in class com.clxcommunications.xms.api.MtBatchTextSmsResult: The message template parameter substitutions.
parameters(Map<String, ParameterValues>) - Method in class com.clxcommunications.xms.api.MtBatchTextSmsUpdate.Builder: Replaces the batch parameters to the ones in the given map.
parameters() - Method in class com.clxcommunications.xms.api.MtBatchTextSmsUpdate: Description of how to update the batch parameters.
ParameterValues - Class in com.clxcommunications.xms.api: A description of possible substitution values for a template parameter.
ParameterValues() - Constructor for class com.clxcommunications.xms.api.ParameterValues
parameterValues() - Static method in class com.clxcommunications.xms.ClxApi: Returns a freshly created builder of text message parameter substitutions.
ParameterValues.Builder - Class in com.clxcommunications.xms.api: A builder of parameter substitution values.
PER_RECIPIENT - Static variable in class com.clxcommunications.xms.api.ReportType: A per recipient delivery report is desired or available.
perRecipient() - Method in class com.clxcommunications.xms.api.MtBatchDryRunResult: Information on a per-recipient level.
PerRecipient() - Constructor for class com.clxcommunications.xms.api.MtBatchDryRunResult.PerRecipient
prettyPrintJson() - Method in class com.clxcommunications.xms.ApiConnection: Whether the JSON sent to the server should be printed with indentation.

Q

QUEUED - Static variable in class com.clxcommunications.xms.api.DeliveryStatus: Message is queued within REST API system and will be dispatched according to the rate of the account.

R

receivedAt() - Method in class com.clxcommunications.xms.api.MoSms: Timestamp for when the messaging system received the message.
recipient() - Method in class com.clxcommunications.xms.api.AutoUpdate: An MSISDN or short code.
recipient() - Method in class com.clxcommunications.xms.api.MoSms: The recipient of this mobile originated message.
recipient() - Method in class com.clxcommunications.xms.api.MtBatchDryRunResult.PerRecipient: The recipient to whom this result refers.
recipient() - Method in class com.clxcommunications.xms.api.RecipientDeliveryReport: The recipient to which this delivery report refers.
RecipientDeliveryReport - Class in com.clxcommunications.xms.api: Representation of a delivery report for a specific recipient.
RecipientDeliveryReport() - Constructor for class com.clxcommunications.xms.api.RecipientDeliveryReport
RecipientDeliveryReport.Builder - Class in com.clxcommunications.xms.api: A builder of recipient delivery reports.
recipientInsertions() - Method in class com.clxcommunications.xms.api.MtBatchSmsUpdate: The message destinations to add to the batch.
recipientRemovals() - Method in class com.clxcommunications.xms.api.MtBatchSmsUpdate: The message destinations to remove from the batch.
recipients() - Method in class com.clxcommunications.xms.api.BatchDeliveryReport.Status: The recipients having this status.
recipients() - Method in class com.clxcommunications.xms.api.MtBatchSmsCreate: The list of message recipients.
recipients() - Method in class com.clxcommunications.xms.api.MtBatchSmsResult: The list of message recipients.
recipients() - Method in class com.clxcommunications.xms.InboundsFilter: Limits results to inbound messages destined for one of these numbers.
REJECTED - Static variable in class com.clxcommunications.xms.api.DeliveryStatus: Message was rejected by SMSC.
remove(String, String) - Method in class com.clxcommunications.xms.api.AutoUpdate.Builder: The keyword trigger to use for removing a number to a group.
remove() - Method in class com.clxcommunications.xms.api.AutoUpdate: The keyword trigger used to remove a member.
removeFromGroup() - Method in class com.clxcommunications.xms.api.GroupUpdate: Identifier of a group whose members should be removed to this group.
replaceBatch(BatchId, MtBatchTextSmsCreate) - Method in class com.clxcommunications.xms.ApiConnection: Replaces the batch with the given identifier.
replaceBatch(BatchId, MtBatchBinarySmsCreate) - Method in class com.clxcommunications.xms.ApiConnection: Replaces the batch with the given identifier.
replaceBatchAsync(BatchId, MtBatchTextSmsCreate, FutureCallback<MtBatchTextSmsResult>) - Method in class com.clxcommunications.xms.ApiConnection: Asynchronously replaces the batch with the given identifier.
replaceBatchAsync(BatchId, MtBatchBinarySmsCreate, FutureCallback<MtBatchBinarySmsResult>) - Method in class com.clxcommunications.xms.ApiConnection: Asynchronously replaces the batch with the given identifier.
replaceGroup(GroupId, GroupCreate) - Method in class com.clxcommunications.xms.ApiConnection: Replaces the given group.
replaceGroupAsync(GroupId, GroupCreate, FutureCallback<GroupResult>) - Method in class com.clxcommunications.xms.ApiConnection: Asynchronously replaces the group with the given group ID.
replaceTags(BatchId, Tags) - Method in class com.clxcommunications.xms.ApiConnection: Replaces the tags of the batch with the given batch ID.
replaceTags(GroupId, Tags) - Method in class com.clxcommunications.xms.ApiConnection: Replaces the tags of the group with the given identifier.
replaceTagsAsync(BatchId, Tags, FutureCallback<Tags>) - Method in class com.clxcommunications.xms.ApiConnection: Replaces the tags of the batch with the given batch ID.
replaceTagsAsync(GroupId, Tags, FutureCallback<Tags>) - Method in class com.clxcommunications.xms.ApiConnection: Replaces the tags of the group with the given identifier.
ReportType - Class in com.clxcommunications.xms.api: Describes the different types of delivery reports supported by XMS.
ReportType() - Constructor for class com.clxcommunications.xms.api.ReportType
reportType() - Method in class com.clxcommunications.xms.BatchDeliveryReportParams: The desired report type.
RuntimeApiException - Exception in com.clxcommunications.xms: A wrapper of ApiException for use where checked exceptions cannot be thrown.
RuntimeApiException(ApiException) - Constructor for exception com.clxcommunications.xms.RuntimeApiException: Constructs a new runtime API exception wrapping the given API exception.

S

secondWord() - Method in class com.clxcommunications.xms.api.KeywordPair: The second keyword.
sendAt(OffsetDateTime) - Method in class com.clxcommunications.xms.api.MtBatchBinarySmsUpdate.Builder: Updates the scheduled send time.
sendAt() - Method in class com.clxcommunications.xms.api.MtBatchSmsCreate: The time this batch should be sent.
sendAt() - Method in class com.clxcommunications.xms.api.MtBatchSmsResult: The scheduled time this batch will be sent.
sendAt() - Method in class com.clxcommunications.xms.api.MtBatchSmsUpdate: Description of how to update the batch send at value.
sendAt(OffsetDateTime) - Method in class com.clxcommunications.xms.api.MtBatchTextSmsUpdate.Builder: Updates the scheduled send time.
sender() - Method in class com.clxcommunications.xms.api.MoSms: The originating MSISDN.
sender() - Method in class com.clxcommunications.xms.api.MtBatchSmsCreate: The message originator.
sender() - Method in class com.clxcommunications.xms.api.MtBatchSmsResult: The message originator.
sender() - Method in class com.clxcommunications.xms.api.MtBatchSmsUpdate: The message originator.
senders() - Method in class com.clxcommunications.xms.BatchFilter: Limits results to batches sent from the given addresses.
sentAt() - Method in class com.clxcommunications.xms.api.MoSms: Timestamp for when this message was sent.
servicePlanId() - Method in class com.clxcommunications.xms.ApiConnection: The XMS service plan identifier.
set(T) - Static method in class com.clxcommunications.xms.UpdateValue: An update value indicating that the value should be changed.
size() - Method in class com.clxcommunications.xms.api.GroupResult: The number of members in the group.
size() - Method in class com.clxcommunications.xms.api.Page: The number of elements in this page.
start() - Method in class com.clxcommunications.xms.ApiConnection.Builder: Builds and starts the defined API connection.
start() - Method in class com.clxcommunications.xms.ApiConnection: Starts up this API connection.
start() - Method in class com.clxcommunications.xms.ApiHttpAsyncClient: Starts this client.
startDate() - Method in class com.clxcommunications.xms.BatchFilter: Limits results to batches sent at or after this date.
startDate() - Method in class com.clxcommunications.xms.InboundsFilter: Limits results to inbound messages sent at or after this date.
Status() - Constructor for class com.clxcommunications.xms.api.BatchDeliveryReport.Status
status() - Method in class com.clxcommunications.xms.api.BatchDeliveryReport.Status: The delivery status for this bucket.
status() - Method in class com.clxcommunications.xms.api.DeliveryStatus: The string representation of this delivery status.
status() - Method in class com.clxcommunications.xms.api.RecipientDeliveryReport: The delivery status of the message.
statuses() - Method in class com.clxcommunications.xms.api.BatchDeliveryReport: A list of statuses for the batch.
statuses() - Method in class com.clxcommunications.xms.BatchDeliveryReportParams: A set of delivery statuses that should be fetched.
statusMessage() - Method in class com.clxcommunications.xms.api.RecipientDeliveryReport: A description of the status, if available.
substitutions() - Method in class com.clxcommunications.xms.api.ParameterValues: Describes per-recipient substitutions for a text message template.
SUMMARY - Static variable in class com.clxcommunications.xms.api.ReportType: A summary delivery report is desired or available.
summaryReport() - Method in class com.clxcommunications.xms.BatchDeliveryReportParams.Builder: Request a summary delivery report.
SYNTAX_CONSTRAINT_VIOLATION - Static variable in class com.clxcommunications.xms.api.ApiError.Code: The request body doesn’t fulfill all of the constraints set by the API.
SYNTAX_INVALID_JSON - Static variable in class com.clxcommunications.xms.api.ApiError.Code: The request body is not valid JSON.
SYNTAX_INVALID_PARAMETER_FORMAT - Static variable in class com.clxcommunications.xms.api.ApiError.Code: The format of a parameter is invalid.

T

tagInsertions() - Method in class com.clxcommunications.xms.api.TagsUpdate: A set of tags to add to a given object.
tagRemovals() - Method in class com.clxcommunications.xms.api.TagsUpdate: A set of tags to remove from a given object.
tags() - Method in class com.clxcommunications.xms.api.GroupCreate: The tags associated to this group.
tags() - Method in class com.clxcommunications.xms.api.MtBatchSmsCreate: The tags that should be attached to this message.
Tags - Class in com.clxcommunications.xms.api: A representation of a set of tags.
Tags() - Constructor for class com.clxcommunications.xms.api.Tags
tags() - Method in class com.clxcommunications.xms.api.Tags: A set representation of this collection of tags.
tags() - Method in class com.clxcommunications.xms.BatchFilter: Limits results to batches having any the given tags.
tags() - Method in class com.clxcommunications.xms.GroupFilter: If non-empty then only groups with one or more of these tags are retained.
TagsUpdate - Class in com.clxcommunications.xms.api: A description of updates to a set of tags.
TagsUpdate() - Constructor for class com.clxcommunications.xms.api.TagsUpdate
tagsUpdate() - Static method in class com.clxcommunications.xms.ClxApi: Returns a freshly created tags update builder.
TagsUpdate.Builder - Class in com.clxcommunications.xms.api: A builder of tag updates
text() - Method in class com.clxcommunications.xms.api.ApiError: The human readable error message.
token() - Method in class com.clxcommunications.xms.ApiConnection: The XMS authentication token.
toString() - Method in class com.clxcommunications.xms.api.BatchId: The string representation of this batch identifier.
toString() - Method in class com.clxcommunications.xms.api.GroupId: The string representation of this group identifier.
toString() - Method in class com.clxcommunications.xms.api.ReportType: The string representation of this report type.
toString() - Method in class com.clxcommunications.xms.api.Tags
toString() - Method in class com.clxcommunications.xms.UpdateValue
totalMessageCount() - Method in class com.clxcommunications.xms.api.BatchDeliveryReport: The total number of messages in the batch.
totalSize() - Method in class com.clxcommunications.xms.api.Page: The total number of elements across all pages.
type() - Method in class com.clxcommunications.xms.api.ReportType: The literal string representation of this report type.

U

udh() - Method in class com.clxcommunications.xms.api.MoBinarySms: The User Data Header of the message.
udh() - Method in class com.clxcommunications.xms.api.MtBatchBinarySmsCreate: The User Data Header of the message.
udh() - Method in class com.clxcommunications.xms.api.MtBatchBinarySmsResult: The User Data Header of the message.
udh() - Method in class com.clxcommunications.xms.api.MtBatchBinarySmsUpdate: The updated User Data Header of the message.
UnauthorizedException - Exception in com.clxcommunications.xms: Exception indicating that the service plan ID and authentication token were invalid.
UnexpectedResponseException - Exception in com.clxcommunications.xms: Exception thrown when an API connection receives a response from the REST API that is neither a success response nor an API level error.
UnexpectedResponseException(HttpResponse) - Constructor for exception com.clxcommunications.xms.UnexpectedResponseException: Creates a new unexpected response exception.
UNKNOWN - Static variable in class com.clxcommunications.xms.api.DeliveryStatus: It is not known if message was delivered or not.
UNKNOWN_GROUP - Static variable in class com.clxcommunications.xms.api.ApiError.Code: An unknown group was referenced in the request body.
unset() - Static method in class com.clxcommunications.xms.UpdateValue: An update value indicating that the value should be reset to its default value.
unsetAutoUpdate() - Method in class com.clxcommunications.xms.api.GroupUpdate.Builder: Unsets the group auto update setting.
unsetCallbackUrl() - Method in class com.clxcommunications.xms.api.MtBatchBinarySmsUpdate.Builder: Resets the callback URL to the default callback URL.
unsetCallbackUrl() - Method in class com.clxcommunications.xms.api.MtBatchTextSmsUpdate.Builder: Resets the callback URL to the default callback URL.
unsetDeliveryReport() - Method in class com.clxcommunications.xms.api.MtBatchBinarySmsUpdate.Builder: Resets the delivery report type to the messaging system default value.
unsetDeliveryReport() - Method in class com.clxcommunications.xms.api.MtBatchTextSmsUpdate.Builder: Resets the delivery report type to the messaging system default value.
unsetExpireAt() - Method in class com.clxcommunications.xms.api.MtBatchBinarySmsUpdate.Builder: Resets the batch expire time to the messaging system default value.
unsetExpireAt() - Method in class com.clxcommunications.xms.api.MtBatchTextSmsUpdate.Builder: Resets the batch expire time to the messaging system default value.
unsetName() - Method in class com.clxcommunications.xms.api.GroupUpdate.Builder: Unsets the name of the group.
unsetParameters() - Method in class com.clxcommunications.xms.api.MtBatchTextSmsUpdate.Builder: Unsets the batch parameters.
unsetSendAt() - Method in class com.clxcommunications.xms.api.MtBatchBinarySmsUpdate.Builder: Unsets the scheduled send time.
unsetSendAt() - Method in class com.clxcommunications.xms.api.MtBatchTextSmsUpdate.Builder: Unsets the scheduled send time.
updateBatch(BatchId, MtBatchTextSmsUpdate) - Method in class com.clxcommunications.xms.ApiConnection: Updates the given text batch.
updateBatch(BatchId, MtBatchBinarySmsUpdate) - Method in class com.clxcommunications.xms.ApiConnection: Updates the given binary batch.
updateBatchAsync(BatchId, MtBatchTextSmsUpdate, FutureCallback<MtBatchTextSmsResult>) - Method in class com.clxcommunications.xms.ApiConnection: Asynchronously updates the text batch with the given batch ID.
updateBatchAsync(BatchId, MtBatchBinarySmsUpdate, FutureCallback<MtBatchBinarySmsResult>) - Method in class com.clxcommunications.xms.ApiConnection: Asynchronously updates the binary batch with the given batch ID.
updateGroup(GroupId, GroupUpdate) - Method in class com.clxcommunications.xms.ApiConnection: Updates the given group.
updateGroupAsync(GroupId, GroupUpdate, FutureCallback<GroupResult>) - Method in class com.clxcommunications.xms.ApiConnection: Asynchronously updates the group with the given group ID.
updateTags(BatchId, TagsUpdate) - Method in class com.clxcommunications.xms.ApiConnection: Updates the tags of the batch with the given batch ID.
updateTags(GroupId, TagsUpdate) - Method in class com.clxcommunications.xms.ApiConnection: Updates the tags of the group with the given identifier.
updateTagsAsync(BatchId, TagsUpdate, FutureCallback<Tags>) - Method in class com.clxcommunications.xms.ApiConnection: Updates the tags of the batch with the given batch ID.
updateTagsAsync(GroupId, TagsUpdate, FutureCallback<Tags>) - Method in class com.clxcommunications.xms.ApiConnection: Updates the tags of the group with the given identifier.
UpdateValue<T> - Class in com.clxcommunications.xms: Wrapper class for API objects used for update API methods.
UpdateValue() - Constructor for class com.clxcommunications.xms.UpdateValue
Utils - Class in com.clxcommunications.xms: This class holds a number of static convenience methods for use within the SDK.
Utils() - Constructor for class com.clxcommunications.xms.Utils

V

valueOf(String) - Static method in enum com.clxcommunications.xms.BatchDeliveryReportParams.ReportType: Returns the enum constant of this type with the specified name.
valueOrNull() - Method in class com.clxcommunications.xms.UpdateValue: Returns the update value or null if unset.
values() - Static method in enum com.clxcommunications.xms.BatchDeliveryReportParams.ReportType: Returns an array containing the constants of this enum type, in the order they are declared.
Version - Class in com.clxcommunications.xms: A container of some static information concerning this CLX SDK.
Version() - Constructor for class com.clxcommunications.xms.Version
VERSION - Static variable in class com.clxcommunications.xms.Version: The version of this SDK.

W

wrap(FutureCallback<T>) - Method in interface com.clxcommunications.xms.CallbackWrapper: Wraps the given callback.

A B C D E F G H I J K M N O P Q R S T U V W