chat-android/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.

Types

Link copied to clipboard
fun interface Listener

An interface for listening to changes for Typing

Properties

Link copied to clipboard
abstract val channel: Channel

Get the Ably realtime channel underpinning typing events.

Functions

Link copied to clipboard
Link copied to clipboard
abstract fun get(): Set<String>

Current typing members.

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: Typing.Listener): Subscription

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