com.clxcommunications.xms.api

Class MtBatchTextSmsResult

java.lang.Object

com.clxcommunications.xms.api.MtBatchSmsResult

com.clxcommunications.xms.api.MtBatchTextSmsResult

@Value.Immutable
public abstract class MtBatchTextSmsResult
extends MtBatchSmsResult

Objects of this class contain information about a textual SMS batch. The information includes the text message body, the batch identifier, the creation time, and so on.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MtBatchTextSmsResult.Builder Builder of textual batch results.

Constructor Summary

Constructors

Constructor and Description
MtBatchTextSmsResult()

Method Summary

Modifier and Type	Method and Description
abstract String	body() The message text or template.
static MtBatchTextSmsResult.Builder	builder() Creates a builder of MtBatchTextSmsResult instances.
abstract Map<String,ParameterValues>	parameters() The message template parameter substitutions.

Methods inherited from class com.clxcommunications.xms.api.MtBatchSmsResult

callbackUrl, canceled, createdAt, deliveryReport, expireAt, id, modifiedAt, recipients, sendAt, sender

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MtBatchTextSmsResult

public MtBatchTextSmsResult()

Method Detail

builder

@Nonnull
public static final MtBatchTextSmsResult.Builder builder()

Creates a builder of MtBatchTextSmsResult instances.

Returns:

a builder

body

public abstract String body()

The message text or template. If this describes a template then parameters() describes the parameter substitutions.

See MtBatchTextSmsCreate.body() for a more thorough description of this field.

Returns:

the message to send

parameters

public abstract Map<String,ParameterValues> parameters()

The message template parameter substitutions. If body() describes a template then this returns the substitutions for the template parameters.

Returns:

a map from template variable to parameter values

See Also:

body()