Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/zerver/views/typing.py

18 lines
682 B
Python
Raw Normal View History

Add an API endpoint to send typing notification events. POST to /typing creates a typing event Required parameters are 'op' ('start' or 'stop') and 'to' (recipient emails). If there are multiple recipients, the 'to' parameter should be a JSON string of the list of recipient emails. The event created looks like: { 'type': 'typing', 'op': 'start', 'sender': 'hamlet@zulip.com', 'recipients': [{ 'id': 1, 'email': 'othello@zulip.com' }] }
2016-10-12 20:57:59 +02:00
from django.http import HttpRequest, HttpResponse
typing: Accept only user_ids in typing endpoint. The only clients that should use the typing indicators endpoint are our internal clients, and they should send a JSON-formatted list of user_ids. We now enforce this, which removes some complexity surrounding legacy ways of sending users, such as emails and comma-delimited strings of user_ids. There may be a very tiny number of mobile clients that still use the old emails API. This won't have any user-facing effect on the mobile users themselves, but if you type a message to your friend on an old mobile app, the friend will no longer see typing indicators. Also, the mobile team may see some errors in their Sentry logs from the server rejecting posts from the old mobile clients. The error messages we report here are a bit more generic, since we now just use REQ to do validation with this code: validator=check_list(check_int) This also allows us to remove a test hack related to the API documentation. (We changed the docs to reflect the modern API in an earlier commit, but the tests couldn't be fixed while we still had the more complex semantics for the "to" parameter.)
2020-02-28 18:23:57 +01:00
from typing import List
Add an API endpoint to send typing notification events. POST to /typing creates a typing event Required parameters are 'op' ('start' or 'stop') and 'to' (recipient emails). If there are multiple recipients, the 'to' parameter should be a JSON string of the list of recipient emails. The event created looks like: { 'type': 'typing', 'op': 'start', 'sender': 'hamlet@zulip.com', 'recipients': [{ 'id': 1, 'email': 'othello@zulip.com' }] }
2016-10-12 20:57:59 +02:00
views: Remove unused imports. Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2019-02-02 23:53:22 +01:00
from zerver.decorator import has_request_variables, REQ
typing: Accept only user_ids in typing endpoint. The only clients that should use the typing indicators endpoint are our internal clients, and they should send a JSON-formatted list of user_ids. We now enforce this, which removes some complexity surrounding legacy ways of sending users, such as emails and comma-delimited strings of user_ids. There may be a very tiny number of mobile clients that still use the old emails API. This won't have any user-facing effect on the mobile users themselves, but if you type a message to your friend on an old mobile app, the friend will no longer see typing indicators. Also, the mobile team may see some errors in their Sentry logs from the server rejecting posts from the old mobile clients. The error messages we report here are a bit more generic, since we now just use REQ to do validation with this code: validator=check_list(check_int) This also allows us to remove a test hack related to the API documentation. (We changed the docs to reflect the modern API in an earlier commit, but the tests couldn't be fixed while we still had the more complex semantics for the "to" parameter.)
2020-02-28 18:23:57 +01:00
from zerver.lib.actions import check_send_typing_notification
Add an API endpoint to send typing notification events. POST to /typing creates a typing event Required parameters are 'op' ('start' or 'stop') and 'to' (recipient emails). If there are multiple recipients, the 'to' parameter should be a JSON string of the list of recipient emails. The event created looks like: { 'type': 'typing', 'op': 'start', 'sender': 'hamlet@zulip.com', 'recipients': [{ 'id': 1, 'email': 'othello@zulip.com' }] }
2016-10-12 20:57:59 +02:00
from zerver.lib.response import json_success
typing: Accept only user_ids in typing endpoint. The only clients that should use the typing indicators endpoint are our internal clients, and they should send a JSON-formatted list of user_ids. We now enforce this, which removes some complexity surrounding legacy ways of sending users, such as emails and comma-delimited strings of user_ids. There may be a very tiny number of mobile clients that still use the old emails API. This won't have any user-facing effect on the mobile users themselves, but if you type a message to your friend on an old mobile app, the friend will no longer see typing indicators. Also, the mobile team may see some errors in their Sentry logs from the server rejecting posts from the old mobile clients. The error messages we report here are a bit more generic, since we now just use REQ to do validation with this code: validator=check_list(check_int) This also allows us to remove a test hack related to the API documentation. (We changed the docs to reflect the modern API in an earlier commit, but the tests couldn't be fixed while we still had the more complex semantics for the "to" parameter.)
2020-02-28 18:23:57 +01:00
from zerver.lib.validator import check_int, check_list
Add an API endpoint to send typing notification events. POST to /typing creates a typing event Required parameters are 'op' ('start' or 'stop') and 'to' (recipient emails). If there are multiple recipients, the 'to' parameter should be a JSON string of the list of recipient emails. The event created looks like: { 'type': 'typing', 'op': 'start', 'sender': 'hamlet@zulip.com', 'recipients': [{ 'id': 1, 'email': 'othello@zulip.com' }] }
2016-10-12 20:57:59 +02:00
from zerver.models import UserProfile
@has_request_variables
mypy: Use Python 3 type syntax in zerver/views/typing.py.
2017-12-18 15:07:43 +01:00
def send_notification_backend(
typing: Accept only user_ids in typing endpoint. The only clients that should use the typing indicators endpoint are our internal clients, and they should send a JSON-formatted list of user_ids. We now enforce this, which removes some complexity surrounding legacy ways of sending users, such as emails and comma-delimited strings of user_ids. There may be a very tiny number of mobile clients that still use the old emails API. This won't have any user-facing effect on the mobile users themselves, but if you type a message to your friend on an old mobile app, the friend will no longer see typing indicators. Also, the mobile team may see some errors in their Sentry logs from the server rejecting posts from the old mobile clients. The error messages we report here are a bit more generic, since we now just use REQ to do validation with this code: validator=check_list(check_int) This also allows us to remove a test hack related to the API documentation. (We changed the docs to reflect the modern API in an earlier commit, but the tests couldn't be fixed while we still had the more complex semantics for the "to" parameter.)
2020-02-28 18:23:57 +01:00
request: HttpRequest,
user_profile: UserProfile,
operator: str=REQ('op'),
notification_to: List[int]=REQ('to', validator=check_list(check_int))) -> HttpResponse:
Add an API endpoint to send typing notification events. POST to /typing creates a typing event Required parameters are 'op' ('start' or 'stop') and 'to' (recipient emails). If there are multiple recipients, the 'to' parameter should be a JSON string of the list of recipient emails. The event created looks like: { 'type': 'typing', 'op': 'start', 'sender': 'hamlet@zulip.com', 'recipients': [{ 'id': 1, 'email': 'othello@zulip.com' }] }
2016-10-12 20:57:59 +02:00
check_send_typing_notification(user_profile, notification_to, operator)
return json_success()