From 52f335516f8b7763afe7e44b22fe5e3708ef4c7c Mon Sep 17 00:00:00 2001 From: Vitaly the Alpaca Date: Wed, 3 Apr 2024 10:46:08 +0000 Subject: [PATCH] =?UTF-8?q?=D0=9F=D1=80=D0=B5=D0=BE=D0=B1=D1=80=D0=B0?= =?UTF-8?q?=D0=B7=D0=BE=D0=B2=D0=B0=D0=BD=D0=B8=D0=B5=20OPI=20->=20OInt=20?= =?UTF-8?q?(workflow)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- OInt/core/Modules/OPI_Notion.os | 136 +++++++++++---------- OInt/core/Modules/OPI_Twitter.os | 95 ++++++++------- OInt/core/Modules/OPI_YandexDisk.os | 182 +++++++++++++++------------- OInt/core/Modules/OPI_YandexID.os | 29 +++-- 4 files changed, 241 insertions(+), 201 deletions(-) diff --git a/OInt/core/Modules/OPI_Notion.os b/OInt/core/Modules/OPI_Notion.os index b0068c36e7..0ce46c4687 100644 --- a/OInt/core/Modules/OPI_Notion.os +++ b/OInt/core/Modules/OPI_Notion.os @@ -36,15 +36,16 @@ #Область РаботаСоСтраницами -// Создать дочернюю страницу над другой страницей-родителем +// Создать страницу +// Создает дочернюю страницу над другой страницей-родителем // // Параметры: -// Токен - Строка - Токен -// Родитель - Строка - ID Родителя -// Заголовок - Строка - Заголовок страницы +// Токен - Строка - Токен - token +// Родитель - Строка - ID Родителя - page +// Заголовок - Строка - Заголовок страницы - title // // Возвращаемое значение: -// Строка, Произвольный, HTTPОтвет, ДвоичныеДанные, Неопределено - Ответ сервера Notion +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion Функция СоздатьСтраницу(Знач Токен, Знач Родитель, Знач Заголовок) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -66,15 +67,16 @@ КонецФункции -// Создать страницу в базу. +// Создать страницу в базу +// Создает страницу в базе-родителе // // Параметры: -// Токен - Строка - Токен -// Родитель - Строка - ID родительской базы -// Данные - Соответствие Из КлючИЗначение - Соответствие свойств. Должен соответствовать шаблону свойств базы +// Токен - Строка - Токен - token +// Родитель - Строка - ID родительской базы - base +// Данные - Соответствие Из КлючИЗначение - Соответствие свойств - data // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, Неопределено, HTTPОтвет - Создать страницу в базу +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion Функция СоздатьСтраницуВБазу(Знач Токен, Знач Родитель, Знач Данные) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -95,14 +97,15 @@ КонецФункции -// Получить страницу. +// Получить страницу +// Получает информацию о странице по ID // // Параметры: -// Токен - Строка - Токен -// Страница - Строка - ID Родителя +// Токен - Строка - Токен - token +// Страница - Строка - ID страницы - page // // Возвращаемое значение: -// ДвоичныеДанные, Неопределено, Строка, Произвольный - Ответ сервера Notion +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion Функция ПолучитьСтраницу(Знач Токен, Знач Страница) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -120,15 +123,15 @@ // Изменить свойства страницы. // // Параметры: -// Токен - Строка - Токен -// Страница - Строка - ID изменяемой страницы -// Данные - Соответствие Из КлючИЗначение - Соответствие изменяемых параметров -// Иконка - Строка - URL картинки - иконки страницы -// Обложка - Строка - URL картинки - обложки страницы -// Архивирована - Булево - Истина - Архивировать страницу +// Токен - Строка - Токен - token +// Страница - Строка - ID изменяемой страницы - page +// Данные - Соответствие Из КлючИЗначение - Соответствие изменяемых параметров - data +// Иконка - Строка - URL картинки - иконки страницы - icon +// Обложка - Строка - URL картинки - обложки страницы - cover +// Архивирована - Булево - Архивировать страницу или нет (булево) - archive // // Возвращаемое значение: -// Строка, Произвольный, Неопределено, HTTPОтвет, ДвоичныеДанные - Изменить свойства страницы +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion Функция ИзменитьСвойстваСтраницы(Знач Токен , Знач Страница , Знач Данные = "" @@ -191,16 +194,17 @@ #Область РаботаСБазамиДанных -// Создать базу данных страниц +// Создать базу данных +// Создает базу данных // // Параметры: -// Токен - Строка - Токен -// Родитель - Строка - ID страницы родителя -// Заголовок - Строка - Заголовок базы данных -// Свойства - Структура Из Строка - Свойства базы данных +// Токен - Строка - Токен - token +// Родитель - Строка - ID страницы родителя - page +// Заголовок - Строка - Заголовок базы данных - title +// Свойства - Структура Из Строка - Свойства базы данных - props // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, Неопределено, HTTPОтвет - Ответ сервера Notion +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion Функция СоздатьБазуДанных(Знач Токен, Знач Родитель, Знач Заголовок, Знач Свойства = "") Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -239,14 +243,15 @@ КонецФункции +// Получить базу данных // Получить данные о базе данных // // Параметры: -// Токен - Строка - Токен -// База - Строка - ID базы данных +// Токен - Строка - Токен - token +// База - Строка - ID базы данных - base // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, Неопределено - Ответ сервера Notion +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion Функция ПолучитьБазуДанных(Знач Токен, Знач База) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -261,18 +266,18 @@ КонецФункции -// Изменить свойства базы. +// Изменить свойства базы +// Изменяет свойства существующей базы // // Параметры: -// Токен - Строка - Токен -// База - Строка - ID целевой базы -// Свойства - Соответствие из КлючИЗначение - Соответствие, как при создании новой базы. Если значение - пусто, -// то свойство будет удалено -// Заголовок - Строка - Заголовок базы -// Описание - Строка - Описание базы +// Токен - Строка - Токен - token +// База - Строка - ID целевой базы - base +// Свойства - Соответствие из КлючИЗначение - Новые/Изменяемые свойства базы данных - props +// Заголовок - Строка - Новый заголовок базы - title +// Описание - Строка - Новое описание базы - description // // Возвращаемое значение: -// Строка, Произвольный, Неопределено, HTTPОтвет, ДвоичныеДанные - Ответ сервера Notion +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion Функция ИзменитьСвойстваБазы(Знач Токен, Знач База, Знач Свойства = "", Знач Заголовок = "", Знач Описание = "") Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -307,16 +312,17 @@ #Область РаботаСБлоками -// Создать блок. +// Создать блок +// Создает новый блок на основе существующего блока // // Параметры: -// Токен - Строка - Токен -// Родитель - Строка - ID родительского блока или страницы -// Блок - Строка,Соответствие Из КлючИЗначение - ID блока, копию которого необходимо добавить или сам блок -// ВставитьПосле - Строка - ID блока, после которого необходимо встаивть новый, если родитель уже имеет дочерние блоки +// Токен - Строка - Токен - token +// Родитель - Строка - ID родительского блока или страницы - page +// Блок - Строка,Соответствие Из КлючИЗначение - ID блока или сам блок-образец - block +// ВставитьПосле - Строка - ID блока, после которого необходимо встаивть новый - prev // // Возвращаемое значение: -// Строка, Произвольный, Неопределено, ДвоичныеДанные, HTTPОтвет - Ответ сервера Notion +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion Функция СоздатьБлок(Знач Токен, Знач Родитель, Знач Блок, Знач ВставитьПосле = "") Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -356,12 +362,12 @@ // Вернуть блок. // // Параметры: -// Токен - Строка - Токен -// ИДБлока - Строка - ID блока -// ТолькоОснова - Булево - Истина - служебные поля удаляются, остается только сам блок +// Токен - Строка - Токен - token +// ИДБлока - Строка - ID блока - block +// ТолькоОснова - Булево - Истина > служебные поля удаляются, остается только сам блок - core // // Возвращаемое значение: -// Неопределено, ДвоичныеДанные, Строка, Произвольный - Ответ сервера Notion +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion Функция ВернутьБлок(Знач Токен, Знач ИДБлока, Знач ТолькоОснова = Истина) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -381,14 +387,15 @@ КонецФункции -// Вернуть дочерние блоки. +// Вернуть дочерние блоки +// Созвращает список дочерних блоков блока-родителя // // Параметры: -// Токен - Строка - Токен -// ИДБлока - Строка - ID блока-родителя +// Токен - Строка - Токен - token +// ИДБлока - Строка - ID блока-родителя - block // // Возвращаемое значение: -// Неопределено, ДвоичныеДанные, Строка, Произвольный - Ответ сервера Notion +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion Функция ВернутьДочерниеБлоки(Знач Токен, Знач ИДБлока) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -403,14 +410,15 @@ КонецФункции -// Удалить блок. +// Удалить блок +// Удаляет блок по ID // // Параметры: -// Токен - Строка - Токен -// ИДБлока - Строка - ID блока +// Токен - Строка - Токен - token +// ИДБлока - Строка - ID блока - block // // Возвращаемое значение: -// Неопределено, ДвоичныеДанные, Строка, Произвольный - Ответ сервера Notion +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion Функция УдалитьБлок(Знач Токен, Знач ИДБлока) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -429,13 +437,14 @@ #Область Пользователи -// Список пользователей. +// Список пользователей +// Возвращает список пользователей рабочего пространства // // Параметры: -// Токен - Строка - Токен +// Токен - Строка - Токен - token // // Возвращаемое значение: -// Неопределено, ДвоичныеДанные, Строка, Произвольный - Ответ сервера Notion +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion Функция СписокПользователей(Знач Токен) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -447,14 +456,15 @@ КонецФункции -// Получить данные пользователя. +// Получить данные пользователя +// Получает данные пользователя по ID // // Параметры: -// Токен - Строка - Токен -// ИДПользователя - Строка - ID целевого пользователя +// Токен - Строка - Токен - token +// ИДПользователя - Строка - ID целевого пользователя - user // // Возвращаемое значение: -// Неопределено, ДвоичныеДанные, Строка, Произвольный - Получить данные пользователя +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Notion Функция ПолучитьДанныеПользователя(Знач Токен, Знач ИДПользователя) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); diff --git a/OInt/core/Modules/OPI_Twitter.os b/OInt/core/Modules/OPI_Twitter.os index 62114e4f7e..766e1b4a82 100644 --- a/OInt/core/Modules/OPI_Twitter.os +++ b/OInt/core/Modules/OPI_Twitter.os @@ -39,10 +39,11 @@ #Область ДанныеИНастройка -// Получить ссылку для авторизации через браузер. +// Получить ссылку для авторизации +// Формирует ссылку для авторизации через браузер // // Параметры: -// Параметры - Соответствие Из Строка - См.ПолучитьСтандартныеПараметры +// Параметры - Структура из Строка - См.ПолучитьСтандартныеПараметры - auth - JSON авторизации или путь к .json // // Возвращаемое значение: // Строка - URL для перехода в браузере @@ -67,14 +68,15 @@ КонецФункции -// Получить токен. +// Получить токен +// Получает токен по коду, полученному при авторизации по ссылке из ПолучитьСсылкуАвторизации // // Параметры: -// Код - Строка - Код, полученный из авторизации См.ПолучитьСсылкуАвторизации -// Параметры - Соответствие Из Строка - См.ПолучитьСтандартныеПараметры +// Код - Строка - Код, полученный из авторизации См.ПолучитьСсылкуАвторизации - code +// Параметры - Структура из Строка - См.ПолучитьСтандартныеПараметры - auth - JSON авторизации или путь к .json // // Возвращаемое значение: -// HTTPОтвет, Произвольный, ДвоичныеДанные - Результат чтения JSON ответа сервера +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter Функция ПолучитьТокен(Знач Код, Знач Параметры = "") Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Код); @@ -95,13 +97,14 @@ КонецФункции -// Обновить токен v2 токен при помощи refresh_token +// Обновить токен +// Обновляет v2 токен при помощи refresh_token // // Параметры: -// Параметры - Соответствие Из Строка - См.ПолучитьСтандартныеПараметры +// Параметры - Структура из Строка - См.ПолучитьСтандартныеПараметры - auth - JSON авторизации или путь к .json // // Возвращаемое значение: -// HTTPОтвет, Произвольный, ДвоичныеДанные - Результат чтения JSON ответа сервера +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter Функция ОбновитьТокен(Знач Параметры = "") Экспорт Параметры_ = ПолучитьСтандартныеПараметры(Параметры); @@ -119,6 +122,7 @@ КонецФункции +// !NOCLI // Метод для вставки в http-сервис, адрес которого указывается в redirect_uri // Вызывает метод получения токена, так как для получения токена из кода, приходящего // на redirect_uri после авторизации через браузер есть всего 30 секунд @@ -147,17 +151,18 @@ #Область Твиты -// Создать произвольный твит. +// !NOCLI +// Создать произвольный твит // // Параметры: -// Текст - Строка - Текст твита -// МассивМедиа - Массив из Строка,ДвоичныеДанные - Массив двоичных данных или путей к файлам +// Текст - Строка - Текст твита +// МассивМедиа - Массив из Строка,ДвоичныеДанные - Массив двоичных данных или путей к файлам // МассивВариантовОпроса - Массив из Строка - Массив вариантов опроса, если необходимо -// ДлительностьОпроса - Строка,Число - Длительность опроса, если необходимо (опрос без длительности не создается) -// Параметры - Соответствие из Строка - См.ПолучитьСтандартныеПараметры +// ДлительностьОпроса - Строка,Число - Длительность опроса, если необходимо (опрос без длительности не создается) +// Параметры - Структура из Строка - См.ПолучитьСтандартныеПараметры - auth - JSON авторизации или путь к .json // // Возвращаемое значение: -// Строка, Произвольный, Неопределено, ДвоичныеДанные, HTTPОтвет - Создать произвольный твит +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter Функция СоздатьПроизвольныйТвит(Знач Текст = "" , Знач МассивМедиа = "" , Знач МассивВариантовОпроса = "" @@ -210,27 +215,29 @@ КонецФункции -// Создать текстовый твит. +// Создать текстовый твит +// Создает твит без вложений // // Параметры: -// Текст - Строка - Текст твита -// Параметры - Соответствие из Строка - См.ПолучитьСтандартныеПараметры +// Текст - Строка - Текст твита - text +// Параметры - Структура из Строка - См.ПолучитьСтандартныеПараметры - auth - JSON авторизации или путь к .json // // Возвращаемое значение: -// Строка, Произвольный, Неопределено, ДвоичныеДанные, HTTPОтвет - Создать текстовый твит +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter Функция СоздатьТекстовыйТвит(Знач Текст, Знач Параметры = "") Экспорт Возврат СоздатьПроизвольныйТвит(Текст, , , , Параметры); КонецФункции -// Создать твит картинки. +// Создать твит картинки +// Создает твит с картинкой вложением // // Параметры: -// Текст - Строка - Текст твита -// МассивКартинок - Массив из Строка,ДвоичныеДанные - Массив двоичных данных или путей к картинкам -// Параметры - Соответствие из Строка - См.ПолучитьСтандартныеПараметры +// Текст - Строка - Текст твита - text +// МассивКартинок - Массив из Строка,ДвоичныеДанные - Массив файлов картинок - pictures +// Параметры - Структура из Строка - См.ПолучитьСтандартныеПараметры - auth - JSON авторизации или путь к .json // // Возвращаемое значение: -// Строка, Произвольный, Неопределено, ДвоичныеДанные, HTTPОтвет - Создать твит картинки +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter Функция СоздатьТвитКартинки(Знач Текст, Знач МассивКартинок, Знач Параметры = "") Экспорт МассивМедиа = ЗагрузитьМассивВложений(МассивКартинок, "tweet_image", Параметры); @@ -238,15 +245,16 @@ КонецФункции -// Создать твит гифки. +// Создать твит гифки +// Создает твит с вложением-гифкой // // Параметры: -// Текст - Строка - Текст твита -// МассивГифок - Массив из Строка,ДвоичныеДанные - Массив двоичных данных или путей к гифкам -// Параметры - Соответствие из Строка - См.ПолучитьСтандартныеПараметры +// Текст - Строка - Текст твита - text +// МассивГифок - Массив из Строка,ДвоичныеДанные - Массив файлов гифок - gifs +// Параметры - Структура из Строка - См.ПолучитьСтандартныеПараметры - auth - JSON авторизации или путь к .json // // Возвращаемое значение: -// Строка, Произвольный, Неопределено, ДвоичныеДанные, HTTPОтвет - Создать твит гифки +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter Функция СоздатьТвитГифки(Знач Текст, Знач МассивГифок, Знач Параметры = "") Экспорт МассивМедиа = ЗагрузитьМассивВложений(МассивГифок, "tweet_gif", Параметры); @@ -254,15 +262,16 @@ КонецФункции -// Создать твит видео. +// Создать твит видео +// Создает твит с видеовложением // // Параметры: -// Текст - Строка - Текст твита -// МассивВидео - Массив из Строка,ДвоичныеДанные - Массив двоичных данных или путей к видео -// Параметры - Соответствие из Строка - См.ПолучитьСтандартныеПараметры +// Текст - Строка - Текст твита - text +// МассивВидео - Массив из Строка,ДвоичныеДанные - Массив файлов видео - videos +// Параметры - Структура из Строка - См.ПолучитьСтандартныеПараметры - auth - JSON авторизации или путь к .json // // Возвращаемое значение: -// Строка, Произвольный, Неопределено, ДвоичныеДанные, HTTPОтвет - Создать твит видео +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter Функция СоздатьТвитВидео(Знач Текст, Знач МассивВидео, Знач Параметры = "") Экспорт МассивМедиа = ЗагрузитьМассивВложений(МассивВидео, "tweet_video", Параметры); @@ -270,26 +279,28 @@ КонецФункции -// Создать твит опрос. +// Создать твит опрос +// Создает твит с опросом // // Параметры: -// Текст - Строка - Текст твита -// МассивВариантов - Массив из Строка - Массив вариантов опроса -// Длительность - Строка,Число - Длительность опроса -// Параметры - Соответствие из Строка - См.ПолучитьСтандартныеПараметры +// Текст - Строка - Текст твита - text +// МассивВариантов - Массив из Строка - Массив вариантов опроса - options +// Длительность - Строка,Число - Длительность опроса - duration +// Параметры - Структура из Строка - См.ПолучитьСтандартныеПараметры - auth - JSON авторизации или путь к .json // // Возвращаемое значение: -// Строка, Произвольный, Неопределено, ДвоичныеДанные, HTTPОтвет - Создать твит опрос +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Twitter Функция СоздатьТвитОпрос(Знач Текст, Знач МассивВариантов, Знач Длительность, Знач Параметры = "") Экспорт Возврат СоздатьПроизвольныйТвит(Текст, , МассивВариантов, Длительность, Параметры); КонецФункции -// Загрузить массив вложений. +// Загрузить массив вложений !NOCLI +// Загружает файлы на сервер и возвращает их ID // // Параметры: // МассивФайлов - Массив из Строка, ДвоичныеДанные - Массив файлов // ТипВложений - Строка - Тип вложений -// Параметры - Соответствие из Строка - См.ПолучитьСтандартныеПараметры +// Параметры - Структура из Строка - См.ПолучитьСтандартныеПараметры - auth - JSON авторизации или путь к .json // // Возвращаемое значение: // Массив Из Строка - Массив ID медиа diff --git a/OInt/core/Modules/OPI_YandexDisk.os b/OInt/core/Modules/OPI_YandexDisk.os index e987e3db35..b01e12dc91 100644 --- a/OInt/core/Modules/OPI_YandexDisk.os +++ b/OInt/core/Modules/OPI_YandexDisk.os @@ -36,13 +36,14 @@ #Область РаботаСФайламиИПапками -// Получить информацию о диске. +// Получить информацию о диске +// Получает информацию о текущем диске // // Параметры: -// Токен - Строка - Токен +// Токен - Строка - Токен - token // // Возвращаемое значение: -// ДвоичныеДанные, Неопределено, Строка, Произвольный - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция ПолучитьИнформациюОДиске(Знач Токен) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -54,14 +55,15 @@ КонецФункции -// Создать папку. +// Создать папку +// Создает каталог на диске // // Параметры: -// Токен - Строка - Токен -// Путь - Строка - Путь к созаваемой папке +// Токен - Строка - Токен - token +// Путь - Строка - Путь к созаваемой папке - path // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, HTTPОтвет, Неопределено - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция СоздатьПапку(Знач Токен, Знач Путь) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -89,14 +91,15 @@ КонецФункции -// Получить объект. +// Получить объект +// Получает информацию об объекте диска по заданному пути // // Параметры: -// Токен - Строка - Токен -// Путь - Строка - Путь к папке или файлу, о котором необходимо получить информацию +// Токен - Строка - Токен - token +// Путь - Строка - Путь к папке или файлу - path // // Возвращаемое значение: -// ДвоичныеДанные, Неопределено, Строка, Произвольный - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция ПолучитьОбъект(Знач Токен, Знач Путь) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -112,15 +115,16 @@ КонецФункции -// Удалить объект. +// Удалить объект +// Удаляет объект по заданному пути // // Параметры: -// Токен - Строка - Токен -// Путь - Строка - Путь к удаляемой папке или файлу -// ВКорзину - Булево - В корзину +// Токен - Строка - Токен - token +// Путь - Строка - Путь к удаляемой папке или файлу - path +// ВКорзину - Булево - В корзину - can // // Возвращаемое значение: -// ДвоичныеДанные, Неопределено, Строка, Произвольный - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция УдалитьОбъект(Знач Токен, Знач Путь, Знач ВКорзину = Истина) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -139,16 +143,17 @@ КонецФункции -// Создать копию объекта. +// Создать копию объекта +// Создает копию объекта по заданному пути и пути к оригиналу // // Параметры: -// Токен - Строка - Токен -// Оригинал - Строка - Путь к оригинальному файлу или каталогу -// Путь - Строка - Путь-назначение для копии -// Перезаписывать - Булево - Перезаписывать если файл с таким именем уже существует +// Токен - Строка - Токен - token +// Оригинал - Строка - Путь к оригинальному файлу или каталогу - from +// Путь - Строка - Путь назначения для копии - to +// Перезаписывать - Булево - Перезаписывать если файл с таким именем уже существует - rewrite // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, HTTPОтвет, Неопределено - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция СоздатьКопиюОбъекта(Знач Токен, Знач Оригинал, Знач Путь, Знач Перезаписывать = Ложь) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -180,14 +185,15 @@ КонецФункции -// Получить ссылку для скачивания. +// Получить ссылку для скачивания +// Получает ссылку для скачивания файла // // Параметры: -// Токен - Строка - Токен -// Путь - Строка - Путь к файлу для скачивания +// Токен - Строка - Токен - token +// Путь - Строка - Путь к файлу для скачивания - parh // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, HTTPОтвет, Неопределено - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция ПолучитьСсылкуДляСкачивания(Знач Токен, Знач Путь) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -204,20 +210,21 @@ КонецФункции -// Получить список файлов. -// +// Получить список файлов +// Получает список файлов с или без отбора по типу +// Список доступных типов: audio, backup, book, compressed, data, development, +// diskimage, document, encoded, executable, flash, font, +// mage, settings, spreadsheet, text, unknown, video, web +// // Параметры: -// Токен - Строка - Токен -// Количество - Число,Строка - Количество возвращаемых объектов -// СмещениеОтНачала - Число - Смещение для получение объектов не из начала списка -// ОтборПоТипу - Строка - Отбор по типу файла -// Список доступных вариантов: audio, backup, book, compressed, data, development, -// diskimage, document, encoded, executable, flash, font, -// image, settings, spreadsheet, text, unknown, video, web -// СортироватьПоДате - Булево - Истина - сортировать по дате, Ложь - по алфавиту +// Токен - Строка - Токен - token +// Количество - Число,Строка - Количество возвращаемых объектов - amount +// СмещениеОтНачала - Число - Смещение для получение объектов не из начала списка - offset +// ОтборПоТипу - Строка - Отбор по типу файла - type +// СортироватьПоДате - Булево - Истина > сортировать по дате, Ложь > по алфавиту - datesort // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, HTTPОтвет, Неопределено - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция ПолучитьСписокФайлов(Знач Токен , Знач Количество = 0 , Знач СмещениеОтНачала = 0 @@ -258,16 +265,17 @@ КонецФункции -// Переместить объект. +// Переместить объект +// Перемещает объект по заданному пути и пути к оригиналу // // Параметры: -// Токен - Строка - Токен -// Оригинал - Строка - Путь к оригинальному файлу или папке -// Путь - Строка - Путь-назначение для перемещения -// Перезаписывать - Булево - Перезаписывать если файл с таким именем уже существует +// Токен - Строка - Токен - token +// Оригинал - Строка - Путь к оригинальному файлу или папке - from +// Путь - Строка - Путь-назначение для перемещения - to +// Перезаписывать - Булево - Перезаписывать если файл с таким именем уже существует - rewrite // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, HTTPОтвет, Неопределено - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция ПереместитьОбъект(Знач Токен, Знач Оригинал, Знач Путь, Знач Перезаписывать = Ложь) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -298,16 +306,17 @@ КонецФункции -// Получить ссылку загрузки файла. +// Загрузить файл +// Загружает файл на диск по заданному пути // // Параметры: -// Токен - Строка - Токен -// Путь - Строка - Путь для сохранение файла на Диске -// Файл - Строка,ДвоичныеДанные - Файл для загрузки -// Перезаписывать - Булево - Перезаписывать, если файл с таким именем уже существует +// Токен - Строка - Токен - token +// Путь - Строка - Путь для сохранение файла на Диске - path +// Файл - Строка,ДвоичныеДанные - Файл для загрузки - file +// Перезаписывать - Булево - Перезаписывать, если файл с таким именем уже существует - rewrite // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, HTTPОтвет, Неопределено - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция ЗагрузитьФайл(Знач Токен, Знач Путь, Знач Файл, Знач Перезаписывать = Ложь) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -336,15 +345,16 @@ КонецФункции -// Загрузить файл по URL. +// Загрузить файл по URL +// Загружает файл на диск, забирая его по заданному URL // // Параметры: -// Токен - Строка - Токен -// Путь - Строка - Путь помещения загруженного файла -// Адрес - Строка - URL файла +// Токен - Строка - Токен - token +// Путь - Строка - Путь помещения загруженного файла - path +// Адрес - Строка - URL файла - url // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, Неопределено, HTTPОтвет - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция ЗагрузитьФайлПоURL(Знач Токен, Знач Путь, Знач Адрес) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -369,39 +379,42 @@ #Область УправлениеПубличнымДоступом -// Опубликовать объект. +// Опубликовать объект +// Публикует объект диска в публичный доступ // // Параметры: -// Токен - Строка - Токен -// Путь - Строка - Путь к публикуемому объекту +// Токен - Строка - Токен - token +// Путь - Строка - Путь к публикуемому объекту - path // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, HTTPОтвет, Неопределено - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция ОпубликоватьОбъект(Знач Токен, Знач Путь) Экспорт Возврат ПереключениеОбщегоДоступа(Токен, Путь, Истина); КонецФункции -// Отменить публикацию объекта. +// Отменить публикацию объекта +// Отменяет публикацию ранее опубликованного объекта // // Параметры: -// Токен - Строка - Токен -// Путь - Строка - Путь к опубликованному ранее объекту +// Токен - Строка - Токен - token +// Путь - Строка - Путь к опубликованному ранее объекту - path // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, HTTPОтвет, Неопределено - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция ОтменитьПубликациюОбъекта(Знач Токен, Знач Путь) Экспорт Возврат ПереключениеОбщегоДоступа(Токен, Путь, Ложь); КонецФункции // Получить список опубликованных объектов. +// Получает список опубликованных объектов // // Параметры: -// Токен - Строка - Токен -// Количество - Число - Количество возвращаемых объектов -// СмещениеОтНачала - Число - Смещение для получение объектов не из начала списка +// Токен - Строка - Токен - token +// Количество - Число - Количество возвращаемых объектов - amount +// СмещениеОтНачала - Число - Смещение для получение объектов не из начала списка - offset // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, HTTPОтвет, Неопределено - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция ПолучитьСписокОпубликованныхОбъектов(Знач Токен, Знач Количество = 0, Знач СмещениеОтНачала = 0) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -426,16 +439,17 @@ КонецФункции -// Получить публичный объект. +// Получить публичный объект +// Получает информацию об опубликованном объекте по его URL // // Параметры: -// Токен - Строка - Токен -// URL - Строка - Адрес объекта -// Количество - Число - Количество возвращаемых вложенных объектов (для каталога) -// СмещениеОтНачала - Число - Смещение для получение вложенных объектов не из начала списка +// Токен - Строка - Токен - token +// URL - Строка - Адрес объекта - url +// Количество - Число - Количество возвращаемых вложенных объектов (для каталога) - amount +// СмещениеОтНачала - Число - Смещение для получение вложенных объектов не из начала списка - offset // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, Неопределено - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция ПолучитьПубличныйОбъект(Знач Токен, Знач URL, Знач Количество = 0, Знач СмещениеОтНачала = 0) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -463,15 +477,16 @@ КонецФункции -// Получить ссылку скачивания публичного объекта. +// Получить ссылку скачивания публичного объекта +// Получает прямую ссылку для скачивания публичного объекта // // Параметры: -// Токен - Строка - Токен -// URL - Строка - Адрес объекта -// Путь - Строка - Путь +// Токен - Строка - Токен - token +// URL - Строка - Адрес объекта - url +// Путь - Строка - Путь внутри объекта - path // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, Неопределено - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция ПолучитьСсылкуСкачиванияПубличногоОбъекта(Знач Токен, Знач URL, Знач Путь = "") Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); @@ -494,16 +509,17 @@ КонецФункции -// Сохранить публичный объект на диск. +// Сохранить публичный объект на диск +// Сохраняет публичный объект на ваш диск // // Параметры: -// Токен - Строка - Токен -// URL - Строка - Адрес объекта -// Откуда - Строка - Путь внутри публичного каталога (только для папок) -// Куда - Строка - Путь сохранения файла +// Токен - Строка - Токен - token +// URL - Строка - Адрес объекта - url +// Откуда - Строка - Путь внутри публичного каталога (только для папок) - from +// Куда - Строка - Путь сохранения файла - to // // Возвращаемое значение: -// Строка, Произвольный, ДвоичныеДанные, Неопределено, HTTPОтвет - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция СохранитьПубличныйОбъектНаДиск(Знач Токен, Знач URL, Откуда = "", Куда = "") Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(Токен); diff --git a/OInt/core/Modules/OPI_YandexID.os b/OInt/core/Modules/OPI_YandexID.os index aeec95432f..34c425418f 100644 --- a/OInt/core/Modules/OPI_YandexID.os +++ b/OInt/core/Modules/OPI_YandexID.os @@ -30,13 +30,14 @@ #Область ПрограммныйИнтерфейс -// Получить код подтверждения. +// Получить код подтверждения +// Получает код подтверждения и адрес страницы, на которой его необходимо ввести // // Параметры: -// ClientId - Строка - Client id +// ClientId - Строка - Client id - id // // Возвращаемое значение: -// Строка, Произвольный, Неопределено, ДвоичныеДанные, HTTPОтвет - Ответ сервера Yandex +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция ПолучитьКодПодтверждения(Знач ClientId) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(ClientId); @@ -48,15 +49,16 @@ КонецФункции -// Преобразовать код в токен. +// Преобразовать код в токен +// Преобразовывает код в токен после ввода кода при выполнении ПолучитьКодПодтверждения // // Параметры: -// ClientId - Строка - Client id -// ClientSecret - Строка - Client secret -// КодУстройства - Строка - device_code из ПолучитьКодПодтверждения() +// ClientId - Строка - Client id - id +// ClientSecret - Строка - Client secret - secret +// КодУстройства - Строка - device_code из ПолучитьКодПодтверждения() - device // // Возвращаемое значение: -// Строка, Произвольный, Неопределено, ДвоичныеДанные, HTTPОтвет - Преобразовать код в токен +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция ПреобразоватьКодВТокен(Знач ClientId, Знач ClientSecret, Знач КодУстройства) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(ClientId); @@ -75,15 +77,16 @@ КонецФункции -// Обновить токен. +// Обновить токен +// Обновляет токен по Refresh token // // Параметры: -// ClientId - Строка - Client id -// ClientSecret - Строка - Client secret -// RefreshToken - Строка - Refresh token +// ClientId - Строка - Client id - id +// ClientSecret - Строка - Client secret - secret +// RefreshToken - Строка - Refresh token - refresh // // Возвращаемое значение: -// Строка, Произвольный, Неопределено, ДвоичныеДанные, HTTPОтвет - Обновить токен +// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Yandex Функция ОбновитьТокен(Знач ClientId, Знач ClientSecret, Знач RefreshToken) Экспорт OPI_ПреобразованиеТипов.ПолучитьСтроку(ClientId);