chat/com.ably.chat/Typing

Typing

interface Typing

This interface is used to interact with typing in a chat room including subscribing to typing events and fetching the current set of typing clients.

Get an instance via Room.typing.

Not suitable for inheritance

This interface is not designed for client implementation or extension. The interface definition may evolve over time with additional properties or methods to support new features, which could break client implementations.

Properties

Link copied to clipboard
abstract val current: Set<String>

Current typing members.

Functions

Link copied to clipboard
Link copied to clipboard
abstract suspend fun keystroke()

This will send a typing.started event to the server. Events are throttled according to the heartbeatThrottleMs room option. If an event has been sent within the interval, this operation is no-op.

Link copied to clipboard
abstract suspend fun stop()

This will send a typing.stopped event to the server. If the user was not currently typing, this operation is no-op.

Link copied to clipboard
abstract fun subscribe(listener: TypingListener): Subscription

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