com.urbanairship.api.channel.model.open

Class OpenChannel.Builder

java.lang.Object

com.urbanairship.api.channel.model.open.OpenChannel.Builder

Enclosing class:

OpenChannel

public static final class OpenChannel.Builder
extends java.lang.Object

OpenChannel Builder

Method Summary

Modifier and Type	Method and Description
OpenChannel.Builder	addAllIdentifierEntries(java.util.Map<java.lang.String,java.lang.String> entries) Add all identifiers.
OpenChannel.Builder	addIdentifier(java.lang.String key, java.lang.String value) Add identifier.
OpenChannel	build() Build the OpenChannel object
OpenChannel.Builder	setOldAddress(java.lang.String oldAddress) Set old address.
OpenChannel.Builder	setOpenPlatformName(java.lang.String platformName) Set the canonical name of the open platform on which the channel is registered.

Methods inherited from class java.lang.Object

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

Method Detail

setOpenPlatformName

public OpenChannel.Builder setOpenPlatformName(java.lang.String platformName)

Set the canonical name of the open platform on which the channel is registered.

Parameters:

platformName - String

Returns:

OpenChannel Builder

setOldAddress

public OpenChannel.Builder setOldAddress(java.lang.String oldAddress)

Set old address. If for any reason the primary identifier of the record changes, include this key, and all tag and identifier information associated with the channel will be preserved, while the address will be replaced with the new value in 'address'. After a call swapping the address, new registrations referencing the old address will be assumed to represent a new channel.

Parameters:

oldAddress - String

Returns:

OpenChannel Builder

addIdentifier

public OpenChannel.Builder addIdentifier(java.lang.String key,
                                         java.lang.String value)

Add identifier. Optional, array of string pairs. These will be delivered in open channels payloads, but cannot be used for segmentations. Maximum of 100 pairs of string values. This value should be exhaustive whenever this key is present—values will not be unioned with existing identifiers, they will replace them, similar to "set_tags": true above.

Parameters:

key - String

value - String

Returns:

OpenChannel Builder

addAllIdentifierEntries

public OpenChannel.Builder addAllIdentifierEntries(java.util.Map<java.lang.String,java.lang.String> entries)

Add all identifiers. Optional, array of string pairs. These will be delivered in open channels payloads, but cannot be used for segmentations. Maximum of 100 pairs of string values. This value should be exhaustive whenever this key is present—values will not be unioned with existing identifiers, they will replace them, similar to "set_tags": true above.

Parameters:

entries - Map of Strings

Returns:

OpenChannel Builder

build

public OpenChannel build()

Build the OpenChannel object

Returns:

OpenChannel