com.urbanairship.api.templates

Class TemplatePushRequest

java.lang.Object

com.urbanairship.api.templates.TemplatePushRequest

All Implemented Interfaces:

Request<TemplateResponse>

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

The TemplatePushRequest object builds a template push 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
TemplatePushRequest	addAllTemplatePushPayloads(java.util.List<TemplatePushPayload> templatePushPayloads) Add all template push payloads to the request.
TemplatePushRequest	addTemplatePushPayload(TemplatePushPayload templatePushPayload) Add a template push payload to the request.
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 TemplatePushRequest	newRequest() Create a new TemplatePushRequest.
TemplatePushRequest	setValidateOnly(boolean validateOnly) Set the template push to validate only.

Methods inherited from class java.lang.Object

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

Method Detail

newRequest

public static TemplatePushRequest newRequest()

Create a new TemplatePushRequest.

Returns:

TemplatePushRequest

addTemplatePushPayload

public TemplatePushRequest addTemplatePushPayload(TemplatePushPayload templatePushPayload)

Add a template push payload to the request.

Parameters:

templatePushPayload - A TemplatePushPayload object

Returns:

TemplatePushRequest

addAllTemplatePushPayloads

public TemplatePushRequest addAllTemplatePushPayloads(java.util.List<TemplatePushPayload> templatePushPayloads)

Add all template push payloads to the request.

Parameters:

templatePushPayloads - A list of TemplatePushPayload objects

Returns:

TemplatePushRequest

setValidateOnly

public TemplatePushRequest setValidateOnly(boolean validateOnly)

Set the template push to validate only.

Parameters:

validateOnly - A boolean

Returns:

TemplatePushRequest

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>