com.urbanairship.api.createandsend.model.notification.sms

Class SmsPayload.Builder

java.lang.Object

com.urbanairship.api.createandsend.model.notification.sms.SmsPayload.Builder

Enclosing class:

SmsPayload

public static class SmsPayload.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SmsPayload	build() Build an SmsPayload object.
SmsPayload.Builder	setAlert(java.lang.String alert) Set the sms alert. sms templates cannot be used with the payload alert.
SmsPayload.Builder	setPushExpiry(PushExpiry pushExpiry) Set the push expiry.
SmsPayload.Builder	setSmsTemplate(SmsTemplate smsTemplate) Set the sms template.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setAlert

public SmsPayload.Builder setAlert(java.lang.String alert)

Set the sms alert. sms templates cannot be used with the payload alert.

Parameters:

alert - String

Returns:

SmsPayload Builder

setPushExpiry

public SmsPayload.Builder setPushExpiry(PushExpiry pushExpiry)

Set the push expiry. Delivery expiration represented as PushExpiry.

Parameters:

pushExpiry - PushExpiry

Returns:

SmsPayload Builder

setSmsTemplate

public SmsPayload.Builder setSmsTemplate(SmsTemplate smsTemplate)

Set the sms template. Provide the ID or inline fields for a template. Using a template enables you to provide and populate variables in your notification. SmsPayload alert cannot be set when using sms templates.

Parameters:

smsTemplate - SmsTemplate

Returns:

SmsPayload Builder

build

public SmsPayload build()

Build an SmsPayload object. Will fail if any of the following preconditions are not met.

     1. alert and template cannot both be set.
 

Returns:

SmsPayload

Throws:

java.lang.IllegalArgumentException - if alert and template are both set.