ServerpodClientShared class abstract

Superclass with shared methods for handling communication with the server. Is typically overridden by generated code to provide implementations of methods for calling the server.

Inheritance
Implementers

Constructors

ServerpodClientShared(String host, SerializationManager serializationManager, {dynamic securityContext, required AuthenticationKeyManager? authenticationKeyManager, required Duration? streamingConnectionTimeout, required Duration? connectionTimeout, void onFailedCall(MethodCallContext callContext, Object error, StackTrace stackTrace)?, void onSucceededCall(MethodCallContext callContext)?, bool? disconnectStreamsOnLostInternetConnection})
Creates a new ServerpodClientShared.

Properties

authenticationKeyManager → AuthenticationKeyManager?
Optional AuthenticationKeyManager if the client needs to sign the user in.
final
connectionTimeout ↔ Duration
Timeout when calling a server endpoint. If no response has been received, defaults to 20 seconds.
getter/setter pair
connectivityMonitor ↔ ConnectivityMonitor?
Set a connectivity monitor to better manage streaming connections. You can find the FlutterConnectivityMonitor in the serverpod_flutter package.
getter/setter pair
endpointRefLookup → Map<String, EndpointRef>
Looks up an EndpointRef by its name. This method is typically only used internally and overridden by generated code.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
host → String
Full url to the Serverpod server. E.g. "https://example.com/"
final
moduleLookup → Map<String, ModuleEndpointCaller>
Looks up module callers by their name. Overridden by generated code.
no setter
onFailedCall → void Function(MethodCallContext callContext, Object error, StackTrace stackTrace)?
Callback when any call to the server fails or an exception is thrown.
final
onSucceededCall → void Function(MethodCallContext callContext)?
Callback when any call to the server succeeds.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serializationManager → SerializationManager
The SerializationManager used to serialize objects sent to the server.
final
streamingConnectionStatus → StreamingConnectionStatus
Returns the current status of the streaming connection. It can be one of connected, connecting, or disconnected. Use the StreamingConnectionHandler if you want to automatically reconnect if the connection is lost.
no setter
streamingConnectionTimeout → Duration
Timeout when opening a web socket connection. If no message has been received within the timeout duration the socket will be closed.
final
websocketHost → Future<String>
Full host name of the web socket endpoint. E.g. "wss://example.com/websocket"
no setter

Methods

addStreamingConnectionStatusListener(VoidCallback listener) → void
Adds a callback for when the streamingConnectionStatus property is changed.
callServerEndpoint<T>(String endpoint, String method, Map<String, dynamic> args) → Future<T>
Calls a server endpoint method by its name, passing arguments in a map. Typically, this method is called by generated code.
override
callStreamingServerEndpoint<T, G>(String endpoint, String method, Map<String, dynamic> args, Map<String, Stream> streams) → dynamic
Calls a server endpoint method that supports streaming. The streams parameter is a map of stream names to stream objects. The method will listen to the streams and send the data to the server. Typically, this method is called by generated code.
override
close() → void
Closes all open connections to the server.
closeStreamingConnection() → Future<void>
Closes the streaming connection if it is open.
closeStreamingMethodConnections({Object? exception = const WebSocketClosedException()}) → Future<void>
Closes all open streaming method connections.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
openStreamingConnection({bool disconnectOnLostInternetConnection = true}) → Future<void>
Open a streaming connection to the server.
removeStreamingConnectionStatusListener(VoidCallback listener) → void
Removes a connection status listener.
toString() → String
A string representation of this object.
inherited
updateStreamingConnectionAuthenticationKey(String? authKey) → Future<void>
Updates the authentication key if the streaming connection is open. Note, the provided key will be converted/wrapped as a proper authentication header value when sent to the server.

Operators

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