Package io.ably.lib.http

Class PaginatedQuery<T>

java.lang.Object

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

Type Parameters:

T - the body response type.

public class PaginatedQuery<T>
extends Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
PaginatedResult<T>	get()	Get the result of the first query

Methods inherited from class java.lang.Object

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

Constructor Details

PaginatedQuery

public PaginatedQuery(Http http,
 String path,
 Param[] headers,
 Param[] params,
 HttpCore.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

PaginatedQuery

public PaginatedQuery(Http http,
 String path,
 Param[] headers,
 Param[] params,
 HttpCore.RequestBody requestBody,
 HttpCore.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 Details

get

public PaginatedResult<T> get()
                       throws AblyException

Get the result of the first query

Returns:

A PaginatedResult giving the first page of results together with any available links to related results pages.

Throws:

AblyException