convex_flutter library

Classes

AuthHandle
AuthHandleWrapper
Wrapper for auth handle providing Dart-friendly API.
CallbackSubscriber
CallbackSubscriberDartFn
ConvexClient
A client for interacting with a Convex backend service.
ConvexConfig
Configuration for ConvexClient initialization.
MobileConvexClient
QuerySubscriber
RustLib
Main entrypoint of the Rust API
SubscriptionHandle

Enums

AppLifecycleEvent
Enum representing Flutter app lifecycle state changes.
ConnectionStatus
Enum representing the possible connection states when checking connectivity to the Convex backend.
WebSocketConnectionState
WebSocket connection state exposed to Flutter/Dart.

Extensions

ClientErrorPatterns on ClientError
Adds pattern-matching-related methods to ClientError.

Typedefs

AuthStateCallback = void Function(bool isAuthenticated)
Callback type for authentication state changes.
TokenFetcher = Future<String?> Function()
Callback type for fetching authentication tokens. Should return a JWT token string, or null to sign out.

Exceptions / Errors

ClientError