com.urbanairship.api.templates

Class TemplateListingRequest

java.lang.Object

com.urbanairship.api.templates.TemplateListingRequest

All Implemented Interfaces:

Request<TemplateListingResponse>

public class TemplateListingRequest
extends java.lang.Object
implements Request<TemplateListingResponse>

The TemplateListingRequest class builds template listing 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<TemplateListingResponse>	getResponseParser()
java.net.URI	getUri(java.net.URI baseUri)
static TemplateListingRequest	newRequest() Create a new TemplateListingRequest object for a template listing request.
static TemplateListingRequest	newRequest(java.lang.String templateId) Create a new TemplateListingRequest object for a template lookup request.
TemplateListingRequest	setPage(int page) Set the page URL parameter.
TemplateListingRequest	setPageSize(int pageSize) Set the page_size URL parameter.

Methods inherited from class java.lang.Object

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

Method Detail

newRequest

public static TemplateListingRequest newRequest()

Create a new TemplateListingRequest object for a template listing request.

Returns:

TemplateListingRequest

newRequest

public static TemplateListingRequest newRequest(java.lang.String templateId)

Create a new TemplateListingRequest object for a template lookup request.

Parameters:

templateId - The template ID to lookup

Returns:

TemplateListingRequest

setPage

public TemplateListingRequest setPage(int page)

Set the page URL parameter.

Parameters:

page - An int

Returns:

TemplateListingRequest

setPageSize

public TemplateListingRequest setPageSize(int pageSize)

Set the page_size URL parameter.

Parameters:

pageSize - An int

Returns:

TemplateListingRequest

getHttpMethod

public Request.HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface Request<TemplateListingResponse>

getRequestBody

public java.lang.String getRequestBody()

Specified by:

getRequestBody in interface Request<TemplateListingResponse>

getContentType

public ContentType getContentType()

Specified by:

getContentType in interface Request<TemplateListingResponse>

getRequestHeaders

public java.util.Map<java.lang.String,java.lang.String> getRequestHeaders()

Specified by:

getRequestHeaders in interface Request<TemplateListingResponse>

getUri

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

Specified by:

getUri in interface Request<TemplateListingResponse>

Throws:

java.net.URISyntaxException

getResponseParser

public ResponseParser<TemplateListingResponse> getResponseParser()

Specified by:

getResponseParser in interface Request<TemplateListingResponse>

bearerTokenAuthRequired

public boolean bearerTokenAuthRequired()

Specified by:

bearerTokenAuthRequired in interface Request<TemplateListingResponse>

canUseBearerTokenAuth

public boolean canUseBearerTokenAuth()

Specified by:

canUseBearerTokenAuth in interface Request<TemplateListingResponse>