Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/templates/zerver/api/get-user-presence.md

33 lines
679 B
Markdown
Raw Normal View History

api docs: Document GET /users/<email>/presence. Tweaked by tabbott to describe more clearly what this is for.
2018-08-07 17:52:03 +02:00
# Get user presence
api: Support user_id in get_user_presence_endpoint. This is part of our general process of replacing emails, which are not static with time, with user_ids when referring to users in the API. We still keep the `email` reference option, since it can be useful for linking third-party applications to Zulip on an intranet that might have a user's corporate email handy and not want to do the extra round trip to lookup the user. The name of the parameter, user_id_or_email, was chosen to to make it clear that the default/preferred option is user_id. Fixes #14304.
2021-01-04 19:36:00 +01:00
{generate_api_description(/users/{user_id_or_email}/presence:get)}
api docs: Document GET /users/<email>/presence. Tweaked by tabbott to describe more clearly what this is for.
2018-08-07 17:52:03 +02:00
## Usage examples
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{start_tabs}
{tab|python}
api docs: Document GET /users/<email>/presence. Tweaked by tabbott to describe more clearly what this is for.
2018-08-07 17:52:03 +02:00
api: Support user_id in get_user_presence_endpoint. This is part of our general process of replacing emails, which are not static with time, with user_ids when referring to users in the API. We still keep the `email` reference option, since it can be useful for linking third-party applications to Zulip on an intranet that might have a user's corporate email handy and not want to do the extra round trip to lookup the user. The name of the parameter, user_id_or_email, was chosen to to make it clear that the default/preferred option is user_id. Fixes #14304.
2021-01-04 19:36:00 +01:00
{generate_code_example(python)|/users/{user_id_or_email}/presence:get|example}
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{tab|curl}
api docs: Document GET /users/<email>/presence. Tweaked by tabbott to describe more clearly what this is for.
2018-08-07 17:52:03 +02:00
api: Support user_id in get_user_presence_endpoint. This is part of our general process of replacing emails, which are not static with time, with user_ids when referring to users in the API. We still keep the `email` reference option, since it can be useful for linking third-party applications to Zulip on an intranet that might have a user's corporate email handy and not want to do the extra round trip to lookup the user. The name of the parameter, user_id_or_email, was chosen to to make it clear that the default/preferred option is user_id. Fixes #14304.
2021-01-04 19:36:00 +01:00
{generate_code_example(curl)|/users/{user_id_or_email}/presence:get|example}
api docs: Document GET /users/<email>/presence. Tweaked by tabbott to describe more clearly what this is for.
2018-08-07 17:52:03 +02:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{end_tabs}
api docs: Document GET /users/<email>/presence. Tweaked by tabbott to describe more clearly what this is for.
2018-08-07 17:52:03 +02:00
openapi_docs: Replace `argument` with `parameter`. The term `parameter` is a better word than `argument` for data passed to an API endpoint; this is why OpenAPI uses in their terminology. Replace `argument` with `parameter` in the API docs to improve their readability. Fixes #15435.
2020-06-18 15:35:25 +02:00
## Parameters
api docs: Document GET /users/<email>/presence. Tweaked by tabbott to describe more clearly what this is for.
2018-08-07 17:52:03 +02:00
api: Support user_id in get_user_presence_endpoint. This is part of our general process of replacing emails, which are not static with time, with user_ids when referring to users in the API. We still keep the `email` reference option, since it can be useful for linking third-party applications to Zulip on an intranet that might have a user's corporate email handy and not want to do the extra round trip to lookup the user. The name of the parameter, user_id_or_email, was chosen to to make it clear that the default/preferred option is user_id. Fixes #14304.
2021-01-04 19:36:00 +01:00
{generate_api_arguments_table|zulip.yaml|/users/{user_id_or_email}/presence:get}
api docs: Document GET /users/<email>/presence. Tweaked by tabbott to describe more clearly what this is for.
2018-08-07 17:52:03 +02:00
## Response
#### Return values
api: Support user_id in get_user_presence_endpoint. This is part of our general process of replacing emails, which are not static with time, with user_ids when referring to users in the API. We still keep the `email` reference option, since it can be useful for linking third-party applications to Zulip on an intranet that might have a user's corporate email handy and not want to do the extra round trip to lookup the user. The name of the parameter, user_id_or_email, was chosen to to make it clear that the default/preferred option is user_id. Fixes #14304.
2021-01-04 19:36:00 +01:00
{generate_return_values_table|zulip.yaml|/users/{user_id_or_email}/presence:get}
api docs: Document GET /users/<email>/presence. Tweaked by tabbott to describe more clearly what this is for.
2018-08-07 17:52:03 +02:00
#### Example response
A typical successful JSON response may look like:
api: Support user_id in get_user_presence_endpoint. This is part of our general process of replacing emails, which are not static with time, with user_ids when referring to users in the API. We still keep the `email` reference option, since it can be useful for linking third-party applications to Zulip on an intranet that might have a user's corporate email handy and not want to do the extra round trip to lookup the user. The name of the parameter, user_id_or_email, was chosen to to make it clear that the default/preferred option is user_id. Fixes #14304.
2021-01-04 19:36:00 +01:00
{generate_code_example|/users/{user_id_or_email}/presence:get|fixture(200)}