com.clxcommunications.xms.api

Class AutoUpdate

java.lang.Object

com.clxcommunications.xms.api.AutoUpdate

@Value.Immutable
public abstract class AutoUpdate
extends Object

Describes auto updates of groups. Auto updates allow end users to add or remove themselves from groups.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutoUpdate.Builder A builder of auto update descriptions.

Constructor Summary

Constructors

Constructor and Description
AutoUpdate()

Method Summary

Modifier and Type	Method and Description
abstract KeywordPair	add() The keyword trigger used to add a member.
static AutoUpdate.Builder	builder() Creates a builder of AutoUpdate instances.
abstract String	recipient() An MSISDN or short code.
abstract KeywordPair	remove() The keyword trigger used to remove a member.

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoUpdate

public AutoUpdate()

Method Detail

builder

@Nonnull
public static final AutoUpdate.Builder builder()

Creates a builder of AutoUpdate instances.

Returns:

a builder

recipient

public abstract String recipient()

An MSISDN or short code. A mobile originated message sent to this address can trigger the auto update if a matching keyword is found.

Returns:

a non-null MSISDN or short code

add

@Nullable
public abstract KeywordPair add()

The keyword trigger used to add a member.

Returns:

a keyword pair

remove

@Nullable
public abstract KeywordPair remove()

The keyword trigger used to remove a member.

Returns:

a keyword pair