docs: Update typing indicators documentation.

Update typing_indicators.md to reflect current implementation.

Fixes #30665.
This commit is contained in:
Aarya Patil 2024-08-06 07:25:37 +00:00 committed by Tim Abbott
parent a16a8d5f00
commit fb888ba9ab
1 changed files with 6 additions and 2 deletions

View File

@ -11,8 +11,8 @@ the Zulip web app, and our main audience is developers who want to
understand the system and possibly improve it. Any client should understand the system and possibly improve it. Any client should
be able follow the protocol documented here. be able follow the protocol documented here.
Right now typing indicators are only implemented for direct Typing indicators are implemented for both direct message conversations
message conversations in the web app. and channel conversations in the web app.
There are two major roles for users in this system: There are two major roles for users in this system:
@ -102,6 +102,10 @@ potential recipients of the message. The event type for that
payload is `typing`. See the function `do_send_typing_notification` payload is `typing`. See the function `do_send_typing_notification`
in `zerver/actions/typing.py` for more details. in `zerver/actions/typing.py` for more details.
For channel typing notifications, the server also handles the logic
for determining which users should receive the typing events based
on channel subscribers.
## Receiving user ## Receiving user
When a user plays the role of a "receiving user," the client handles When a user plays the role of a "receiving user," the client handles