Realtime class
A client that extends functionality of the Rest and provides additional realtime-specific features.
Constructors
- Realtime({ClientOptions? options, String? key})
-
Constructs a
Realtimeobject using an Ablyoptionsobject or the Ably APIkeyor token string used to validate the client. - Realtime.fromKey(String key)
-
Constructs a
Realtimeobject using an Ably APIkeyor token string used to validate the client.factory
Properties
- auth ↔ Auth
-
An Auth object.
getter/setter pair
- channels → RealtimeChannels
-
A Channels object.
no setter
- connection → Connection
-
A Connection object.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- push ↔ Push
-
A Push object.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
close(
) → Future< void> - Calls Connection.close and causes the connection to close, entering the closing state.
-
connect(
) → Future< void> - Calls Connection.connect and causes the connection to open, entering the connecting state.
-
device(
) → Future< LocalDevice> - Retrieves a LocalDevice object that represents the current state of the device as a target for push notifications.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
time(
) → Future< DateTime> - Retrieves the DateTime from the Ably service. Clients that do not have access to a sufficiently well maintained time source and wish to issue Ably TokenRequests with a more accurate timestamp should use the AuthOptions.queryTime property on a ClientOptions object instead of this method.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited