com.urbanairship.api.nameduser

Class NamedUserRequest

java.lang.Object

com.urbanairship.api.nameduser.NamedUserRequest

All Implemented Interfaces:

Request<GenericResponse>

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

The NamedUserRequest class builds named user association and disassociation 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
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 NamedUserRequest	newAssociationRequest() Create a named user association request.
static NamedUserRequest	newDisassociationRequest() Create a named user disassociation request.
NamedUserRequest	setChannel(java.lang.String channelId, ChannelType channelType) Set the request channel.
NamedUserRequest	setEmail(java.lang.String email) Set an email address to associate or disassociate.
NamedUserRequest	setNamedUserId(java.lang.String namedUserId) Set the request named user ID - optional for disassociation requests.

Methods inherited from class java.lang.Object

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

Method Detail

newAssociationRequest

public static NamedUserRequest newAssociationRequest()

Create a named user association request.

Returns:

NamedUserRequest

newDisassociationRequest

public static NamedUserRequest newDisassociationRequest()

Create a named user disassociation request.

Returns:

NamedUserRequest

setChannel

public NamedUserRequest setChannel(java.lang.String channelId,
                                   ChannelType channelType)

Set the request channel.

Parameters:

channelId - The channel ID as a string

channelType - The channel platform as a ChannelType

Returns:

NamedUserRequest

setEmail

public NamedUserRequest setEmail(java.lang.String email)

Set an email address to associate or disassociate. The email must be registered to airship before an association can be made.

Parameters:

email - String

Returns:

NamedUserRequest

setNamedUserId

public NamedUserRequest setNamedUserId(java.lang.String namedUserId)

Set the request named user ID - optional for disassociation requests.

Parameters:

namedUserId - String

Returns:

NamedUserRequest

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>