Endpoint topic

Callable endpoints

Each class contains callable methods that will call a method on the server side. The classes are accessible via the Serverpod client you have created in your Flutter app. The name of the module is defined in your config/generator.yaml file in the server project.

modules:
  <module_name>:
    nickname: <nickname>

The name "EndpointClass" where Class is your class name will have the "Endpoint" part stripped when the client is code generated. When accessing you can simply use the endpoint name in lowercase.

Example usage:

// Authenticate with email.
client.modules.auth.email.authenticate(email, password)

// Generic format.
client.modules.<nickname>.<endpoint>.<method>(...)

Please see the full official documentation here

Classes

EndpointAdmin Endpoint
Endpoint for handling admin functions.
EndpointAdmin Endpoint
Endpoint for handling admin functions.
EndpointAdmin Endpoint
Endpoint for handling admin functions.
EndpointApple Endpoint
Endpoint for handling Sign in with Apple.
EndpointApple Endpoint
Endpoint for handling Sign in with Apple.
EndpointApple Endpoint
Endpoint for handling Sign in with Apple.
EndpointEmail Endpoint
Endpoint for handling Sign in with Google.
EndpointEmail Endpoint
Endpoint for handling Sign in with Google.
EndpointEmail Endpoint
Endpoint for handling Sign in with Google.
EndpointFirebase Endpoint
Endpoint for handling Sign in with Firebase.
EndpointFirebase Endpoint
Endpoint for handling Sign in with Firebase.
EndpointFirebase Endpoint
Endpoint for handling Sign in with Firebase.
EndpointGoogle Endpoint
Endpoint for handling Sign in with Google.
EndpointGoogle Endpoint
Endpoint for handling Sign in with Google.
EndpointGoogle Endpoint
Endpoint for handling Sign in with Google.
EndpointStatus Endpoint
Endpoint for getting status for a signed in user and module configuration.
EndpointStatus Endpoint
Endpoint for getting status for a signed in user and module configuration.
EndpointStatus Endpoint
Endpoint for getting status for a signed in user and module configuration.
EndpointUser Endpoint
Endpoint with methods for managing the currently signed in user.
EndpointUser Endpoint
Endpoint with methods for managing the currently signed in user.
EndpointUser Endpoint
Endpoint with methods for managing the currently signed in user.