com.urbanairship.api.push.model

Class PushPayload.Builder

java.lang.Object

com.urbanairship.api.push.model.PushPayload.Builder

Enclosing class:

PushPayload

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

Method Summary

Modifier and Type	Method and Description
PushPayload.Builder	addAllGlobalAttributes(<any> globalAttributes)
PushPayload.Builder	addGlobalAttributes(java.lang.String k, java.lang.Object o) Add a global attribute.
PushPayload.Builder	addLocalization(Localization localization) Add a Localization.
PushPayload	build() Build a PushPayload object.
PushPayload.Builder	setAudience(Selector value) Set the Audience.
PushPayload.Builder	setCampaigns(Campaigns campaigns) Set the campaign.
PushPayload.Builder	setDeviceTypes(DeviceTypeData deviceTypes) Set the Device Type data.
PushPayload.Builder	setInApp(InApp inApp) Set the in-app message.
PushPayload.Builder	setMessage(RichPushMessage message) Set the rich push message.
PushPayload.Builder	setMessageType(MessageType messageType) Set the messageType.
PushPayload.Builder	setNotification(Notification notification) Set the Notification.
PushPayload.Builder	setOrchestration(Orchestration orchestration) Set the orchestration.
PushPayload.Builder	setPushOptions(PushOptions pushOptions) Set the push options.

Methods inherited from class java.lang.Object

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

Method Detail

setAudience

public PushPayload.Builder setAudience(Selector value)

Set the Audience.

Parameters:

value - audience Selector

Returns:

Builder

setNotification

public PushPayload.Builder setNotification(Notification notification)

Set the Notification.

Parameters:

notification - Notification

Returns:

Builder

setMessage

public PushPayload.Builder setMessage(RichPushMessage message)

Set the rich push message.

Parameters:

message - RichPushMessage

Returns:

Builder

setDeviceTypes

public PushPayload.Builder setDeviceTypes(DeviceTypeData deviceTypes)

Set the Device Type data.

Parameters:

deviceTypes - DeviceTypeData

Returns:

Builder

setPushOptions

public PushPayload.Builder setPushOptions(PushOptions pushOptions)

Set the push options.

Parameters:

pushOptions - PushOptions

Returns:

Builder

setInApp

public PushPayload.Builder setInApp(InApp inApp)

Set the in-app message.

Parameters:

inApp - An InApp message object.

Returns:

Builder

setCampaigns

public PushPayload.Builder setCampaigns(Campaigns campaigns)

Set the campaign.

Parameters:

campaigns - A campaign object.

Returns:

Builder

addLocalization

public PushPayload.Builder addLocalization(Localization localization)

Add a Localization.

Parameters:

localization - Localization

Returns:

Builder

addGlobalAttributes

public PushPayload.Builder addGlobalAttributes(java.lang.String k,
                                               java.lang.Object o)

Add a global attribute.

Parameters:

k - String

o - Object

Returns:

Builder

addAllGlobalAttributes

public PushPayload.Builder addAllGlobalAttributes(<any> globalAttributes)

setOrchestration

public PushPayload.Builder setOrchestration(Orchestration orchestration)

Set the orchestration.

Parameters:

orchestration - An Orchestration object.

Returns:

Builder

setMessageType

public PushPayload.Builder setMessageType(MessageType messageType)

Set the messageType.

Parameters:

messageType - An messageType object.

Returns:

Builder

build

public PushPayload build()

Build a PushPayload object. Will fail if any of the following preconditions are not met.

 1. At least one of notification, message, or inApp must be set.
 2. Audience must be set.
 3. DeviceTypes (device types) must be set.
 

Returns:

PushPayload

Throws:

java.lang.IllegalArgumentException - if an illegal argument is used

java.lang.NullPointerException - if required variables are not initialized