com.urbanairship.api.reports

Class PlatformStatsRequest

java.lang.Object

com.urbanairship.api.reports.PlatformStatsRequest

All Implemented Interfaces:

Request<PlatformStatsResponse>

public class PlatformStatsRequest
extends java.lang.Object
implements Request<PlatformStatsResponse>

The PlatformStatsRequest class builds a request to one of the platform stats endpoints -- app opens, time in app, opt ins, opt outs, or sends -- 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<PlatformStatsResponse>	getResponseParser()
java.net.URI	getUri(java.net.URI baseUri)
static PlatformStatsRequest	newRequest(PlatformStatsRequestType type) Create a platform stats request.
static PlatformStatsRequest	newRequest(java.net.URI nextPage) Create a new platform stats request listing using a next page URI.
PlatformStatsRequest	setEnd(DateTime end) Set the request end date
PlatformStatsRequest	setPrecision(Precision precision) Set the request precision
PlatformStatsRequest	setStart(DateTime start) Set the request start date

Methods inherited from class java.lang.Object

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

Method Detail

newRequest

public static PlatformStatsRequest newRequest(PlatformStatsRequestType type)

Create a platform stats request.

Parameters:

type - PlatformStatsRequestType

Returns:

PlatformStatsRequest

newRequest

public static PlatformStatsRequest newRequest(java.net.URI nextPage)

Create a new platform stats request listing using a next page URI.

Parameters:

nextPage - URI

Returns:

PlatformStatsRequest

setStart

public PlatformStatsRequest setStart(DateTime start)

Set the request start date

Parameters:

start - DateTime

Returns:

PlatformStatsRequest

setEnd

public PlatformStatsRequest setEnd(DateTime end)

Set the request end date

Parameters:

end - DateTime

Returns:

PlatformStatsRequest

setPrecision

public PlatformStatsRequest setPrecision(Precision precision)

Set the request precision

Parameters:

precision - Precision

Returns:

DateTime

getContentType

public ContentType getContentType()

Specified by:

getContentType in interface Request<PlatformStatsResponse>

getRequestHeaders

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

Specified by:

getRequestHeaders in interface Request<PlatformStatsResponse>

getHttpMethod

public Request.HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface Request<PlatformStatsResponse>

getRequestBody

public java.lang.String getRequestBody()

Specified by:

getRequestBody in interface Request<PlatformStatsResponse>

getUri

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

Specified by:

getUri in interface Request<PlatformStatsResponse>

getResponseParser

public ResponseParser<PlatformStatsResponse> getResponseParser()

Specified by:

getResponseParser in interface Request<PlatformStatsResponse>

bearerTokenAuthRequired

public boolean bearerTokenAuthRequired()

Specified by:

bearerTokenAuthRequired in interface Request<PlatformStatsResponse>

canUseBearerTokenAuth

public boolean canUseBearerTokenAuth()

Specified by:

canUseBearerTokenAuth in interface Request<PlatformStatsResponse>