com.urbanairship.api.nameduser

Class NamedUserTagRequest

java.lang.Object

com.urbanairship.api.nameduser.NamedUserTagRequest

All Implemented Interfaces:

Request<GenericResponse>

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

The NamedUserTagRequest class builds named user 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

Method Summary

Modifier and Type	Method and Description
NamedUserTagRequest	addNamedUser(java.lang.String namedUser) Add a named user to the request audience.
NamedUserTagRequest	addNamedUsers(java.util.Set<java.lang.String> namedUsers) Add multiple named users to the request audience.
NamedUserTagRequest	addNamedUsers(java.lang.String... namedUsers) Add multiple named users to the request audience.
NamedUserTagRequest	addTags(java.lang.String tagGroup, java.util.Set<java.lang.String> tags) Add tag group and tags to be added to named user.
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 NamedUserTagRequest	newRequest() Create new named user tag mutations request.
NamedUserTagRequest	removeTags(java.lang.String tagGroup, java.util.Set<java.lang.String> tags) Add tag group and tags to be removed from named user.
NamedUserTagRequest	setTags(java.lang.String tagGroup, java.util.Set<java.lang.String> tags) Add tag group and tags to be set to named user.

Methods inherited from class java.lang.Object

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

Method Detail

newRequest

public static NamedUserTagRequest newRequest()

Create new named user tag mutations request.

Returns:

NamedUserTagRequest

addNamedUser

public NamedUserTagRequest addNamedUser(java.lang.String namedUser)

Add a named user to the request audience.

Parameters:

namedUser - String

Returns:

NamedUserTagRequest

addNamedUsers

public NamedUserTagRequest addNamedUsers(java.lang.String... namedUsers)

Add multiple named users to the request audience.

Parameters:

namedUsers - String... of named users

Returns:

NamedUserTagRequest

addNamedUsers

public NamedUserTagRequest addNamedUsers(java.util.Set<java.lang.String> namedUsers)

Add multiple named users to the request audience.

Parameters:

namedUsers - Set of named users

Returns:

NamedUserTagRequest

addTags

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

Add tag group and tags to be added to named user.

Parameters:

tagGroup - String

tags - Set of tags

Returns:

NamedUserTagRequest

removeTags

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

Add tag group and tags to be removed from named user.

Parameters:

tagGroup - String

tags - Set of tags

Returns:

NamedUserTagRequest

setTags

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

Add tag group and tags to be set to named user.

Parameters:

tagGroup - String

tags - Set of tags

Returns:

NamedUserTagRequest

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>