diff --git a/stbf-templates/README.MD b/stbf-templates/README.MD index df00633..4348d6e 100644 --- a/stbf-templates/README.MD +++ b/stbf-templates/README.MD @@ -12,7 +12,7 @@ ### Actions -Action - Это действие пользователя бота, которое бот должен обработать +Action - Это действие пользователя бота, которое бот должен обработать, а также соответсвующая кнопка или inline-кнопка. ```xml Help @@ -22,14 +22,23 @@ Action - Это действие пользователя бота, которо `command` - команда Telegram, должна начинаться со знака "/" +`requestContact="true|false"` - кнопка запроса контактных данных + +`requestLocation="true|false"` - кнопка запроса метоположения + содержимое тега - вводимый текст, используется как экранная кнопка +`url` - ссылка для inline-кнопки +`callbackData` - callback данные для inline-кнопки + +`callbackDataRegexp` - regexp для обработки callback программным способом + +`callbackDataStartWith` - префикс, для обработки callback программным способом ### Screens -Screen - то, что бот ответит пользователю, -обычно текст и набор кнопок с действиями. +Screen - то, что бот ответит пользователю, обычно текст и набор кнопок с действиями. В качестве текста может задаваться шаблон, контекст передается при программной обработке при установленном `TemplateRenderer` ```xml @@ -46,9 +55,34 @@ Screen - то, что бот ответит пользователю, `keyboard` - описание клавиатуры +### Keyboard + +Описание клавиатуры + +#### Row + +Одна строка кнопок клавиатуры + +#### Button + +`if` - видомость кнопки, значение `true`, `false` или имя метода из контекста экрана (для программной обработки) + +`actionRef` - `id` или `name` action, описанный в соответсвующей секции + +Если кнопка не ссылается на action, то можно задать следующие свойства: + +`url` - ссылка для inline-кнопки + +`callbackData` - callback данные для inline-кнопки + +`callbackDataRegexp` - regexp для обработки callback программным способом + +`callbackDataStartWith` - префикс, для обработки callback программным способом + + ### Commands -Простая команда, при соверщении action будет выведен screen +Простая команда, при совершении `action` будет выведен `screen`. Используется для простых действий, не требующей программной логики. ```xml