module library

Classes

AuthenticationKeyManager
Manages keys for authentication with the server.
Caller
ConnectivityMonitor
Keeps track of internet connectivity and notifies its listeners when the internet connection is either lost or regained. For most use cases, use the concrete FlutterConnectivityMonitor class in the serverpod_flutter package.
EndpointCaller
Super class for all classes that can call a server endpoint.
EndpointRef
This class connects endpoints on the server with the client, it also hooks up streams with the endpoint. Overridden by generated code.
FileUploader
The file uploader uploads files to Serverpods cloud storage. On the server you can setup a custom storage service, such as S3 or Google Cloud. To directly upload a file, you first need to retrieve an upload description from your server. After the file is uploaded, make sure to notify the server by calling the verifyDirectFileUpload on the current Session object.
ModuleClass
ModuleEndpointCaller
This class is used to connect modules with the client. Overridden by generated code.
Protocol
SerializableEntity
The SerializableEntity is the base class for all serializable objects in Serverpod, except primitives.
SerializationManager
The SerializationManager is responsible for creating objects from a serialization, but also for serializing objects. This class is typically extended by generated code.
ServerpodClient
Handles communication with the server. Is typically overridden by generated code to provide implementations of methods for calling the server. This is the concrete implementation using the io library (for Flutter native apps).
ServerpodClientShared
Superclass with shared methods for handling communication with the server. It's overridden i two different versions depending on if the dart:io library is available.
StreamingConnectionHandler
The StreamingConnection handler manages the web socket connection and its state. It will automatically reconnect to the server if the connection is lost. The listener will be notfied whenever the connection state changes and once every second when counting down to reconnect. The time between reconnection attempts is specified with retryEverySeconds, default is 5 seconds.
StreamingConnectionHandlerState
Represents the state of the connection handler.

Enums

StreamingConnectionStatus
Status of the streaming connection.

Extensions

Base64Dec
Extension for decoding ByteData in protocol.
Base64Enc
Extension for encoding ByteData in the protocol.

Functions

getType<T>() Type
Get the type provided as an generic. Useful for getting a nullable type.

Typedefs

ConnectivityMonitorListener = void Function(bool connected)
Callback for when internet connectivity changes.
constructor<T> = T Function(dynamic jsonSerialization, SerializationManager serializationManager)
The constructor takes JSON structure and turns it into a decoded SerializableEntity.
VoidCallback = void Function()
A callback with no parameters or return value.

Exceptions / Errors

ServerpodClientException
Exception thrown when errors in communication with the server occurs.