Updated + typos fixed

This commit is contained in:
Андреев Григорий 2024-08-25 17:46:37 +03:00
parent 21e895cfb8
commit e2a8e7b286
2 changed files with 12 additions and 19 deletions

28
api.typ
View File

@ -102,7 +102,7 @@
"content": {
"name": "<users name>",
"nickname": "<users nickname>"
"role": "regular" // Роль это либо regular, либо admin
"role": "regular" // Роль это либо admin, либо regular, либо read-only
}
}
```
@ -125,7 +125,8 @@
"content": {
"name": "<имя чата>",
"nickname": "<nickname чата>",
"lastMsgId": 1212 // Id последнего сообщения. -1 Если чат пуст
"lastMsgId": 1212, // Id последнего сообщения. -1 Если чат пуст
"roleHere": "regular" // Роль текущего пользователя в этом чате
}
}
```
@ -134,7 +135,7 @@
```json
{
"type": "addedChat",
"type": "removedChat",
"id": 228, // Chat ID того чата, из которого клиента удалили / из которого клиент вышел
}
```
@ -173,7 +174,8 @@
"member": 777,
"content": {
"name": "'Definitely not theatre looter'",
"nickname": "father-mushroom-2"
"nickname": "father-mushroom-2",
"role": "regular"
}
},
{
@ -263,7 +265,7 @@
`Recv["members"]["content"]["role"] = "<Роль этого участника чата>"`
]
Роль учатника это либо `"regular"`, либо `"admin"`. Думаю, семантика их ясна из
Роль учатника это либо `"admin"`, либо `"regular"`, либо `"read-only"`. Думаю, семантика их ясна из
названий.
#Heading([Получение информации о пользователе], 3)
@ -277,18 +279,6 @@
`Recv["content"]["nickname"] = "<user nickname>"` \
]
#Heading([Получение информации о себе], 3)
#bigrect[
- URI: #uritxt("/internalapi/mirror") \
- Отправить: Пустой словарь \
- Получить: \
`Recv["id"] = Integer` #funnyArrow Id себя
]
Этот запрос нужен понадобиться если по какой-то причине клиент забыл id пользователя,
которого обслуживал.
#Heading([Получение информации о сообщении], 3)
#bigrect[
@ -412,7 +402,7 @@
#Heading([Удаление чата], 3)
#bigrect[
- URI: #uritxt("/internalapi/createChat")
- URI: #uritxt("/internalapi/leaveChat")
- Отправить: \
`Sent["LocalHistoryId"] = Integer` #funnyArrow Это ID состояния списка чатов пользователя \
`Sent["id"] = Integer` #funnyArrow Chat Id того чата, который должен быть удалён \
@ -439,7 +429,7 @@
Где находится форма - сами решайте.
#Heading([Редактирование профиля], 2)
Свой профиль редактируется на странице #uritxt("/mirror"). Туда же отправляются данные форму
Свой профиль редактируется на странице #uritxt("/mirror"). Туда же отправляются данные формы
(POST запросом). При успехе пользователь пересылается на главную страницу,
иначе, остаётся на прежней.

View File

@ -100,6 +100,9 @@ $<"expr"> = <"expr">[ <"expr"> ]$ (это доступ по значению (
Следуюущие выражения указывают передаваемые аргументы.
Есть ряд "встроенных элементов", определяемых самим nytl:
- `jsinsert`. Тип: `EL(JSON)`. Напрямую вставляет сериализованный JS-объект в код.
Полезно если нужно через тег ```html <script>``` передать переменные с сервера
на страничку.
- `jesc`. Тип: `EL(JSON)`. Вставляет один сериализованный JSON-объект в ваш код как текст (обрабатывая текст функцией settings.escape).
- `jesccomp`. То же самое, что и `jesc`, но этот элемент выводит JSON компактно, а `jesc` красиво.
- `str2text`. Тип: `EL(JSON)`. Передаваемый JSON-аргумент должен быть строкой. `str2text` выводит это текст в код, предварительно обработав