com.urbanairship.api.channel.model.open

Class Channel

java.lang.Object

com.urbanairship.api.common.model.APIModelObject

com.urbanairship.api.push.model.PushModelObject

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

public class Channel
extends PushModelObject

Represents the payload to be used for registering or updating an open channel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Channel.Builder Channel Builder

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.Optional<java.lang.String>	getAddress() Get the channel's address, a Unique identifier of the object used as the primary ID in the delivery tier (webhook).
java.util.Optional<java.lang.String>	getLocaleCountry() Get a String representation of the locale country.
java.util.Optional<java.lang.String>	getLocaleLanguage() Get a String representation of the locale language.
OpenChannel	getOpen() Get open channel specific properties.
java.util.Optional<java.lang.Boolean>	getOptIn() Get the channel opt in status.
java.util.Optional<java.lang.Boolean>	getSetTags() Get the setTags flag.
java.util.Optional<<any>>	getTags() Get the List of String representations of tags.
java.util.Optional<java.lang.String>	getTimezone() Get a String representation of the timezone.
ChannelType	getType() Get the ChannelType.
int	hashCode()
static Channel.Builder	newBuilder() New Channel Builder.
java.lang.String	toString()

Methods inherited from class com.urbanairship.api.push.model.PushModelObject

toJSON

Methods inherited from class com.urbanairship.api.common.model.APIModelObject

toJSON

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getType

public ChannelType getType()

Get the ChannelType.

Returns:

ChannelType type

getOptIn

public java.util.Optional<java.lang.Boolean> getOptIn()

Get the channel opt in status.

Returns:

Optional Boolean optIn

getAddress

public java.util.Optional<java.lang.String> getAddress()

Get 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.

Returns:

Optional String address

getSetTags

public java.util.Optional<java.lang.Boolean> getSetTags()

Get the setTags flag. 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.

Returns:

Optional Boolean setTags

getTags

public java.util.Optional<<any>> getTags()

Get the List of String representations of tags.

Returns:

Optional ImmutableList of Strings

getTimezone

public java.util.Optional<java.lang.String> getTimezone()

Get a String representation of the timezone.

Returns:

Optional String timezone

getLocaleCountry

public java.util.Optional<java.lang.String> getLocaleCountry()

Get a String representation of the locale country.

Returns:

Optional String localeCountry

getLocaleLanguage

public java.util.Optional<java.lang.String> getLocaleLanguage()

Get a String representation of the locale language.

Returns:

Optional String localeLanguage

getOpen

public OpenChannel getOpen()

Get open channel specific properties.

Returns:

OpenChannel open

newBuilder

public static Channel.Builder newBuilder()

New Channel Builder.

Returns:

Builder

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object