update README
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
2021-09-11 20:40:20 +03:00
parent c5806b6b45
commit 5bb9e3abab

View File

@@ -12,7 +12,7 @@
### Actions ### Actions
Action - Это действие пользователя бота, которое бот должен обработать Action - Это действие пользователя бота, которое бот должен обработать, а также соответсвующая кнопка или inline-кнопка.
```xml ```xml
<action id="10002" name="help-action" command="/help">Help</action> <action id="10002" name="help-action" command="/help">Help</action>
@@ -22,14 +22,23 @@ Action - Это действие пользователя бота, которо
`command` - команда Telegram, должна начинаться со знака "/" `command` - команда Telegram, должна начинаться со знака "/"
`requestContact="true|false"` - кнопка запроса контактных данных
`requestLocation="true|false"` - кнопка запроса метоположения
содержимое тега - вводимый текст, используется как экранная кнопка содержимое тега - вводимый текст, используется как экранная кнопка
`url` - ссылка для inline-кнопки
`callbackData` - callback данные для inline-кнопки
`callbackDataRegexp` - regexp для обработки callback программным способом
`callbackDataStartWith` - префикс, для обработки callback программным способом
### Screens ### Screens
Screen - то, что бот ответит пользователю, Screen - то, что бот ответит пользователю, обычно текст и набор кнопок с действиями. В качестве текста может задаваться шаблон, контекст передается при программной обработке при установленном `TemplateRenderer`
обычно текст и набор кнопок с действиями.
```xml ```xml
<screen id="20001" name="on-start-screen"> <screen id="20001" name="on-start-screen">
@@ -46,9 +55,34 @@ Screen - то, что бот ответит пользователю,
`keyboard` - описание клавиатуры `keyboard` - описание клавиатуры
### Keyboard
Описание клавиатуры
#### Row
Одна строка кнопок клавиатуры
#### Button
`if` - видомость кнопки, значение `true`, `false` или имя метода из контекста экрана (для программной обработки)
`actionRef` - `id` или `name` action, описанный в соответсвующей секции
Если кнопка не ссылается на action, то можно задать следующие свойства:
`url` - ссылка для inline-кнопки
`callbackData` - callback данные для inline-кнопки
`callbackDataRegexp` - regexp для обработки callback программным способом
`callbackDataStartWith` - префикс, для обработки callback программным способом
### Commands ### Commands
Простая команда, при соверщении action будет выведен screen Простая команда, при совершении `action` будет выведен `screen`. Используется для простых действий, не требующей программной логики.
```xml ```xml
<command actionRef="start-action" screenRef="on-start-screen" id="30001" name="startCommand"/> <command actionRef="start-action" screenRef="on-start-screen" id="30001" name="startCommand"/>