RealtimeOptions class
The options that can be passed to the client instance realtime module
Constructors
Properties
- autoJoinChannels ↔ bool?
-
The flag to enable or prevent automatic join to channels already
subscribed in case of websocket reconnection. When websocket is
disconnected, it automatically leaves subscribed channels.
This parameter helps re-joining to already joined channels when
the connection is restored.
getter/setter pair
- bufferMessages ↔ bool?
-
By default, any event emitted while the realtime socket is not
connected will be buffered until reconnection. You can turn
on/off the message buffering using this parameter.
getter/setter pair
- echoMessages ↔ bool?
-
The flag to enable or prevent realtime messages originating from
this connection being echoed back on the same connection.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- reconnectionDelay ↔ int?
-
The initial delay before realtime reconnection in milliseconds.
@type {number}
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- timeout ↔ int?
-
The timeout in milliseconds for each realtime connection attempt.
@type {number}
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited