com.urbanairship.api.channel.model.email

Class EmailTagRequest

java.lang.Object

com.urbanairship.api.channel.model.email.EmailTagRequest

All Implemented Interfaces:

Request<GenericResponse>

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

The EmailTagRequest class builds email tag mutation requests to be executed in the UrbanAirshipClient. Open Channel Tags Request will not function for Email.

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
EmailTagRequest()

Method Summary

Modifier and Type	Method and Description
EmailTagRequest	addEmailChannel(java.lang.String channel) Add an Email channel to the request audience.
EmailTagRequest	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 EmailTagRequest	newRequest() Create new Email Channel tag mutation request.
EmailTagRequest	removeTags(java.lang.String tagGroup, java.util.Set<java.lang.String> tags) Add tag group and tags to remove from channels.
EmailTagRequest	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

EmailTagRequest

public EmailTagRequest()

Method Detail

newRequest

public static EmailTagRequest newRequest()

Create new Email Channel tag mutation request.

Returns:

EmailTagRequest

addEmailChannel

public EmailTagRequest addEmailChannel(java.lang.String channel)

Add an Email channel to the request audience.

Parameters:

channel - String

Returns:

EmailTagRequest

addTags

public EmailTagRequest 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 EmailTagRequest 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 EmailTagRequest 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<GenericResponse>

getRequestBody

public java.lang.String getRequestBody()

Specified by:

getRequestBody in interface Request<GenericResponse>

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>

getUri

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

Specified by:

getUri in interface Request<GenericResponse>

Throws:

java.net.URISyntaxException

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>