Session class
- Inheritance
-
- Object
- ChangeNotifier
- Session
Constructors
- Session()
Properties
- attemptingConnect ↔ bool
-
getter/setter pair
- connected ↔ bool
-
getter/setter pair
-
functionsToBeExecutedOnConnect
↔ List<
OnSessionConnected> -
getter/setter pair
-
functionsToBeExecutedOnDisconnect
↔ List<
OnSessionDisconnected> -
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListeners → bool
-
Whether any listeners are currently registered.
no setterinherited
- phoenixSocket ↔ PhoenixSocket?
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addListener(
VoidCallback listener) → void -
Register a closure to be called when the object changes.
inherited
-
connect(
String accessToken) → Future< PhoenixSocket?> - Connect with the given access token via WebSocket to the backend. Will be rejected without right access token.
-
dispose(
) → void -
Discards any resources used by the object. After this is called, the
object is not in a usable state and should be discarded (calls to
addListener will throw after the object is disposed).
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyListeners(
) → void -
Call all the registered listeners.
inherited
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- globalSessionInstance ↔ Session
-
getter/setter pair
- lastAccessToken ↔ String?
-
getter/setter pair
Static Methods
-
getInstance(
) → Session - Get the global session instance. Do not instantiate Session directly, but only throgh this, based on Singleton pattern.
-
lossConnection(
{bool reconnect = false}) → void -
regainConnection(
) → void -
wheneverUserConnects(
OnSessionConnected onSessionConnected, {bool executeIfAlreadyConnected = true}) → void - Provide a method that runs whenever a user initially gains connection or regains connection after he or she lost connection
-
wheneverUserDisconnects(
OnSessionDisconnected onSessionDisconnected) → void - Provide a method that gets executed whenever a user loses connection to the server.