UserProfileBaseEndpoint class abstract

Base endpoint for user profile management.

To expose these endpoint methods on your server, extend this class in a concrete class. For further details see https://docs.serverpod.dev/concepts/working-with-endpoints#inheriting-from-an-endpoint-class-marked-abstract

Properties

hashCode → int
The hash code for this object.
no setterinherited
logSessions → bool
States if Sessions should be logged for this endpoint. Defaults to true, override to change.
no setterinherited
moduleName → String?
The name of the current module, or null for the main server.
no setterinherited
name → String
The name of this Endpoint. It will be automatically generated from the name of the class (excluding any Endpoint suffix).
no setterinherited
pod → Serverpod
The ServerPod this Endpoint is running on.
no setterinherited
requiredScopes → Set<Scope>
List of Scopes that are required to access this Endpoint. Override this getter to setup custom requirements.
no setterinherited
requireLogin → bool
States if the Endpoint only should accept users that are authenticated. Default value is false, override to change.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sendAsRaw → bool
If true, returned value from methods will be sent sent to the client as raw data without any formatting. One use case is to return data through a non-api call. Defaults to false, override to change. If used, the endpoint method is responsible for correctly setting the contentType of the http response (defaults to text/plain).
no setterinherited
server → Server
The Server this Endpoint is running on.
no setterinherited

Methods

changeFullName(Session session, String? fullName) → Future<UserProfileModel>
Changes the full name of a user.
changeUserName(Session session, String? userName) → Future<UserProfileModel>
Changes the name of a user.
get(Session session) → Future<UserProfileModel>
Returns the user profile of the current user.
getUserObject(Session session) → dynamic
Retrieves a custom object associated with this Endpoint and Session.
inherited
handleStreamMessage(StreamingSession session, SerializableModel message) → Future<void>
Invoked when a message is sent to this endpoint from the client. Override this method to create your own custom StreamingEndpoint.
inherited
initialize(Server server, String name, String? moduleName) → void
Initializes the endpoint with the current Server. Typically, this is done from generated code.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeUserImage(Session session) → Future<UserProfileModel>
Removes the users uploaded image, replacing it with the default user image.
sendStreamMessage(StreamingSession session, SerializableModel message) → Future<void>
Sends an event to the client represented by the Session object.
inherited
setUserImage(Session session, ByteData image) → Future<UserProfileModel>
Sets a new user image for the signed in user.
setUserObject(Session session, dynamic userObject) → void
Associate a custom object with this Endpoint and Session.
inherited
streamClosed(StreamingSession session) → Future<void>
Called when a stream was closed.
inherited
streamOpened(StreamingSession session) → Future<void>
Override this method to setup a new stream when a client connects to the server.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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