23 lines
811 B
Markdown
23 lines
811 B
Markdown
|
# 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.
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
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:
|
||
|
|
|
||
|
|
```dart
|
||
|
|
// Authenticate with email.
|
||
|
|
client.modules.auth.email.authenticate(email, password)
|
||
|
|
|
||
|
|
// Generic format.
|
||
|
|
client.modules.<nickname>.<endpoint>.<method>(...)
|
||
|
|
```
|
||
|
|
|
||
|
|
Please see the full official documentation [here](https://docs.serverpod.dev)
|