keepTyping method

Stream<QueryResult<Object?>> keepTyping(
  1. ChatId id
)

Notifies ChatMembers about the authenticated MyUser typing in the specified Chat at the moment.

Keep this subscription up while the authenticated MyUser is typing. Once this subscription begins, chatEvents emit EventChatTypingStarted, and EventChatTypingStopped once it ends.

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> keepTyping(ChatId id) {
  Log.debug('keepTyping($id)', '$runtimeType');

  final variables = KeepTypingArguments(chatId: id);
  return client.subscribe(
    SubscriptionOptions(
      operationName: 'KeepTyping',
      document: KeepTypingSubscription(variables: variables).document,
      variables: variables.toJson(),
    ),
  );
}