com.urbanairship.api.channel.model.open

Class Channel.Builder

java.lang.Object

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

Enclosing class:

Channel

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

Channel Builder

Method Summary

Modifier and Type	Method and Description
Channel.Builder	addAllTags(java.util.List<java.lang.String> tags) Add a List of String representations of tags.
Channel.Builder	addTag(java.lang.String tag) Set a String representation of a tag.
Channel	build()
Channel.Builder	setAddress(java.lang.String address) Set the channel's address, a Unique identifier of the object used as the primary ID in the delivery tier (webhook).
Channel.Builder	setChannelType(ChannelType type) Set the ChannelType.
Channel.Builder	setLocaleCountry(java.lang.String locale_country) Set a the localeCountry The two-letter country locale shortcode.
Channel.Builder	setLocaleLanguage(java.lang.String locale_language) Set a String localeLanguage, the two-letter language locale shortcode.
Channel.Builder	setOpenChannel(OpenChannel open) Set open channel specific properties.
Channel.Builder	setOptIn(boolean optIn) Set the channel opt in status.
Channel.Builder	setTags(boolean setTags) Optional, though required if tags is present.
Channel.Builder	setTimeZone(java.lang.String timezone) Set timezone string.

Methods inherited from class java.lang.Object

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

Method Detail

setChannelType

public Channel.Builder setChannelType(ChannelType type)

Set the ChannelType. Must be open.

Parameters:

type - ChannelType

Returns:

Channel Builder

setOptIn

public Channel.Builder setOptIn(boolean optIn)

Set the channel opt in status. If false, no payloads will be delivered for the channel.

Parameters:

optIn - boolean

Returns:

Channel Builder

setAddress

public Channel.Builder setAddress(java.lang.String address)

Set the channel's address, a Unique identifier of the object used as the primary ID in the delivery tier (webhook). One-to-one with Channel ID. New addresses on existing channels will overwrite old associations. Examples: email address, phone number. If missing, channel_id must be present.

Parameters:

address - String

Returns:

Channel Builder

setTags

public Channel.Builder setTags(boolean setTags)

Optional, though required if tags is present. If true on update, value of tags overwrites any existing tags. If false, tags are unioned with existing tags.

Parameters:

setTags - boolean

Returns:

Channel Builder

addAllTags

public Channel.Builder addAllTags(java.util.List<java.lang.String> tags)

Add a List of String representations of tags.

Parameters:

tags - A List of Strings

Returns:

Channel Builder

addTag

public Channel.Builder addTag(java.lang.String tag)

Set a String representation of a tag.

Parameters:

tag - String

Returns:

Channel Builder

setTimeZone

public Channel.Builder setTimeZone(java.lang.String timezone)

Set timezone string. An IANA tzdata identifier for the timezone as a string, e.g., "America/Los Angeles". Will set the timezone tag group tag with the specified value.

Parameters:

timezone - String

Returns:

Channel Builder

setLocaleCountry

public Channel.Builder setLocaleCountry(java.lang.String locale_country)

Set a the localeCountry The two-letter country locale shortcode. Will set the ua_locale_country tag group to the specified value.

Parameters:

locale_country - String

Returns:

Channel Builder

setLocaleLanguage

public Channel.Builder setLocaleLanguage(java.lang.String locale_language)

Set a String localeLanguage, the two-letter language locale shortcode. Will set the ua_locale_language tag group to the specified value

Parameters:

locale_language - String

Returns:

Channel Builder

setOpenChannel

public Channel.Builder setOpenChannel(OpenChannel open)

Set open channel specific properties.

Parameters:

open - OpenChannel

Returns:

Channel Builder

build

public Channel build()