io.ably.lib.http

Class AsyncPaginatedQuery<T>

java.lang.Object

io.ably.lib.http.AsyncPaginatedQuery<T>

Type Parameters:

T - the body response type.

All Implemented Interfaces:

Http.ResponseHandler<AsyncPaginatedResult<T>>

public class AsyncPaginatedQuery<T>
extends java.lang.Object
implements Http.ResponseHandler<AsyncPaginatedResult<T>>

An object that encapsulates parameters of a REST query with a paginated response

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AsyncPaginatedQuery.ResultPage A private class encapsulating the result of a single page response

Constructor Summary

Constructors

Constructor and Description
AsyncPaginatedQuery(AsyncHttp http, java.lang.String path, Param[] headers, Param[] params, Http.BodyHandler<T> bodyHandler) Construct a PaginatedQuery
AsyncPaginatedQuery(AsyncHttp http, java.lang.String path, Param[] headers, Param[] params, Http.RequestBody requestBody, Http.BodyHandler<T> bodyHandler) Construct a PaginatedQuery

Method Summary

Modifier and Type	Method and Description
void	exec(java.lang.String method, Callback<AsyncPaginatedResult<T>> callback) Get the result of a query with the current params
void	exec(java.lang.String method, Param[] params, Callback<AsyncPaginatedResult<T>> callback) Get the result of a query with the given params
void	get(Callback<AsyncPaginatedResult<T>> callback) Get the result of the first query
AsyncPaginatedResult<T>	handleResponse(Http.Response response, ErrorInfo error)

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncPaginatedQuery

public AsyncPaginatedQuery(AsyncHttp http,
                           java.lang.String path,
                           Param[] headers,
                           Param[] params,
                           Http.BodyHandler<T> bodyHandler)

Construct a PaginatedQuery

Parameters:

http. - the http instance

path. - the path of the resource being queried

headers. - headers to pass into the first and all relative queries

params. - params to pass into the initial query

bodyHandler. - handler to parse response bodies for first and all relative queries

AsyncPaginatedQuery

public AsyncPaginatedQuery(AsyncHttp http,
                           java.lang.String path,
                           Param[] headers,
                           Param[] params,
                           Http.RequestBody requestBody,
                           Http.BodyHandler<T> bodyHandler)

Construct a PaginatedQuery

Parameters:

http. - the http instance

path. - the path of the resource being queried

headers. - headers to pass into the first and all relative queries

params. - params to pass into the initial query

bodyHandler. - handler to parse response bodies for first and all relative queries

Method Detail

get

public void get(Callback<AsyncPaginatedResult<T>> callback)

Get the result of the first query

Parameters:

callback. - On success returns A PaginatedResult giving the first page of results together with any available links to related results pages.

exec

public void exec(java.lang.String method,
                 Callback<AsyncPaginatedResult<T>> callback)

Get the result of a query with the current params

Parameters:

callback. - On success returns A PaginatedResult giving the first page of results together with any available links to related results pages.

exec

public void exec(java.lang.String method,
                 Param[] params,
                 Callback<AsyncPaginatedResult<T>> callback)

Get the result of a query with the given params

Parameters:

callback. - On success returns A PaginatedResult giving the first page of results together with any available links to related results pages.

handleResponse

public AsyncPaginatedResult<T> handleResponse(Http.Response response,
                                              ErrorInfo error)
                                       throws AblyException

Specified by:

handleResponse in interface Http.ResponseHandler<AsyncPaginatedResult<T>>

Throws:

AblyException