1c/Tasks
1
0
Fork 0
mirror of https://github.com/BlizD/Tasks.git synced 2025-04-13 11:40:39 +02:00
Code Issues Releases Activity

#240 Описания процедур/функций

Browse Source
This commit is contained in:
GenVP 2020-09-10 22:30:24 +03:00
parent 10f8926dff
commit cf87f7bb25
2 changed files with 96 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
src/cf/CommonModules/узТелеграмБот/Ext/Module.bsl
View File

@ -270,7 +270,7 @@
//
// Параметры:
// ТекстСообщения - Строка - Текст сообщения в формате markdown
// Получатели - Массив или СправочникСсылка.Пользователь - массив пользователей для получения сообщения.
// Получатели - Массив, СправочникСсылка.Пользователь - массив пользователей для получения сообщения.
// Сообщение отправляется только пользователям с заполненным ИД телеграмма
// и с установленным флагом "Использовать рассылку через телеграмм"
// Ответ - Структура или Соответствие - доп параметры, которые должны быть переданы в параметры запроса
@ -394,6 +394,27 @@
КонецФункции
// #240 Пиганов Г.В. 2020-09-08
// Выполняет HTTPЗапрос для телеграмм по переданным параметрам и с обходом доступных прокси, если они заданы
//
// Параметры:
// НастройкиБота - Структура - структура настроек бота
// * ТокенБота - Строка - токен бота телеграмм. Получается при создании бота
// * ТекущийПрокси - Строка,Неопределено - если Неопределено, то прокси не используется,
// иначе индекс прокси в массиве НастройкиБота.Прокси
// * Прокси - Массив структур - Необязательный. Массив настроек доступных прокси
// ** Адрес - Строка - Адрес прокси
// ** Порт - Число - Порт прокси
// ** Логин - Строка - Логи прокси
// ** Пароль - Строка - Пароль прокси
// Команда - Строка - команда телеграмм API
// ПараметрыЗапроса - Структура,Соответствие - дополнительные параметры запроса. Передаются в HTTPЗапрос
// Ответ - HTTPОтвет - переменная для получения результата запроса
// ЭтоЗапросPOST - Булево - Признак выполнения POST, а не GET запроса. При GET запросе параметры
// передаются в строке URL, а при POST передаюттся в теле запроса
//
// Возвращаемое значение:
// Булево - признак успешного выполнения запроса (код ответа 200 или 300)
//
Функция ВыполнитьЗапросHTTP(НастройкиБота, Команда, ПараметрыЗапроса, Ответ, ЭтоЗапросPOST = Истина) Экспорт
ЕстьПрокси = НастройкиБота.ТекущийПрокси <> Неопределено;
@ -478,6 +499,21 @@
#КонецОбласти
// #240 Пиганов Г.В. 2020-09-08
// Создает новое HTTPСоединение для бота телеграмм с учетом выбранного прокси
//
// Параметры:
// НастройкиБота - Структура - структура настроек бота
// * ТекущийПрокси - Строка,Неопределено - если Неопределено, то прокси не используется,
// иначе индекс прокси в массиве НастройкиБота.Прокси
// * Прокси - Массив структур - Необязательный. Массив настроек доступных прокси
// ** Адрес - Строка - Адрес прокси
// ** Порт - Число - Порт прокси
// ** Логин - Строка - Логи прокси
// ** Пароль - Строка - Пароль прокси
//
// Возвращаемое значение:
// HTTPСоединение - созданное соединение
//
Функция НовоеСоединениеHTTP(НастройкиБота)
Если НастройкиБота.ТекущийПрокси = Неопределено Тогда
@ -494,6 +530,8 @@
КонецФункции
// #240 Пиганов Г.В. 2020-09-08
// Используется в регламентном задании для получения и обработки сообщений
//
Процедура РегламентноеПолучениеИОбработкаСообщений() Экспорт
НастройкиБота = НастройкиБота();
@ -506,6 +544,13 @@
КонецПроцедуры
// #240 Пиганов Г.В. 2020-09-08
// Возвращает таблицу пользователей, у которых заполнен идентификатор пользователя телеграмм
//
// Возвращаемое значение:
// ТаблицаЗначений - Таблица пользователей
// * ПользовательИД - Строка - идентификатор пользователя телеграмм
// * Ссылка - СправочникСсылка.Пользователи - ссылка на пользователя
//
Функция ВсеПользователиТелеграмм()
Запрос = Новый Запрос;
@ -525,6 +570,17 @@
КонецФункции
// #240 Пиганов Г.В. 2020-09-08
// Возвращает выборку из запроса с пользователями с учетом отбора для которых разрешена
// отправка сообщений в телеграмм и у которых заполнен идентификатор пользователя телеграмм
//
// Параметры:
// Пользователи - Массив, СправочникСсылка.Пользователь - массив или один пользователь
//
// Возвращаемое значение:
// ВыборкаИзРезультатаЗапроса - выборка пользователей
// * Пользователь - СправочникСсылка.Пользователь - Ссылка на пользователя
// * ПользовательИД - идентификатор пользователя телеграмм
//
Функция ВыборкаПользователейТелеграмДляОтправки(Пользователи)
Запрос = Новый Запрос;
@ -545,6 +601,14 @@
КонецФункции
// #240 Пиганов Г.В. 2020-09-08
// Преобразует строку JSON в соответствие типовым сериализатором 1С
//
// Параметры:
// СтрокаJSON - Строка - строка JSON для преобразования
//
// Возвращаемое значение:
// Соответствие - результат преобразования
//
Функция СоответствиеИзСтрокиJSON(СтрокаJSON) Экспорт
ЧтениеJSON = Новый ЧтениеJSON;
@ -557,6 +621,14 @@
КонецФункции
// #240 Пиганов Г.В. 2020-09-08
// Преобразует строку JSON в соответствие типовым сериализатором 1С
//
// Параметры:
// СоответствиеДанных - Соответствие - данные для преобразования
//
// Возвращаемое значение:
// Строка - результат преобразования
//
Функция СтрокаJSONИзСоответствия(СоответствиеДанных) Экспорт
ПараметрыЗаписиJSON = Новый ПараметрыЗаписиJSON;

23
src/cf/CommonModules/узТелеграмБотКоманды/Ext/Module.bsl
View File

@ -1,5 +1,25 @@

// #240 Пиганов Г.В. 2020-09-08
// Обработаывает команды в переданном сообщении
//
// Параметры:
// Текст - Строка - Текст или заголовок сообшения. Может быть изменен при обработке
// Обработано - Булево - Признак обработки команды. Имеет смысл при обработке
// команд в расширении до стандартных комманд
// ДатаУниверсальная - Дата и время - дата сообщения (UTC+0:00)
// Дата - Дата и время - Дата сообщения в текущем часовом поясе сеанса
// Пользователь - СправочникСсылка.Пользователи - Ссылка на пользователя
// ПользовательИД - Строка- ИД пользователя телеграмм
// ПользовательИмя - Строка - имя пользователя телеграмм
// ПользовательНаименование - Строка - представление пользователя телеграмм
// Номер - Строка - номер текущего сообщения в чате телеграмм
// Файлы - Массив структур - массив файлов или фото в сообщении
// * ИД - Строка - идентификатор файла в телеграмм. Для получения файла через узТелеграммБот.ПолучитьФайл()
// * Имя - имя файла с расширением. Для фото не заполнено
//
// Возвращаемое значение:
// Булево - Истина, если команда обработана
//
Процедура ОбработатьКомандыСообщения(Сообщение) Экспорт
НастройкиБота = Неопределено; // Для сохранения настроек при необходимости
@ -7,6 +27,9 @@
Если ПроверитьСправка(Сообщение) Тогда
Возврат;
КонецЕсли;
Если НЕ ЗначениеЗаполнено(Сообщение.Пользователь) Тогда
Возврат; // Неизвестный пользователь
КонецЕсли;
Если ПроверитьНовоеДело(Сообщение)
ИЛИ ПроверитьНовыйВопрос(Сообщение) Тогда