ClientOptions class
The options that can be passed to the Altogic client instance
Constructors
- ClientOptions({String? apiKey, ClientStorage? localStorage, void signInRedirect()?, RealtimeOptions? realtime})
- Creates a instance of ClientOptions
Properties
- apiKey ↔ String?
-
The unique app environment API Key which needs to be created using the
Altogic app designer. The apiKey is passed in Authorization Header
when making RESTful API calls to your app endpoints. This key is different
than the
clientKey
used when creating an instance of Altogic client library.clientKey
is primarily used to manage access rigths of the client library whereasapiKey
is used to manage access to your app endpoints.getter/setter pair - hashCode → int
-
The hash code for this object.
no setterinherited
- localStorage ↔ ClientStorage?
-
Client storage handler to store user and session data. By default uses
shared_preferences. If client is not a browser then you
need to provide an object with setItem(String key,String data),
getItem(String key) and removeItem(String key) methods to manage user and
session data storage.
getter/setter pair
- realtime ↔ RealtimeOptions?
-
The configuration parameters for websocket connections
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- signInRedirect ↔ (void Function()?)
-
The sign in page URL to redirect the user when user's session becomes
invalid. Altogic client library observes the responses of the requests
made to your app backend. If it detects a response with an error code of
missing or invalid session token, it can redirect the users to
this signin url.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited