callEvents method

Stream<QueryResult<Object?>> callEvents(
  1. ChatItemId id,
  2. ChatCallDeviceId deviceId
)

Subscribes to ChatCallEvents of a ChatCall.

This subscription is mandatory to be created after (and only after) executing startChatCall or joinChatCall as represents a heartbeat indication of the authenticated MyUser's participation in a ChatCall. Stopping or breaking this subscription without leaving a ChatCall will end up by kicking the authenticated MyUser from the ChatCall by timeout (if not re-established earlier).

Authentication

Mandatory.

Initialization

Once this subscription is initialized completely, it immediately emits SubscriptionInitialized followed by the initial state of the ChatCall (and they won't be emitted ever again until this subscription completes), or immediately completes without emitting anything, if such ChatCall hasn't been found or the authenticated MyUser doesn't participate in it.

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

Finite.

Completes without re-subscription necessity when:

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> callEvents(ChatItemId id, ChatCallDeviceId deviceId) {
  Log.debug('callEvents($id, $deviceId)', '$runtimeType');

  final variables = CallEventsArguments(id: id, deviceId: deviceId);
  return client.subscribe(
    SubscriptionOptions(
      operationName: 'CallEvents',
      document: CallEventsSubscription(variables: variables).document,
      variables: variables.toJson(),
    ),
  );
}