com.amazonaws.services.pinpoint.model

Class SMSMessage

java.lang.Object

com.amazonaws.services.pinpoint.model.SMSMessage

All Implemented Interfaces:

java.io.Serializable

public class SMSMessage
extends java.lang.Object
implements java.io.Serializable

SMS Message.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SMSMessage()

Method Summary

Modifier and Type	Method and Description
SMSMessage	addSubstitutionsEntry(java.lang.String key, java.util.List<java.lang.String> value) Default message substitutions.
SMSMessage	clearSubstitutionsEntries() Removes all the entries added into Substitutions.
boolean	equals(java.lang.Object obj)
java.lang.String	getBody() The body of the SMS message.
java.lang.String	getKeyword() The SMS program name that you provided to AWS Support when you requested your dedicated number.
java.lang.String	getMessageType() Is this a transaction priority message or lower priority.
java.lang.String	getOriginationNumber() The phone number that the SMS message originates from.
java.lang.String	getSenderId() The sender ID that is shown as the message sender on the recipient's device.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getSubstitutions() Default message substitutions.
int	hashCode()
void	setBody(java.lang.String body) The body of the SMS message.
void	setKeyword(java.lang.String keyword) The SMS program name that you provided to AWS Support when you requested your dedicated number.
void	setMessageType(MessageType messageType) Is this a transaction priority message or lower priority.
void	setMessageType(java.lang.String messageType) Is this a transaction priority message or lower priority.
void	setOriginationNumber(java.lang.String originationNumber) The phone number that the SMS message originates from.
void	setSenderId(java.lang.String senderId) The sender ID that is shown as the message sender on the recipient's device.
void	setSubstitutions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions) Default message substitutions.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SMSMessage	withBody(java.lang.String body) The body of the SMS message.
SMSMessage	withKeyword(java.lang.String keyword) The SMS program name that you provided to AWS Support when you requested your dedicated number.
SMSMessage	withMessageType(MessageType messageType) Is this a transaction priority message or lower priority.
SMSMessage	withMessageType(java.lang.String messageType) Is this a transaction priority message or lower priority.
SMSMessage	withOriginationNumber(java.lang.String originationNumber) The phone number that the SMS message originates from.
SMSMessage	withSenderId(java.lang.String senderId) The sender ID that is shown as the message sender on the recipient's device.
SMSMessage	withSubstitutions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions) Default message substitutions.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SMSMessage

public SMSMessage()

Method Detail

getBody

public java.lang.String getBody()

The body of the SMS message.

Returns:

The body of the SMS message.

setBody

public void setBody(java.lang.String body)

The body of the SMS message.

Parameters:

body - The body of the SMS message.

withBody

public SMSMessage withBody(java.lang.String body)

The body of the SMS message.

Returns a reference to this object so that method calls can be chained together.

Parameters:

body - The body of the SMS message.

Returns:

A reference to this updated object so that method calls can be chained together.

getKeyword

public java.lang.String getKeyword()

The SMS program name that you provided to AWS Support when you requested your dedicated number.

Returns:

The SMS program name that you provided to AWS Support when you requested your dedicated number.

setKeyword

public void setKeyword(java.lang.String keyword)

The SMS program name that you provided to AWS Support when you requested your dedicated number.

Parameters:

keyword - The SMS program name that you provided to AWS Support when you requested your dedicated number.

withKeyword

public SMSMessage withKeyword(java.lang.String keyword)

The SMS program name that you provided to AWS Support when you requested your dedicated number.

Returns a reference to this object so that method calls can be chained together.

Parameters:

keyword - The SMS program name that you provided to AWS Support when you requested your dedicated number.

Returns:

A reference to this updated object so that method calls can be chained together.

getMessageType

public java.lang.String getMessageType()

Is this a transaction priority message or lower priority.

Constraints:
Allowed Values: TRANSACTIONAL, PROMOTIONAL

Returns:

Is this a transaction priority message or lower priority.

See Also:

MessageType

setMessageType

public void setMessageType(java.lang.String messageType)

Is this a transaction priority message or lower priority.

Constraints:
Allowed Values: TRANSACTIONAL, PROMOTIONAL

Parameters:

messageType - Is this a transaction priority message or lower priority.

See Also:

MessageType

withMessageType

public SMSMessage withMessageType(java.lang.String messageType)

Is this a transaction priority message or lower priority.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: TRANSACTIONAL, PROMOTIONAL

Parameters:

messageType - Is this a transaction priority message or lower priority.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

MessageType

setMessageType

public void setMessageType(MessageType messageType)

Is this a transaction priority message or lower priority.

Constraints:
Allowed Values: TRANSACTIONAL, PROMOTIONAL

Parameters:

messageType - Is this a transaction priority message or lower priority.

See Also:

MessageType

withMessageType

public SMSMessage withMessageType(MessageType messageType)

Is this a transaction priority message or lower priority.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: TRANSACTIONAL, PROMOTIONAL

Parameters:

messageType - Is this a transaction priority message or lower priority.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

MessageType

getOriginationNumber

public java.lang.String getOriginationNumber()

The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.

Returns:

The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.

setOriginationNumber

public void setOriginationNumber(java.lang.String originationNumber)

The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.

Parameters:

originationNumber - The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.

withOriginationNumber

public SMSMessage withOriginationNumber(java.lang.String originationNumber)

The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.

Returns a reference to this object so that method calls can be chained together.

Parameters:

originationNumber - The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.

Returns:

A reference to this updated object so that method calls can be chained together.

getSenderId

public java.lang.String getSenderId()

The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.

Returns:

The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.

setSenderId

public void setSenderId(java.lang.String senderId)

The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.

Parameters:

senderId - The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.

withSenderId

public SMSMessage withSenderId(java.lang.String senderId)

The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.

Returns a reference to this object so that method calls can be chained together.

Parameters:

senderId - The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.

Returns:

A reference to this updated object so that method calls can be chained together.

getSubstitutions

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getSubstitutions()

Default message substitutions. Can be overridden by individual address substitutions.

Returns:

Default message substitutions. Can be overridden by individual address substitutions.

setSubstitutions

public void setSubstitutions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions)

Default message substitutions. Can be overridden by individual address substitutions.

Parameters:

substitutions - Default message substitutions. Can be overridden by individual address substitutions.

withSubstitutions

public SMSMessage withSubstitutions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions)

Default message substitutions. Can be overridden by individual address substitutions.

Returns a reference to this object so that method calls can be chained together.

Parameters:

substitutions - Default message substitutions. Can be overridden by individual address substitutions.

Returns:

A reference to this updated object so that method calls can be chained together.

addSubstitutionsEntry

public SMSMessage addSubstitutionsEntry(java.lang.String key,
                                        java.util.List<java.lang.String> value)

Default message substitutions. Can be overridden by individual address substitutions.

The method adds a new key-value pair into Substitutions parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Substitutions.

value - The corresponding value of the entry to be added into Substitutions.

Returns:

A reference to this updated object so that method calls can be chained together.

clearSubstitutionsEntries

public SMSMessage clearSubstitutionsEntries()

Removes all the entries added into Substitutions.

Returns a reference to this object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object