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 |
---|---|
MtBatchSmsResult |
ApiConnection.cancelBatch(BatchId batchId)
Cancels the batch with the given batch ID.
|
Future<MtBatchSmsResult> |
ApiConnection.cancelBatchAsync(BatchId batchId,
FutureCallback<MtBatchSmsResult> callback)
Cancels the batch with the given batch ID.
|
MtBatchSmsResult |
ApiConnection.fetchBatch(BatchId id)
Fetches the given batch.
|
Future<MtBatchSmsResult> |
ApiConnection.fetchBatchAsync(BatchId batchId,
FutureCallback<MtBatchSmsResult> callback)
Fetches a batch with the given batch ID.
|
BatchDeliveryReport |
ApiConnection.fetchDeliveryReport(BatchId id,
BatchDeliveryReportParams filter)
Fetches a delivery report for the batch with the given batch ID.
|
RecipientDeliveryReport |
ApiConnection.fetchDeliveryReport(BatchId id,
String recipient)
Fetches a delivery report for the batch with the given batch ID and
recipient.
|
Future<BatchDeliveryReport> |
ApiConnection.fetchDeliveryReportAsync(BatchId id,
BatchDeliveryReportParams filter,
FutureCallback<BatchDeliveryReport> callback)
Fetches a delivery report for the batch with the given batch ID.
|
Future<RecipientDeliveryReport> |
ApiConnection.fetchDeliveryReportAsync(BatchId id,
String recipient,
FutureCallback<RecipientDeliveryReport> callback)
Fetches a delivery report for the batch with the given batch ID and
recipient.
|
Tags |
ApiConnection.fetchTags(BatchId id)
Fetches the tags of the batch with the given batch ID.
|
Future<Tags> |
ApiConnection.fetchTagsAsync(BatchId id,
FutureCallback<Tags> callback)
Fetches the tags of the batch with the given batch ID.
|
MtBatchBinarySmsResult |
ApiConnection.replaceBatch(BatchId id,
MtBatchBinarySmsCreate sms)
Replaces the batch with the given identifier.
|
MtBatchTextSmsResult |
ApiConnection.replaceBatch(BatchId id,
MtBatchTextSmsCreate sms)
Replaces the batch with the given identifier.
|
Future<MtBatchBinarySmsResult> |
ApiConnection.replaceBatchAsync(BatchId id,
MtBatchBinarySmsCreate sms,
FutureCallback<MtBatchBinarySmsResult> callback)
Asynchronously replaces the batch with the given identifier.
|
Future<MtBatchTextSmsResult> |
ApiConnection.replaceBatchAsync(BatchId id,
MtBatchTextSmsCreate sms,
FutureCallback<MtBatchTextSmsResult> callback)
Asynchronously replaces the batch with the given identifier.
|
Tags |
ApiConnection.replaceTags(BatchId id,
Tags tags)
Replaces the tags of the batch with the given batch ID.
|
Future<Tags> |
ApiConnection.replaceTagsAsync(BatchId id,
Tags tags,
FutureCallback<Tags> callback)
Replaces the tags of the batch with the given batch ID.
|
MtBatchBinarySmsResult |
ApiConnection.updateBatch(BatchId id,
MtBatchBinarySmsUpdate sms)
Updates the given binary batch.
|
MtBatchTextSmsResult |
ApiConnection.updateBatch(BatchId id,
MtBatchTextSmsUpdate sms)
Updates the given text batch.
|
Future<MtBatchBinarySmsResult> |
ApiConnection.updateBatchAsync(BatchId batchId,
MtBatchBinarySmsUpdate sms,
FutureCallback<MtBatchBinarySmsResult> callback)
Asynchronously updates the binary batch with the given batch ID.
|
Future<MtBatchTextSmsResult> |
ApiConnection.updateBatchAsync(BatchId batchId,
MtBatchTextSmsUpdate sms,
FutureCallback<MtBatchTextSmsResult> callback)
Asynchronously updates the text batch with the given batch ID.
|
Tags |
ApiConnection.updateTags(BatchId id,
TagsUpdate tags)
Updates the tags of the batch with the given batch ID.
|
Future<Tags> |
ApiConnection.updateTagsAsync(BatchId id,
TagsUpdate tags,
FutureCallback<Tags> callback)
Updates the tags of the batch with the given batch ID.
|
Modifier and Type | Method and Description |
---|---|
abstract BatchId |
BatchDeliveryReport.batchId()
Identifier of the batch to which this delivery report refers.
|
abstract BatchId |
RecipientDeliveryReport.batchId()
The batch to which this delivery report belongs
|
abstract BatchId |
MtBatchSmsResult.id()
The unique batch identifier.
|
static BatchId |
BatchId.of(String id)
Builds an immutable
BatchId having the given literal
representation. |
Modifier and Type | Method and Description |
---|---|
int |
BatchId.compareTo(BatchId o) |
Copyright © 2016–2019 CLX Communications. All rights reserved.