Skip to content

Latest commit

 

History

History
164 lines (133 loc) · 4.27 KB

chats.md

File metadata and controls

164 lines (133 loc) · 4.27 KB

Документация по вебсокетам чатов

Общая инфа

URL для всего вебсокет-релейтед - /ws/

В данный момент есть только 1 Consumer (т.е. View, но для вебсокетов). Это ChatConsumer, живет на /ws/chat/.

/ws/chat/

Подключение

Чтобы законнектиться, укажите в хедерах авторизацию по Bearer токену (как и для всех других запросов в REST API).

Events

Есть два типа ивентов, которые можно кидать - general events и chat-related events. Первые состоят только из user_online и user_offline, вторые содержат все остальное: новое сообщение, печатание, чтение и удаление (пока без редактирования)

Структура любого Event, который должен кидаться на вебсокет выглядит так:

class Event:
    type: EventType
    content: dict

И соответственно EventType вот такой:

# эти строки указывать в {"type": event_type}

class EventType(str, Enum):
    # CHAT RELATED EVENTS
    NEW_MESSAGE = "new_message"
    DELETE_MESSAGE = "delete_message"
    READ_MESSAGE = "message_read"
    TYPING = "user_typing"
    EDIT_MESSAGE = "edit_message"

    # GENERAL EVENTS
    SET_ONLINE = "set_online"
    SET_OFFLINE = "set_offline"

Пример того, как выглядит Event на новое сообщение

{
  "type": "new_message",
  "content": {
    "chat_type": "direct",
    "chat_id": "12_23",
    "message": "hello world",
    "reply_to": 54,
    "is_edited": false
  }
}

Методы e.g. Ивенты

SET_ONLINE/SET_OFFLINE

Без параметров.

NEW_MESSAGE

  • chat_type: str
    "direct" или "project", зависит от типа чата
  • chat_id: int/str
    Если тип "project", то тип будет int и это айди проекта, которому принадлежит чат. Если тип "direct", то это str. Выглядит как {user1_id}_{user2_id}, где первое число всегда меньше второго.
  • message: str текст сообщения
  • reply_to: Optional[int] айди сообщения, на которое кидается ответ. Если его нет, то обязательно кидать None

EDIT_MESSAGE

  • chat_type: str
  • chat_id см выше
  • message_id: int айди сообщение, которое прочитали
  • message: str текст сообщения

TYPING

  • chat_type см выше
  • chat_id см выше

READ_MESSAGE

  • chat_type см выше
  • chat_id см выше
  • message_id: int айди сообщение, которое прочитали

General events

  • EventType.SET_ONLINE
  • EventType.SET_OFFLINE

Структура этих event'ов одинаковая.

{
	"type": "set_offline",
	"content": {
		
	}
}

Chat-related events

EventType.NEW_MESSAGE
{
	"type": "new_message",
	"content": {
		"chat_type": {{"direct" | "project"}},
		"chat_id": {{"id1"_"id2"}}, // например: 1_2
		"message": {{string}},
		"reply_to": number | null
	}
}

New message event

EventType.TYPING
{
	"type": "typing",
	"content": {
		"chat_type": {{"direct" | "project"}},
		"chat_id": {{"id1"_"id2"}}, // например: 1_2
	}
}
EventType.READ_MESSAGE
{
	"type": "typing",
	"content": {
		"chat_type": {{"direct" | "project"}},
		"chat_id": {{"id1"_"id2"}}, // например: 1_2
		"message_id": {{number}}
	}
}
EventType.DELETE_MESSAGE
{
	"type": "typing",
	"content": {
		"chat_type": {{"direct" | "project"}},
		"chat_id": {{"id1"_"id2"}}, // например: 1_2
		"message_id": {{number}}
	}
}
EventType.EDIT_MESSAGE
{
	"type": "edit_message",
	"content": {
		"chat_type": {{"direct" | "project"}},
		"chat_id": {{"id1"_"id2"}}, // например: 1_2
		"message_id": {{number}},
		"message": {{string}}
	}
}