Typing Indicators
Confused about "Typing Indicators"?
Let us know how we can improve our documentation:
All official SDKs support typing events out of the box and are handled on all channels with the typing_events featured enabled. Typing indicators allow you to show to users who is currently typing in the channel. This feature can be switched on/off on a channel-type basis using the CLI or directly from the Dashboard. If you are using one of the official SDK libraries, you will only need to ensure that typing indicators are enabled to get this working.
If you are building your UI on top of one of our Chat Clients instead, you will need to take care of four things:
Send an event
typing.start
when the user starts typingSend an event
typing.stop
after the user stopped typingHandle the two events and use them to toggle the typing indicator UI
Use
parent_id
field of the event to indicate that typing is happening in a thread
Sending start and stop typing events
Copied!Confused about "Sending start and stop typing events"?
Let us know how we can improve our documentation:
When sending events on user input, you should make sure to follow some best-practices to avoid bugs.
Only send
typing.start
when the user starts typingSend
typing.stop
after a few seconds since the last keystroke
Receiving typing indicator events
Copied!Confused about "Receiving typing indicator events"?
Let us know how we can improve our documentation:
typing.stop
event all Chat clients periodically prune the list of typing users.Control typing events delivery by modifying user privacy settings
Copied!Confused about "Control typing events delivery by modifying user privacy settings"?
Let us know how we can improve our documentation:
Please take into account that typing.start
and typing.stop
events delivery can be controlled by user privacy settings:
If privacy_settings.typing_indicators.enabled
is set to false
, then typing.start
and typing.stop
events will be ignored for this user by Stream's server and these events will not be sent to other users. In other words other users will not know that the current user was typing.