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

19 lines
754 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
request: Remove ExtractRecipients type safety hole on REQ. It was allowing us to get away with wrong types on a few functions: `check_send_typing_notification` and `send_notification_backend` can be (and are) called with a list of `int` as `notification_to`, not just a list of `str`. The problem it was working around already had a better solution using the dummy `type` argument. Use that. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-08-07 10:42:16 +02:00
from typing import List, Union
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
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.actions import check_send_typing_notification, \
recipients: Rename extract_recipients to extract_private_recipients. Recent changes mean this function is now only used for private messages.
2020-02-11 21:28:14 +01:00
extract_private_recipients
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
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(
request: HttpRequest, user_profile: UserProfile,
views: Change use of typing.Text to str. This is the first part of a general migration of our typing codebase to use the simpler `str` for strings.
2018-04-24 03:47:28 +02:00
operator: str=REQ('op'),
request: Remove ExtractRecipients type safety hole on REQ. It was allowing us to get away with wrong types on a few functions: `check_send_typing_notification` and `send_notification_backend` can be (and are) called with a list of `int` as `notification_to`, not just a list of `str`. The problem it was working around already had a better solution using the dummy `type` argument. Use that. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-08-07 10:42:16 +02:00
notification_to: Union[List[str], List[int]]=REQ(
recipients: Rename extract_recipients to extract_private_recipients. Recent changes mean this function is now only used for private messages.
2020-02-11 21:28:14 +01:00
'to', type=Union[List[str], List[int]],
converter=extract_private_recipients, default=[])) -> 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()