EndpointStatus class Endpoint
Endpoint for getting status for a signed in user and module configuration.
- Inheritance
-
- Object
- EndpointRef
- EndpointStatus
Constructors
- EndpointStatus(EndpointCaller caller)
Properties
- caller → EndpointCaller
-
Holds a reference to the caller class.
finalinherited
- client ↔ ServerpodClientShared
-
Reference to the client.
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- name → String
-
The name of the endpoint this reference is connected to.
no setteroverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
stream
→ Stream<
SerializableEntity> -
Stream of messages sent from an endpoint that supports streaming.
no setterinherited
Methods
-
getUserInfo(
) → Future< UserInfo?> -
Gets the
UserInfofor a signed in user, or null if the user is currently not signed in with the server. -
getUserSettingsConfig(
) → Future< UserSettingsConfig> - Gets the server configuration.
-
isSignedIn(
) → Future< bool> - Returns true if the client user is signed in.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
resetStream(
) → void -
Resets web socket stream, so it's possible to re-listen to endpoint
streams.
inherited
-
sendStreamMessage(
SerializableEntity message) → Future< void> -
Sends a message to the endpoint's stream.
inherited
-
signOut(
) → Future< void> - Signs out a user.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited