Client class

Constructors

Client(String host, {dynamic securityContext, AuthenticationKeyManager? authenticationKeyManager, Duration? streamingConnectionTimeout, Duration? connectionTimeout})

Properties

authenticationKeyManager → AuthenticationKeyManager?

Optional AuthenticationKeyManager if the client needs to sign the user in.

final, inherited

connectionTimeout ↔ Duration

Timeout when calling a server endpoint. If no response has been received, defaults to 20 seconds.

getter/setter pair, inherited

connectivityMonitor ↔ ConnectivityMonitor?

Set a connectivity monitor to better manage streaming connections. You can find the FlutterConnectivityMonitor in the serverpod_flutter package.

getter/setter pair, inherited

endpointRefLookup → Map<String, EndpointRef>

Looks up an EndpointRef by its name. This method is typically only used internally and overridden by generated code.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

host → String

Full url to the Serverpod server. E.g. "https://example.com/"

final, inherited

insights ↔ EndpointInsights

late, final

isWebSocketConnected → bool

Returns true if the web socket is connected.

no setter, inherited

logFailedCalls → bool

If true, the client will log any failed calls to stdout.

final, inherited

moduleLookup → Map<String, ModuleEndpointCaller>

Looks up module callers by their name. Overridden by generated code.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serializationManager → SerializationManager

The SerializationManager used to serialize objects sent to the server.

final, inherited

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, inherited

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, inherited

websocketHost → Future<String>

Full host name of the web socket endpoint. E.g. "wss://example.com/websocket"

no setter, inherited

Methods

addStreamingConnectionStatusListener(VoidCallback listener) → void

Adds a callback for when the streamingConnectionStatus property is changed.

inherited

addWebSocketConnectionStatusListener(VoidCallback listener) → void

Adds a callback for when the isWebSocketConnected property is changed.

inherited

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.

inherited

close() → void

Closes all open connections to the server.

inherited

closeStreamingConnection() → Future<void>

Closes the streaming connection if it is open.

inherited

connectWebSocket() → Future<void>

Open a streaming connection to the server.

inherited

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.

inherited

reconnectWebSocket() → Future<void>

Closes the current web socket connection (if open), then connects again.

inherited

removeStreamingConnectionStatusListener(VoidCallback listener) → void

Removes a connection status listener.

inherited

removeWebSocketConnectionStatusListener(VoidCallback listener) → void

Removes a connection status listener.

inherited

toString() → String

A string representation of this object.

inherited

updateStreamingConnectionAuthenticationKey(String? authKey) → Future<void>

Updates the authentication key if the streaming connection is open.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited