EndpointUser class Endpoint

Endpoint with methods for managing the currently signed in user.

Inheritance

Constructors

EndpointUser(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

changeUserName(String userName) Future<bool>
Changes the name of a user.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeUserImage() Future<bool>
Removes the users uploaded image, replacing it with the default user image.
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
setUserImage(ByteData image) Future<bool>
Sets a new user image for the signed in user.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited