com.urbanairship.api.channel

Class ChannelTagRequest

java.lang.Object

com.urbanairship.api.channel.ChannelTagRequest

All Implemented Interfaces:

Request<GenericResponse>

public class ChannelTagRequest
extends java.lang.Object
implements Request<GenericResponse>

The ChannelTagRequest class builds channels tag mutation requests to be executed in the UrbanAirshipClient.

Nested Class Summary

Nested classes/interfaces inherited from interface com.urbanairship.api.client.Request

Request.HttpMethod

Field Summary

Fields inherited from interface com.urbanairship.api.client.Request

CONTENT_ENCODING_GZIP, CONTENT_TYPE_JSON, CONTENT_TYPE_TEXT_CSV, UA_VERSION_CSV, UA_VERSION_JSON

Constructor Summary

Constructors

Constructor and Description
ChannelTagRequest()

Method Summary

Modifier and Type	Method and Description
ChannelTagRequest	addAmazonChannel(java.lang.String channel) Add an Amazon channel to the request audience.
ChannelTagRequest	addAmazonChannels(java.util.Set<java.lang.String> channels) Add a set of Amazon channels to the request audience.
ChannelTagRequest	addAmazonChannels(java.lang.String... channels) Add multiple Amazon channels to the request audience.
ChannelTagRequest	addAndroidChannel(java.lang.String channel) Add an Android channel to the request audience.
ChannelTagRequest	addAndroidChannels(java.util.Set<java.lang.String> channels) Add a set of Android channel to the request audience.
ChannelTagRequest	addAndroidChannels(java.lang.String... channels) Add multiple Android channels to the request audience.
ChannelTagRequest	addGenericChannel(java.lang.String channel) Add a generic channel that is either a Open, Web, SMS, or Email channel.
ChannelTagRequest	addGenericChannels(java.util.Set<java.lang.String> channels) Add a set of channels that are either Open, Web, SMS, or Email channels.
ChannelTagRequest	addGenericChannels(java.lang.String... channels) Add multiple channels that are either Open, Web, SMS, or Email channels.
ChannelTagRequest	addIOSChannel(java.lang.String channel) Add an iOS channel to the request audience.
ChannelTagRequest	addIOSChannels(java.util.Set<java.lang.String> channels) Add a set of iOS channels to the request audience.
ChannelTagRequest	addIOSChannels(java.lang.String... channels) Add multiple iOS channels to the request audience.
ChannelTagRequest	addTags(java.lang.String tagGroup, java.util.Set<java.lang.String> tags) Add tag group and tags to add to channels.
boolean	bearerTokenAuthRequired()
boolean	canUseBearerTokenAuth()
ContentType	getContentType()
Request.HttpMethod	getHttpMethod()
java.lang.String	getRequestBody()
java.util.Map<java.lang.String,java.lang.String>	getRequestHeaders()
ResponseParser<GenericResponse>	getResponseParser()
java.net.URI	getUri(java.net.URI baseUri)
static ChannelTagRequest	newRequest() Create new channels tag mutation request.
ChannelTagRequest	removeTags(java.lang.String tagGroup, java.util.Set<java.lang.String> tags) Add tag group and tags to remove from channels.
ChannelTagRequest	setTags(java.lang.String tagGroup, java.util.Set<java.lang.String> tags) Add tag group and tags to set to channels.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelTagRequest

public ChannelTagRequest()

Method Detail

newRequest

public static ChannelTagRequest newRequest()

Create new channels tag mutation request.

Returns:

ChannelTagRequest

addIOSChannel

public ChannelTagRequest addIOSChannel(java.lang.String channel)

Add an iOS channel to the request audience.

Parameters:

channel - String

Returns:

ChannelTagRequest

addIOSChannels

public ChannelTagRequest addIOSChannels(java.lang.String... channels)

Add multiple iOS channels to the request audience.

Parameters:

channels - String... of channel IDs

Returns:

ChannelTagRequest

addIOSChannels

public ChannelTagRequest addIOSChannels(java.util.Set<java.lang.String> channels)

Add a set of iOS channels to the request audience.

Parameters:

channels - Set of channel IDs

Returns:

ChannelTagRequest

addAndroidChannel

public ChannelTagRequest addAndroidChannel(java.lang.String channel)

Add an Android channel to the request audience.

Parameters:

channel - String

Returns:

ChannelTagRequest

addAndroidChannels

public ChannelTagRequest addAndroidChannels(java.lang.String... channels)

Add multiple Android channels to the request audience.

Parameters:

channels - String... of channel IDs

Returns:

ChannelTagRequest

addAndroidChannels

public ChannelTagRequest addAndroidChannels(java.util.Set<java.lang.String> channels)

Add a set of Android channel to the request audience.

Parameters:

channels - Set of channels IDs

Returns:

ChannelTagRequest

addAmazonChannel

public ChannelTagRequest addAmazonChannel(java.lang.String channel)

Add an Amazon channel to the request audience.

Parameters:

channel - String

Returns:

ChannelTagRequest

addAmazonChannels

public ChannelTagRequest addAmazonChannels(java.lang.String... channels)

Add multiple Amazon channels to the request audience.

Parameters:

channels - String... of channel IDs

Returns:

ChannelTagRequest

addAmazonChannels

public ChannelTagRequest addAmazonChannels(java.util.Set<java.lang.String> channels)

Add a set of Amazon channels to the request audience.

Parameters:

channels - Set of channel IDs

Returns:

ChannelTagRequest

addGenericChannel

public ChannelTagRequest addGenericChannel(java.lang.String channel)

Add a generic channel that is either a Open, Web, SMS, or Email channel.

Parameters:

channel - String

Returns:

ChannelTagRequest

addGenericChannels

public ChannelTagRequest addGenericChannels(java.lang.String... channels)

Add multiple channels that are either Open, Web, SMS, or Email channels.

Parameters:

channels - String... of Channel IDs

Returns:

ChannelTagRequest

addGenericChannels

public ChannelTagRequest addGenericChannels(java.util.Set<java.lang.String> channels)

Add a set of channels that are either Open, Web, SMS, or Email channels.

Parameters:

channels - Set of channel IDs

Returns:

ChannelTagRequest

addTags

public ChannelTagRequest addTags(java.lang.String tagGroup,
                                 java.util.Set<java.lang.String> tags)

Add tag group and tags to add to channels.

Parameters:

tagGroup - String

tags - Set of tags

Returns:

ChannelTagRequest

removeTags

public ChannelTagRequest removeTags(java.lang.String tagGroup,
                                    java.util.Set<java.lang.String> tags)

Add tag group and tags to remove from channels.

Parameters:

tagGroup - String

tags - Set of tags

Returns:

ChannelTagRequest

setTags

public ChannelTagRequest setTags(java.lang.String tagGroup,
                                 java.util.Set<java.lang.String> tags)

Add tag group and tags to set to channels.

Parameters:

tagGroup - String

tags - Set of tags

Returns:

ChannelTagRequest

getContentType

public ContentType getContentType()

Specified by:

getContentType in interface Request<GenericResponse>

getRequestHeaders

public java.util.Map<java.lang.String,java.lang.String> getRequestHeaders()

Specified by:

getRequestHeaders in interface Request<GenericResponse>

getHttpMethod

public Request.HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface Request<GenericResponse>

getRequestBody

public java.lang.String getRequestBody()

Specified by:

getRequestBody in interface Request<GenericResponse>

getUri

public java.net.URI getUri(java.net.URI baseUri)

Specified by:

getUri in interface Request<GenericResponse>

getResponseParser

public ResponseParser<GenericResponse> getResponseParser()

Specified by:

getResponseParser in interface Request<GenericResponse>

bearerTokenAuthRequired

public boolean bearerTokenAuthRequired()

Specified by:

bearerTokenAuthRequired in interface Request<GenericResponse>

canUseBearerTokenAuth

public boolean canUseBearerTokenAuth()

Specified by:

canUseBearerTokenAuth in interface Request<GenericResponse>