Package io.ably.lib.types

Class HttpPaginatedResponse

java.lang.Object

io.ably.lib.types.HttpPaginatedResponse

Direct Known Subclasses:

HttpPaginatedQuery.HttpPaginatedResult

public abstract class HttpPaginatedResponse
extends java.lang.Object

A type that represents a page of results from a paginated http query. The response is accompanied by response details and metadata that indicates the relative queries available.

Field Summary

Fields

Modifier and Type	Field	Description
int	errorCode
java.lang.String	errorMessage
Param[]	headers
int	statusCode
boolean	success

Constructor Summary

Constructors

Constructor	Description
HttpPaginatedResponse()

Method Summary

Modifier and Type	Method	Description
abstract HttpPaginatedResponse	current()
abstract HttpPaginatedResponse	first()	Perform the given relative query
abstract boolean	hasCurrent()
abstract boolean	hasFirst()
abstract boolean	hasNext()
abstract boolean	isLast()
abstract com.google.gson.JsonElement[]	items()	Get the contents as an array of component type
abstract HttpPaginatedResponse	next()

Methods inherited from class java.lang.Object

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

Field Detail

success

public boolean success

statusCode

public int statusCode

errorCode

public int errorCode

errorMessage

public java.lang.String errorMessage

headers

public Param[] headers

Constructor Detail

HttpPaginatedResponse

public HttpPaginatedResponse()

Method Detail

items

public abstract com.google.gson.JsonElement[] items()

Get the contents as an array of component type

first

public abstract HttpPaginatedResponse first()
                                     throws AblyException

Perform the given relative query

Throws:

AblyException

current

public abstract HttpPaginatedResponse current()
                                       throws AblyException

Throws:

AblyException

next

public abstract HttpPaginatedResponse next()
                                    throws AblyException

Throws:

AblyException

hasFirst

public abstract boolean hasFirst()

hasCurrent

public abstract boolean hasCurrent()

hasNext

public abstract boolean hasNext()

isLast

public abstract boolean isLast()