Package io.ably.lib.rest

Class AblyRest

java.lang.Object

io.ably.lib.rest.AblyBase

io.ably.lib.rest.AblyRest

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

AblyRealtime

public class AblyRest
extends AblyBase

The top-level class to be instanced for the Ably REST library for JRE. This class implements AutoCloseable so you can use it in try-with-resources constructs and have the JDK close it for you.

Nested Class Summary

Nested classes/interfaces inherited from class io.ably.lib.rest.AblyBase

AblyBase.Channels

Field Summary

Fields inherited from class io.ably.lib.rest.AblyBase

auth, channels, http, httpCore, options, platform, platformAgentProvider, push

Constructor Summary

Constructors

Constructor	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

Methods inherited from class io.ably.lib.rest.AblyBase

close, onAuthError, onAuthUpdated, onAuthUpdatedAsync, onClientIdSet, publishBatch, publishBatch, publishBatchAsync, publishBatchAsync, request, requestAsync, stats, statsAsync, time, timeAsync

Methods inherited from class java.lang.Object

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

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