io.ably.lib.rest

Class AblyRest

java.lang.Object

io.ably.lib.rest.AblyRest

Direct Known Subclasses:

AblyRealtime

public class AblyRest
extends java.lang.Object

AblyRest The top-level class to be instanced for the Ably REST library.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AblyRest.Channels A collection of Channels associated with an Ably instance.

Field Summary

Fields

Modifier and Type	Field and Description
AsyncHttp	asyncHttp
Auth	auth
AblyRest.Channels	channels
Http	http
ClientOptions	options

Constructor Summary

Constructors

Constructor and Description
AblyRest(ClientOptions options) Instance the Ably library with the given options.
AblyRest(java.lang.String key) Instance the Ably library using a key only.

Method Summary

Modifier and Type	Method and Description
PaginatedResult<Stats>	stats(Param[] params) Request usage statistics for this application.
void	statsAsync(Param[] params, Callback<AsyncPaginatedResult<Stats>> callback) Asynchronously obtain usage statistics for this application using the REST API.
long	time() Obtain the time from the Ably service.
void	timeAsync(Callback<java.lang.Long> callback) Asynchronously obtain the time from the Ably service.

Methods inherited from class java.lang.Object

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

Field Detail

options

public final ClientOptions options

http

public final Http http

asyncHttp

public final AsyncHttp asyncHttp

auth

public final Auth auth

channels

public final AblyRest.Channels channels

Constructor Detail

AblyRest

public AblyRest(java.lang.String key)
         throws AblyException

Instance the Ably library using a key only. This is simply a convenience constructor for the simplest case of instancing the library with a key for basic authentication and no other options.

Parameters:

key; - String key (obtained from application dashboard)

Throws:

AblyException

AblyRest

public AblyRest(ClientOptions options)
         throws AblyException

Instance the Ably library with the given options.

Parameters:

options: - see ClientOptions for options

Throws:

AblyException

Method Detail

time

public long time()
          throws AblyException

Obtain the time from the Ably service. This may be required on clients that do not have access to a sufficiently well maintained time source, to provide timestamps for use in token requests

Returns:

time in millis since the epoch

Throws:

AblyException

timeAsync

public void timeAsync(Callback<java.lang.Long> callback)

Asynchronously obtain the time from the Ably service. This may be required on clients that do not have access to a sufficiently well maintained time source, to provide timestamps for use in token requests

Parameters:

callback -

stats

public PaginatedResult<Stats> stats(Param[] params)
                             throws AblyException

Request usage statistics for this application. Returned stats are application-wide and not just relating to this instance.

Parameters:

params - query options: see Ably REST API documentation for available options

Returns:

a PaginatedResult of Stats records for the requested params

Throws:

AblyException

statsAsync

public void statsAsync(Param[] params,
                       Callback<AsyncPaginatedResult<Stats>> callback)

Asynchronously obtain usage statistics for this application using the REST API.

Parameters:

params: - the request params. See the Ably REST API

callback -