com.urbanairship.api.tags

Class TagListRequest

java.lang.Object

com.urbanairship.api.tags.TagListRequest

All Implemented Interfaces:

Request<java.lang.String>

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

The CreateTagListRequest class builds tag list 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
TagListRequest()

Method Summary

Modifier and Type	Method and Description
TagListRequest	addExtra(java.lang.String key, java.lang.String val) Add a key-value pair to the extra mapping.
TagListRequest	addTags(java.lang.String tagGroup, <any> 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 TagListRequest	newRequest() Create new TagListRequest mutation request.
TagListRequest	removeTags(java.lang.String tagGroup, <any> tags) Add tag group and tags to remove from channels.
TagListRequest	setDescription(java.lang.String description) Set the description of the tag list.
TagListRequest	setName(java.lang.String name) Set the name of the tag list.
TagListRequest	setTags(java.lang.String tagGroup, <any> 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

TagListRequest

public TagListRequest()

Method Detail

newRequest

public static TagListRequest newRequest()

Create new TagListRequest mutation request.

Returns:

TagListRequest

setName

public TagListRequest setName(java.lang.String name)

Set the name of the tag list.

Parameters:

name - String

Returns:

TagListRequest

setDescription

public TagListRequest setDescription(java.lang.String description)

Set the description of the tag list.

Parameters:

description - String

Returns:

TagListRequest

addExtra

public TagListRequest addExtra(java.lang.String key,
                               java.lang.String val)

Add a key-value pair to the extra mapping.

Parameters:

key - String

val - String

Returns:

TagListRequest

addTags

public TagListRequest addTags(java.lang.String tagGroup,
                              <any> tags)

Add tag group and tags to add to channels.

Parameters:

tagGroup - String

tags - Set of Strings

Returns:

TagListRequest

removeTags

public TagListRequest removeTags(java.lang.String tagGroup,
                                 <any> tags)

Add tag group and tags to remove from channels.

Parameters:

tagGroup - String

tags - Set of Strings

Returns:

TagListRequest

setTags

public TagListRequest setTags(java.lang.String tagGroup,
                              <any> tags)

Add tag group and tags to set to channels.

Parameters:

tagGroup - String

tags - Set of tags

Returns:

TagListRequest

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)
                    throws java.net.URISyntaxException

Specified by:

getUri in interface Request<java.lang.String>

Throws:

java.net.URISyntaxException

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>