com.urbanairship.api.staticlists

Class StaticListRequest

java.lang.Object

com.urbanairship.api.staticlists.StaticListRequest

All Implemented Interfaces:

Request<GenericResponse>

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

The StaticListRequest class builds a static list creation request 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
StaticListRequest	addAllExtras(java.util.Map<java.lang.String,java.lang.String> entries) Add all key-value pairs to the map of extras.
StaticListRequest	addExtra(java.lang.String key, java.lang.String val) Add a key-value pair to the extra mapping.
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 StaticListRequest	newRequest(java.lang.String name) Build a static list creation request.
static StaticListRequest	newUpdateRequest(java.lang.String name) Create a static list update request.
StaticListRequest	setDescription(java.lang.String description) Set the description of the static list.

Methods inherited from class java.lang.Object

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

Method Detail

newRequest

public static StaticListRequest newRequest(java.lang.String name)

Build a static list creation request.

Parameters:

name - The name of the list as a string.

Returns:

StaticListRequest

newUpdateRequest

public static StaticListRequest newUpdateRequest(java.lang.String name)

Create a static list update request.

Parameters:

name - The name of the list as a string.

Returns:

StaticListRequest

setDescription

public StaticListRequest setDescription(java.lang.String description)

Set the description of the static list.

Parameters:

description - String

Returns:

StaticListRequest

addExtra

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

Add a key-value pair to the extra mapping.

Parameters:

key - String

val - String

Returns:

StaticListRequest

addAllExtras

public StaticListRequest addAllExtras(java.util.Map<java.lang.String,java.lang.String> entries)

Add all key-value pairs to the map of extras.

Parameters:

entries - Map of Strings

Returns:

StaticListCreationRequest

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>