Files
Govor/docs/endpoints/message-read.md
T
Artemy 632ac04b56 Add forwarding, friend controls, and benefits
Add message forwarding and reply lookup, friend removal and blocking endpoints, and database-backed Govor+ privileges with customizable profile tags. Include migrations, integration tests, and updated API and operations documentation.
2026-10-31 18:29:40 +07:00

6.6 KiB
Raw Blame History

Прочтение сообщений

Контракт текущей серверной ревизии из обзора. Требуются access token, роль User/Admin и участие именно в запрошенном чате. chatId — ID PrivateChat либо ChatGroup, а не ID собеседника. recipientType: 0 — личный чат, 1 — группа.

POST /api/chats/{chatId}/read

Три взаимоисключающих режима:

Действие клиента Тело запроса Семантика
Скролл, входящие сообщения видны на экране {"recipientType":0,"messageIds":["<id1>","<id2>"]} Прочитать только эти сообщения
Пользователь просмотрел историю до определённого сообщения {"recipientType":0,"upToMessageId":"<id>"} Прочитать входящие до границы включительно
Команда «Пометить как прочитано» {"recipientType":0} Зафиксировать последнюю границу и прочитать входящие до неё

Граница упорядочена по (sentAt, messageId): ID разрешает совпадающие timestamps. Сообщения после этой границы остаются непрочитанными. Свои сообщения не получают MessageView. В режиме messageIds передавайте только входящие: от 1 до 100 ID, без Guid.Empty. Список и upToMessageId нельзя объединять. Весь список проверяется до записи; ID из другого чата возвращает 404 без частичного прочтения. Отсутствие участия возвращает 403; неверная комбинация и собственные сообщения в списке — 400.

200 OK, JSON:

{
  "chatId":"<chat-id>",
  "recipientType":0,
  "readerId":"<current-user-id>",
  "readAt":"2026-10-03T07:00:00Z",
  "upToMessageId":null,
  "upToSentAt":null,
  "messageIds":["<incoming-id>"],
  "readCount":1,
  "unreadCount":3
}

Для режима границы messageIds=null, upToMessageId/upToSentAt заполнены. У пустого чата граница null. readCount — число новых записей данного вызова; повторный запрос возвращает 0 и не меняет время существующих MessageView. readAt — время операции; исходное время каждого прочтения доступно в истории, через messageViews. unreadCount относится к readerId в этом чате и включает все оставшиеся входящие сообщения на момент подсчёта.

Уникальный индекс (MessageId, UserId) и ON CONFLICT DO NOTHING защищают параллельные отметки с нескольких устройств. Получение истории само по себе ничего не помечает.

GET /api/chats/{chatId}/unread-count?recipientType=0

200 OK: {"unreadCount":3}. Считает входящие без MessageView текущего пользователя. Те же требования авторизации и участия. Клиент использует endpoint после подключения/переподключения и для восстановления локального счётчика.

SignalR

ReadChat(Guid chatId, ReadChatRequest request) на /hubs/chats выполняет ту же операцию, возвращает HubResult<ChatReadResponse>. После успешного HTTP или SignalR вызова сервер отправляет событие ChatRead с ChatReadResponse всем активным сессиям текущих участников, включая устройства читателя. Ошибки HubResult используют 400/401/403/404/500; это поле status, а не HTTP-статус WebSocket.

Старый Read(ReadMessageRequest) сохраняется. Он читает одно входящее сообщение и возвращает прежнюю квитанцию при повторении. Для совместимости отправляются MessageReaded и MessageRead; подпишитесь на одно из этих имён. Для массового прочтения используйте ChatRead.

Использование в MAUI

Собирайте ID реально видимых входящих сообщений, отправляйте пачками до 100, объединяя частые события скролла. Отправляйте запрос только при активном окне чата. Обновляйте локальное состояние после успешного ответа; при потере сети повторяйте тот же список. Не отмечайте всю загруженную страницу как просмотренную, если она была вне экрана.

var request = new ReadChatRequest
{
    RecipientType = RecipientType.User,
    MessageIds = visibleIncomingIds.Distinct().Take(100).ToList()
};
if (request.MessageIds.Count > 0)
{
    var result = await connection.InvokeAsync<HubResult<ChatReadResponse>>(
        "ReadChat", chatId, request);
    // При успешном status примените result.Result и его UnreadCount.
}

Кнопка «Пометить как прочитано» передаёт new ReadChatRequest { RecipientType = type }. Событие ChatRead обновляет галочки у автора и состояние на остальных устройствах читателя. Оно не требует от других участников подтверждать прочтение. При отключённом SignalR восстановите messageViews через историю и счётчик через unread-count. На устройстве читателя отмените уведомление с tag chat_<chatId>, когда чат полностью прочитан.

ReceiveMessage и MessageSent могут описывать одно исходящее сообщение. Дедуплицируйте их по messageId; счётчик увеличивается только для новых входящих.