Kuzzle class
- Inheritance
-
- Object
- KuzzleEventEmitter
- Kuzzle
Constructors
-
Kuzzle(KuzzleProtocol protocol, {bool autoQueue = false, bool autoReplay = false, bool autoResubscribe = true, bool deprecationWarnings = true, int eventTimeout = 200, OfflineMode offlineMode = OfflineMode.manual, Function? offlineQueueLoader, Function? queueFilter, Duration? queueTTL, int queueMaxSize = 500, Duration? replayInterval, Map<
String, dynamic> ? globalVolatile})
Properties
- auth ↔ AuthController
-
getter/setter pair
- autoQueue ↔ bool
-
Automatically queue all requests during offline mode
getter/setter pair
- autoReplay ↔ bool
-
Automatically replay queued requests on a reconnected event
getter/setter pair
- autoResubscribe ↔ bool
-
Automatically renew all subscriptions on a reconnected event
getter/setter pair
- bulk ↔ BulkController
-
getter/setter pair
- collection ↔ CollectionController
-
getter/setter pair
- deprecationHandler → DeprecationHandler
-
final
- document ↔ DocumentController
-
getter/setter pair
- eventTimeout → int
-
final
-
globalVolatile
↔ Map<
String, dynamic> ? -
Common volatile data, will be sent to all future requests
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- index ↔ IndexController
-
getter/setter pair
- jwt ↔ String?
-
Token used in requests for authentication
getter/setter pair
- offlineMode → OfflineMode
-
final
- offlineQueueLoader → Function?
-
final
- protocol → KuzzleProtocol
-
Protocol used by the SDK
final
- queueFilter → Function?
-
final
- queueMaxSize ↔ int
-
Number of maximum requests kept during offline mode
getter/setter pair
- queueTTL ↔ Duration?
-
Time a queued request is kept during offline mode, in milliseconds
getter/setter pair
- realtime ↔ RealTimeController
-
getter/setter pair
- replayInterval ↔ Duration?
-
Delay between each replayed requests
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- security ↔ SecurityController
-
getter/setter pair
- server ↔ ServerController
-
getter/setter pair
Methods
-
addListener(
String eventName, Function callback, {bool once = false}) → void -
inherited
-
connect(
) → Future< void> - Connects to a Kuzzle instance using the provided host name
-
disconnect(
) → void - Disconnects from Kuzzle and invalidate this instance.
-
emit(
String eventName, [List? positionalArguments, Map< Symbol, dynamic> ? namedArguments]) → bool -
Call all listeners registered for
eventNameeventinherited -
eventNames(
) → List< String> -
inherited
-
flushQueue(
) → void - Empties the offline queue without replaying it.
-
listenerCount(
String eventName) → int -
inherited
-
listeners(
String eventName) → List< _KuzzleListener> ? -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
off(
String eventName, Function callback) → void -
inherited
-
on(
String eventName, Function callback) → void -
inherited
-
once(
String eventName, Function callback) → void -
inherited
-
playQueue(
) → void - Plays the requests queued during offline mode.
-
prependListener(
String eventName, Function callback, {bool once = false}) → void -
inherited
-
query(
KuzzleRequest request, {Map< String, dynamic> ? volatile, bool queueable = true}) → Future<KuzzleResponse> - Base method used to send read queries to Kuzzle
-
removeAllListeners(
[String? eventName]) → void -
inherited
-
removeListener(
String eventName, Function callback) → void -
inherited
-
startQueuing(
) → void - Starts the requests queuing.
-
stopQueuing(
) → void - Stops the requests queuing.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator [](
String accessor) → KuzzleController? -
operator []=(
String accessor, KuzzleController controller) → void