AltogicClient class
Dart client for interacting with your backend applications developed in Altogic.
AltogicClient is the main object that you will be using to issue commands to your backend apps. The commands that you can run are grouped below:
- auth : AuthManager - Manage users and user sessions
- endpoint : EndpointManager - Make http requests to your app endpoints and execute associated services
- db : DatabaseManager - Perform CRUD (including lookups, filtering, sorting, pagination) operations in your app database
- queue : QueueManager - Enables you to run long-running jobs asynchronously by submitting messages to queues
- cache : CacheManager - Store and manage your data objects in high-speed data storage layer (Redis)
- task : TaskManager - Manually trigger execution of scheduled tasks (e.g., cron jobs)
Each AltogicClient can interact with one of your app environments
(e.g., development, test, production). You cannot create a single
client to interact with multiple development, test or production
environments at the same time. If you would like to issue commands
to other environments, you need to create additional AltogicClient
objects using the target environment's envUrl.
Constructors
- AltogicClient(String envUrl, String clientKey, [ClientOptions? options])
- Create a new client for altogic applications.
Properties
- auth → FlutterAuthManager
-
Returns the authentication manager that can be used to perform user
and session management activities.
no setter
- cache → CacheManager
-
Returns the cache manager which is used to store and manage objects
in Redis cache.
no setterinherited
- db → DatabaseManager
-
Returns the database manager, which is used to perform CRUD (create, read,
update and delete) and run queries in your app's database.
no setterinherited
- endpoint → EndpointManager
-
Returns the endpoint manager which is used to make http requests to
your app endpoints and execute associated services.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- queue → QueueManager
-
Returns the queue manager which is used to submit messages to a
message queue for processing.
no setterinherited
- realtime → RealtimeManager
-
Returns the realtime manager, which is used to publish and subscribe
(pub/sub) messaging through websockets.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- storage → StorageManager
-
Returns the storage manager, which is used to manage buckets and files
of your app.
no setterinherited
- task → TaskManager
-
Returns the task manager which is used to trigger scheduled tasks
(e.g., cron jobs) for execution.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
restoreAuthSession(
) → Future< void> - In Flutter apps, restoreLocalAuthSession restores the user session from local storage.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited