com.urbanairship.api.schedule

Class ScheduleListingRequest

java.lang.Object

com.urbanairship.api.schedule.ScheduleListingRequest

All Implemented Interfaces:

Request<ListAllSchedulesResponse>

public class ScheduleListingRequest
extends java.lang.Object
implements Request<ListAllSchedulesResponse>

The ListSchedulesRequest class builds schedule 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<ListAllSchedulesResponse>	getResponseParser()
java.net.URI	getUri(java.net.URI baseUri)
static ScheduleListingRequest	newRequest() Create a request to list all scheduled pushes.
static ScheduleListingRequest	newRequest(java.lang.String scheduleId) Create a request to lookup a specific scheduled push.
static ScheduleListingRequest	newRequest(java.net.URI nextPage) Create a request to lookup a next page of scheduled push listings.
static ScheduleListingRequest	newRequest(java.util.UUID start, int limit, ListSchedulesOrderType orderType) Create a request to list scheduled pushes with search parameters.

Methods inherited from class java.lang.Object

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

Method Detail

newRequest

public static ScheduleListingRequest newRequest()

Create a request to list all scheduled pushes.

Returns:

ListSchedulesRequest

newRequest

public static ScheduleListingRequest newRequest(java.lang.String scheduleId)

Create a request to lookup a specific scheduled push.

Parameters:

scheduleId - String

Returns:

ListSchedulesRequest

newRequest

public static ScheduleListingRequest newRequest(java.util.UUID start,
                                                int limit,
                                                ListSchedulesOrderType orderType)

Create a request to list scheduled pushes with search parameters.

Parameters:

start - UUID - The starting scheduled ID.

limit - int - The page limit.

orderType - ListSchedulesOrderType - How to order the response listing.

Returns:

ListSchedulesRequest

newRequest

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

Create a request to lookup a next page of scheduled push listings.

Parameters:

nextPage - URI - The next page given by a listing response.

Returns:

ListSchedulesRequest

getHttpMethod

public Request.HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface Request<ListAllSchedulesResponse>

getRequestBody

public java.lang.String getRequestBody()

Specified by:

getRequestBody in interface Request<ListAllSchedulesResponse>

getContentType

public ContentType getContentType()

Specified by:

getContentType in interface Request<ListAllSchedulesResponse>

getRequestHeaders

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

Specified by:

getRequestHeaders in interface Request<ListAllSchedulesResponse>

getUri

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

Specified by:

getUri in interface Request<ListAllSchedulesResponse>

getResponseParser

public ResponseParser<ListAllSchedulesResponse> getResponseParser()

Specified by:

getResponseParser in interface Request<ListAllSchedulesResponse>

bearerTokenAuthRequired

public boolean bearerTokenAuthRequired()

Specified by:

bearerTokenAuthRequired in interface Request<ListAllSchedulesResponse>

canUseBearerTokenAuth

public boolean canUseBearerTokenAuth()

Specified by:

canUseBearerTokenAuth in interface Request<ListAllSchedulesResponse>