keystroke

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.

Calls to keystroke() and stop() are serialized and will always be performed in the correct order.

  • For example, if multiple keystroke() calls are made in quick succession before the first keystroke() call has sent a typing.started event to the server, followed by one stop() call, the stop() call will execute as soon as the first keystroke() call completes. All intermediate keystroke() calls will be treated as no-ops.

  • The most recent operation (keystroke() or stop()) will always determine the final state, ensuring operations resolve to a consistent and correct state.

Throws

AblyException

if there is a problem acquiring the mutex that controls serialization.