This commit is contained in:
Андреев Григорий 2024-09-02 10:31:48 +03:00
parent 2a1d4a57c3
commit a112e9df10

13
api.typ
View File

@ -195,7 +195,7 @@ $n = "Sent"."amount"$.
- URI: #uritxt("/api/deleteMessage") \ - URI: #uritxt("/api/deleteMessage") \
- Отправить: \ - Отправить: \
`Sent.chatUpdReq` \ `Sent.chatUpdReq` \
`Sent.id = Integer` - Id выбранного на расстрел сообщения \ `Sent.id = Integer` - Id выбранного на расстрел сообщения
- Получить: \ - Получить: \
`Recv.chatUpdResp` `Recv.chatUpdResp`
] ]
@ -206,7 +206,8 @@ $n = "Sent"."amount"$.
- URI: #uritxt("/api/addMemberToChat") \ - URI: #uritxt("/api/addMemberToChat") \
- Отправить: \ - Отправить: \
`Sent.chatUpdReq` \ `Sent.chatUpdReq` \
`Sent.nickname = String` - никнейм того участника, которого мы хотим добавить. `Sent.nickname = String` - никнейм того участника, которого мы хотим добавить. \
`Sent.makeReadOnly = Boolean` - true если придобавлении человеку выдаётся роль read-only
- Получить: \ - Получить: \
`Recv.chatUpdResp` `Recv.chatUpdResp`
] ]
@ -218,7 +219,7 @@ $n = "Sent"."amount"$.
#bigrect[ #bigrect[
- URI: #uritxt("/api/removeMemberFromChat") \ - URI: #uritxt("/api/removeMemberFromChat") \
- Отправить: - Отправить: \
`Sent.chatUpdReq` \ `Sent.chatUpdReq` \
`Sent.userId` - id пользователя, которого мы хотим удалить из чата `Sent.userId` - id пользователя, которого мы хотим удалить из чата
- Получить: \ - Получить: \
@ -251,7 +252,7 @@ $n = "Sent"."amount"$.
#bigrect[ #bigrect[
- URI: #uritxt("/api/leaveChat") - URI: #uritxt("/api/leaveChat")
- Отправить: \ - Отправить: \
`Sent.chatListUpdReq` `Sent.chatListUpdReq` \
`Sent.chatId` - id чата, который мы покидаем. `Sent.chatId` - id чата, который мы покидаем.
- Получить: \ - Получить: \
`chatListUpdResp` `chatListUpdResp`
@ -288,7 +289,7 @@ New York Transit Line.
`userinfo.id`, `userinfo.nickname`, `userinfo.name` - это всё информация о вошедшем пользователе. `userinfo.id`, `userinfo.nickname`, `userinfo.name` - это всё информация о вошедшем пользователе.
(О себе). Это всё было и в list-rooms, но теперь добавляются такие переменные: (О себе). Это всё было и в list-rooms, но теперь добавляются такие переменные:
`chatinfo.id`, `chatinfo.name`, `chatinfo.nickname` - это всё информация о том чате, что мы открыли. `openedchat.id`, `openedchat.name`, `openedchat.nickname` - это всё информация о том чате, что мы открыли.
`initial_chatUpdResp` - этот объект имеет такую же структуру, как и `Recv.chatUpdResp` `initial_chatUpdResp` - этот объект имеет такую же структуру, как и `Recv.chatUpdResp`
из всех тех запросов к чату, отсюда и название. из всех тех запросов к чату, отсюда и название.
@ -329,7 +330,7 @@ New York Transit Line.
Можно при открытии чата сразу перейти к сообщению с заранее известным id: Можно при открытии чата сразу перейти к сообщению с заранее известным id:
#uritxt("/chat/<nickname>/m/<id of message in chat>") #uritxt("/chat/<nickname>/m/<id of message in chat>")
Просмотр списка пользователей на странице #uritxt("/chat-members/<nickname>") Просмотр списка пользователей на странице #uritxt("/chat-members/<nickname>").
Здесь же администратор может добавлять и удалять участников чата (через api запросы) Здесь же администратор может добавлять и удалять участников чата (через api запросы)
#Heading([Замечания], 1) #Heading([Замечания], 1)