com.urbanairship.api.channel

Class OpenChannelTagRequest

java.lang.Object

com.urbanairship.api.channel.OpenChannelTagRequest

All Implemented Interfaces:

Request<java.lang.String>

public class OpenChannelTagRequest
extends java.lang.Object
implements Request<java.lang.String>

The OpenChannelTagRequest class builds open channel 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
OpenChannelTagRequest()

Method Summary

Modifier and Type	Method and Description
OpenChannelTagRequest	addOpenChannel(java.lang.String address, java.lang.String openPlatformName) Add an Open channel to the request audience.
OpenChannelTagRequest	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<java.lang.String>	getResponseParser()
java.net.URI	getUri(java.net.URI baseUri)
static OpenChannelTagRequest	newRequest() Create new Open Channel tag mutation request.
OpenChannelTagRequest	removeTags(java.lang.String tagGroup, java.util.Set<java.lang.String> tags) Add tag group and tags to remove from channels.
OpenChannelTagRequest	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

OpenChannelTagRequest

public OpenChannelTagRequest()

Method Detail

newRequest

public static OpenChannelTagRequest newRequest()

Create new Open Channel tag mutation request.

Returns:

OpenChannelTagRequest

addOpenChannel

public OpenChannelTagRequest addOpenChannel(java.lang.String address,
                                            java.lang.String openPlatformName)

Add an Open channel to the request audience.

Parameters:

address - String

openPlatformName - String

Returns:

OpenChannelTagRequest

addTags

public OpenChannelTagRequest 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 Strings

Returns:

ChannelTagRequest

removeTags

public OpenChannelTagRequest 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 Strings

Returns:

ChannelTagRequest

setTags

public OpenChannelTagRequest 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

getHttpMethod

public Request.HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface Request<java.lang.String>

getRequestBody

public java.lang.String getRequestBody()

Specified by:

getRequestBody in interface Request<java.lang.String>

getContentType

public ContentType getContentType()

Specified by:

getContentType in interface Request<java.lang.String>

getRequestHeaders

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

Specified by:

getRequestHeaders in interface Request<java.lang.String>

getUri

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

Specified by:

getUri in interface Request<java.lang.String>

getResponseParser

public ResponseParser<java.lang.String> getResponseParser()

Specified by:

getResponseParser in interface Request<java.lang.String>

bearerTokenAuthRequired

public boolean bearerTokenAuthRequired()

Specified by:

bearerTokenAuthRequired in interface Request<java.lang.String>

canUseBearerTokenAuth

public boolean canUseBearerTokenAuth()

Specified by:

canUseBearerTokenAuth in interface Request<java.lang.String>