zulip/templates/zerver/api/set-typing-status.md
Dinesh 27e4f5da92 typing: Support sending stream/topic typing status.
This extends the /json/typing endpoint to also accept
stream_id and topic. With this change, the requests
sent to /json/typing should have these:
* `to`: a list set to
    - recipients for a PM
    - stream_id for a stream message
* `topic`, in case of stream message
along with `op`(start or stop).

On receiving a request with stream_id and topic, we send
typing events to clients with stream_typing_notifications set
to True for all users subscribed to that stream.
2021-04-27 20:52:21 -07:00

35 lines
625 B
Markdown

# Set "typing" status
{generate_api_description(/typing:post)}
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/typing:post|example}
{tab|js}
More examples and documentation can be found [here](https://github.com/zulip/zulip-js).
{generate_code_example(javascript)|/typing:post|example}
{tab|curl}
{generate_code_example(curl, exclude=["topic"])|/typing:post|example}
{end_tabs}
## Parameters
{generate_api_arguments_table|zulip.yaml|/typing:post}
## Response
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/typing:post|fixture(200)}