keepOnline method

Stream<QueryResult<Object?>> keepOnline()

Keeps the authenticated MyUser online while subscribed.

Keep this subscription up while the authenticated MyUser should be considered as online. Once this subscription begins User.online of MyUser becomes UserOnline, and once ends sets it to UserOffline.

Authentication

Mandatory.

Initialization

Once this subscription is initialized completely, it immediately emits SubscriptionInitialized.

If nothing has been emitted for a long period of time after establishing this subscription (while not being completed), it should be considered as an unexpected server error. This fact can be used on a client side to decide whether this subscription has been initialized successfully.

Completion

Infinite.

Completes requiring a re-subscription when:

  • Authenticated Session expires (SESSION_EXPIRED error is emitted).
  • An error occurs on the server (error is emitted).
  • The server is shutting down or becoming unreachable (unexpectedly completes after initialization).

Implementation

Stream<QueryResult> keepOnline() {
  Log.debug('keepOnline()', '$runtimeType');

  return client.subscribe(
    SubscriptionOptions(
      operationName: 'KeepOnline',
      document: KeepOnlineSubscription().document,
    ),
  );
}