Interface Typing

channel

get

• get(): Promise<Set<string>>

• Get the current typers, a set of clientIds.

  Returns Promise<Set<string>>

  A Promise of a set of clientIds that are currently typing.

onDiscontinuity

• onDiscontinuity(listener): OnDiscontinuitySubscriptionResponse

• Register a listener to be called when a discontinuity is detected.

  Parameters

  • listener: DiscontinuityListener

    The listener to be called when a discontinuity is detected.

  Returns OnDiscontinuitySubscriptionResponse

  A response that allows control of the subscription.

start

• start(): Promise<void>

• Start indicates that the current user is typing. This will emit a typingStarted event to inform listening clients and begin a timer, once the timer expires, a typingStopped event will be emitted. The timeout is configurable through the typingTimeoutMs parameter. If the current user is already typing, it will reset the timer and being counting down again without emitting a new event.

  Returns Promise<void>

  A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.

stop

• stop(): Promise<void>

• Stop indicates that the current user has stopped typing. This will emit a typingStopped event to inform listening clients, and immediately clear the typing timeout timer.

  Returns Promise<void>

  A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.

subscribe

• subscribe(listener): TypingSubscriptionResponse

• Subscribe a given listener to all typing events from users in the chat room.

  Parameters

  • listener: TypingListener

    A listener to be called when the typing state of a user in the room changes.

  Returns TypingSubscriptionResponse

  A response object that allows you to control the subscription to typing events.

unsubscribeAll

• unsubscribeAll(): void

• Unsubscribe all listeners from receiving typing events.

  Returns void