Constructor #

Use this constructor to create a new instance of the SDK. Each instance represents a different connection to a Kuzzle server with specific options.

Arguments #

Kuzzle(
    protocol, {
    autoQueue = false,
    autoReplay = false,
    autoResubscribe = true,
    eventTimeout = 200,
    offlineMode = OfflineMode.manual,
    offlineQueueLoader,
    queueFilter,
    queueTTL,
    queueMaxSize = 500,
    replayInterval,
    deprecationWarnings = true,
    globalVolatile,
  })

Argument	Type	Description
`protocol`	AbstractProtocol	Protocol used by the SDK instance

protocol #

The protocol used to connect to the Kuzzle instance. It can be one of the following available protocols:

WebSocket

Return #

The Kuzzle SDK instance.

Usage #

final kuzzle = Kuzzle(
    WebSocketProtocol(Uri(
    scheme: 'ws',
    host: 'kuzzle',
    port: 7512,
  )),
    offlineMode: OfflineMode.auto,
  );

Edit this page on Github