com.urbanairship.api.templates

Class TemplateRequest

java.lang.Object

com.urbanairship.api.templates.TemplateRequest

All Implemented Interfaces:

Request<TemplateResponse>

public class TemplateRequest
extends java.lang.Object
implements Request<TemplateResponse>

The TemplateRequest class builds template creation and update 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
TemplateRequest	addAllVariables(java.util.List<TemplateVariable> variables) Add a list of variables to the template.
TemplateRequest	addVariable(TemplateVariable variable) Add a variable to the template.
boolean	bearerTokenAuthRequired()
boolean	canUseBearerTokenAuth()
ContentType	getContentType()
Request.HttpMethod	getHttpMethod()
java.lang.String	getRequestBody()
java.util.Map<java.lang.String,java.lang.String>	getRequestHeaders()
ResponseParser<TemplateResponse>	getResponseParser()
java.net.URI	getUri(java.net.URI baseUri)
static TemplateRequest	newRequest() Return a new template creation request.
static TemplateRequest	newRequest(java.lang.String templateId) Return a new template update request.
TemplateRequest	setDescription(java.lang.String description) Set the template description.
TemplateRequest	setName(java.lang.String name) Set the template name.
TemplateRequest	setPush(PartialPushPayload push) Set the template partial push payload.

Methods inherited from class java.lang.Object

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

Method Detail

newRequest

public static TemplateRequest newRequest()

Return a new template creation request.

Returns:

TemplateRequest

newRequest

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

Return a new template update request.

Parameters:

templateId - The template ID to update

Returns:

TemplateRequest

setName

public TemplateRequest setName(java.lang.String name)

Set the template name.

Parameters:

name - A string.

Returns:

TemplateRequest

setDescription

public TemplateRequest setDescription(java.lang.String description)

Set the template description.

Parameters:

description - A string

Returns:

TemplateRequest

addVariable

public TemplateRequest addVariable(TemplateVariable variable)

Add a variable to the template.

Parameters:

variable - A TemplateVariable object

Returns:

TemplateRequest

addAllVariables

public TemplateRequest addAllVariables(java.util.List<TemplateVariable> variables)

Add a list of variables to the template.

Parameters:

variables - A list of template variable objects.

Returns:

TemplateRequest

setPush

public TemplateRequest setPush(PartialPushPayload push)

Set the template partial push payload.

Parameters:

push - A PartialPushPayload object

Returns:

TemplateRequest

getHttpMethod

public Request.HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface Request<TemplateResponse>

getRequestBody

public java.lang.String getRequestBody()

Specified by:

getRequestBody in interface Request<TemplateResponse>

getContentType

public ContentType getContentType()

Specified by:

getContentType in interface Request<TemplateResponse>

getRequestHeaders

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

Specified by:

getRequestHeaders in interface Request<TemplateResponse>

getUri

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

Specified by:

getUri in interface Request<TemplateResponse>

Throws:

java.net.URISyntaxException

getResponseParser

public ResponseParser<TemplateResponse> getResponseParser()

Specified by:

getResponseParser in interface Request<TemplateResponse>

bearerTokenAuthRequired

public boolean bearerTokenAuthRequired()

Specified by:

bearerTokenAuthRequired in interface Request<TemplateResponse>

canUseBearerTokenAuth

public boolean canUseBearerTokenAuth()

Specified by:

canUseBearerTokenAuth in interface Request<TemplateResponse>