From 6d04e37d74dc14ac9dfc34bc46c3925e41689827 Mon Sep 17 00:00:00 2001 From: Anton Titovets Date: Fri, 25 Oct 2024 15:26:42 +0300 Subject: [PATCH] Update Start.md --- docs/ru/md/Instructions/Start.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/docs/ru/md/Instructions/Start.md b/docs/ru/md/Instructions/Start.md index 447ab7804..9bf16a9fd 100644 --- a/docs/ru/md/Instructions/Start.md +++ b/docs/ru/md/Instructions/Start.md @@ -52,6 +52,36 @@ sidebar_class_name: NachaloRaboty
+## Примеры использования + +В качестве расширения 1С и OneScript пакета, Открытый пакет интеграций представляет из себя набор общих модулей с экспортными методами - по одному модулю на каждый из API. Все доступные методы являются функциями, т.е. возвращают значения. Как правило, это *Структуры*, описывающие JSON ответа сервера, но также могут быть *Двоичные данные* (например, в методах скачивания файла) или *строки* (например в методах получения URL). Типы возвращаемых значений описаны для каждого метода в текущей документации и докумментирующих комментариях в самом коде библиотеки + +Простой пример использования ОПИ - отправка картинки в Telegram: + +```bsl + + Токен = "6129457865:AAFyzNYOAFbu..."; + IDЧата = "461699897"; + Текст = "Крутая картинка"; + Картинка = "C:/picture.jpg"; // URL, путь на диске или Двоичные данные + + Результат = OPI_Telegram.ОтправитьКартинку(Токен, IDЧата, Текст, Картинка); + +``` + +Реализация ОПИ как CLI приложения, в свою очередь, повторяет функционал расширения и предоставляет доступ ко всем его методам из командной строки. Каждому параметру оригинальной функции соответствует опция, начинающаяся с символов `--`, например `--token`. Эти соответствия для каждого конкретного метода можно найти в текущей документации, а также в комментариях к функциям 1С/OneScript и встроенной справке приложения (справка по методоу отображается при вызове необходимого метода без параметров, подробнее см. [Работа с CLI версией](/docs/Start/CLI_version)) + +Пример для CLI: + +``` + oint telegram ОтправитьКартинку \ + --token "6129457865:AAFyzNYOAFbu..." \ + --chat 461699897 \ + --text "Крутая картинка" \ + --picture "picture.jpg" + +``` + ## Структура модулей Общие модули проекта бывают двух видов: @@ -64,4 +94,4 @@ sidebar_class_name: NachaloRaboty :::warning Не рекомендуется использовать методы служебных модулей в других местах вашей конфигурации (если вы собираетесь обновляться до новых версий в дальнейшем). Для сохранения обратной совместимости, количество/назначение параметров и типы возвращаемых значений для методов работы с API не изменяются, но это не применимо к служебным модулям, которые могут изменяться как угодно для оптимизации и дополнения под новые нужды. Если вам необходим функционал из служебных модулей, рекомендуется скопировать его себе отдельно. -::: +::: \ No newline at end of file