1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-01-26 05:37:27 +02:00

Документация CLI

This commit is contained in:
Anton 2024-04-13 15:39:29 +03:00
parent 1e35b65901
commit af5a58518d
22 changed files with 212 additions and 104 deletions

View File

@ -36,8 +36,8 @@
// Получает информацию о папке или файле по ID
//
// Параметры:
// Токен - Строка - Токен - token
// Идентификатор - Строка - Идентификатор файла/каталога - object
// Токен - Строка - Токен - token
// Идентификатор - Строка - Идентификатор файла или каталога - object
//
// Возвращаемое значение:
// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Google

View File

@ -7,10 +7,10 @@ sidebar_position: 4
*Функция УдалитьКалендарь(Знач Токен, Знач Календарь) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Календарь | Строка | ID календаря для удаления |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Календарь | --calendar | Строка | ID календаря для удаления |
Вовзращаемое значение: Пустая строка
@ -20,6 +20,15 @@ sidebar_position: 4
```
```sh title="Пример команд CLI"
oint google ОбновитьТокен --id %clientid% --secret %clientsecret% --refresh %refreshtoken% > token.json
oint tools РазложитьJSON --json token.json --name access_token > token.tmp
set /p token=<token.tmp
oint gcalendar УдалитьКалендарь --token "%token%" --calendar %calendar%
```
```json title="Результат"
""

View File

@ -7,12 +7,12 @@ sidebar_position: 6
*Функция ИзменитьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия, Знач Событие) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Календарь | Строка | ID календаря|
| ОписаниеТовара | Соответствие | Описание создаваемого события. См. [ПолучитьОписаниеТовара](./Poluchit-opisanye-sobytiya) |
| Событие | Строка | ID события для изменения |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Календарь | --calendar | Строка | ID календаря|
| ОписаниеТовара | --props | Соответствие | Описание создаваемого события. См. [ПолучитьОписаниеТовара](./Poluchit-opisanye-sobytiya) |
| Событие | --event | Строка | ID события для изменения |
Вовзращаемое значение: Соответствие - сериализованный JSON ответа от VK
@ -26,6 +26,15 @@ sidebar_position: 6
```
```sh title="Пример команд CLI"
oint google ОбновитьТокен --id %clientid% --secret %clientsecret% --refresh %refreshtoken% > token.json
oint tools РазложитьJSON --json token.json --name access_token > token.tmp
set /p token=<token.tmp
oint gcalendar ИзменитьСобытие --token %token% --calendar %calendar% --props "C:\event.json" --event %event%
```
```json title="Результат"
{

View File

@ -7,12 +7,12 @@ sidebar_position: 5
*Функция ПереместитьСобытие(Знач Токен, Знач КалендарьИсточник, Знач КалендарьПриемник, Знач Событие) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| КалендарьИсточник | Строка | ID календаря-источника |
| КалендарьПриемник | Строка | ID календаря-приемника |
| Событие | Строка | ID события для перемещения |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| КалендарьИсточник | --from | Строка | ID календаря-источника |
| КалендарьПриемник | --to | Строка | ID календаря-приемника |
| Событие | --event | Строка | ID события для перемещения |
Вовзращаемое значение: Соответствие - сериализованный JSON ответа от Google
@ -23,6 +23,15 @@ sidebar_position: 5
```
```sh title="Пример команд CLI"
oint google ОбновитьТокен --id %clientid% --secret %clientsecret% --refresh %refreshtoken% > token.json
oint tools РазложитьJSON --json token.json --name access_token > token.tmp
set /p token=<token.tmp
oint gcalendar ПереместитьСобытие --token %token% --from %calendar% --to %calendar2% --event %event%
```
```json title="Результат"
{

View File

@ -7,11 +7,11 @@ sidebar_position: 3
*Функция ПолучитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Календарь | Строка | ID календаря |
| Событие | Строка | ID события |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Календарь | --calendar | Строка | ID календаря |
| Событие | --event | Строка | ID события |
Вовзращаемое значение: Соответствие - сериализованный JSON ответа от Google
@ -22,6 +22,15 @@ sidebar_position: 3
```
```sh title="Пример команд CLI"
oint google ОбновитьТокен --id %clientid% --secret %clientsecret% --refresh %refreshtoken% > token.json
oint tools РазложитьJSON --json token.json --name access_token > token.tmp
set /p token=<token.tmp
oint gcalendar ПолучитьСобытие --token %token% --calendar %calendar% --event %event%
```
```json title="Результат"
{

View File

@ -7,10 +7,10 @@ sidebar_position: 2
*Функция ПолучитьСписокСобытий(Знач Токен, Знач Календарь) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Календарь | Строка | ID календаря |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Календарь | --calendar | Строка | ID календаря |
Вовзращаемое значение: Массив из Соответствие - массив данных событий
@ -21,6 +21,15 @@ sidebar_position: 2
```
```sh title="Пример команд CLI"
oint google ОбновитьТокен --id %clientid% --secret %clientsecret% --refresh %refreshtoken% > token.json
oint tools РазложитьJSON --json token.json --name access_token > token.tmp
set /p token=<token.tmp
oint gcalendar ПолучитьСписокСобытий --token %token% --calendar %calendar%
```
```json title="Результат"
[

View File

@ -7,11 +7,11 @@ sidebar_position: 4
*Функция СоздатьСобытие(Знач Токен, Знач Календарь, Знач ОписаниеСобытия) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Календарь | Строка | ID календаря|
| ОписаниеТовара | Соответствие | Описание создаваемого события. См. [ПолучитьОписаниеТовара](./Poluchit-opisanye-sobytiya) |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Календарь | --calendar | Строка | ID календаря|
| ОписаниеТовара | --props | Соответствие | Описание создаваемого события. См. [ПолучитьОписаниеТовара](./Poluchit-opisanye-sobytiya) |
Вовзращаемое значение: Соответствие - сериализованный JSON ответа от VK
@ -35,6 +35,15 @@ sidebar_position: 4
```
```sh title="Пример команд CLI"
oint google ОбновитьТокен --id %clientid% --secret %clientsecret% --refresh %refreshtoken% > token.json
oint tools РазложитьJSON --json token.json --name access_token > token.tmp
set /p token=<token.tmp
oint gcalendar СоздатьСобытие --token %token% --calendar %calendar% --props "C:\event.json"
```
![Результат](img/1.png)
```json title="Результат"

View File

@ -7,11 +7,11 @@ sidebar_position: 7
*Функция УдалитьСобытие(Знач Токен, Знач Календарь, Знач Событие) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Календарь | Строка | ID календаря |
| Событие | Строка | ID события |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Календарь | --calendar | Строка | ID календаря |
| Событие | --event | Строка | ID события |
Вовзращаемое значение: Пустая строка
@ -22,6 +22,15 @@ sidebar_position: 7
```
```sh title="Пример команд CLI"
oint google ОбновитьТокен --id %clientid% --secret %clientsecret% --refresh %refreshtoken% > token.json
oint tools РазложитьJSON --json token.json --name access_token > token.tmp
set /p token=<token.tmp
oint gcalendar УдалитьСобытие --token %token% --calendar %calendar% --event %event%
```
```json title="Результат"
""

View File

@ -7,10 +7,10 @@ sidebar_position: 3
*Функция ДобавитьКалендарьВСписок(Знач Токен, Знач Календарь) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Календарь | Строка | ID календаря для добавления |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Календарь | --calendar | Строка | ID календаря для добавления |
Вовзращаемое значение: Соответствие - сериализованный JSON ответа от Google
@ -21,6 +21,15 @@ sidebar_position: 3
```
```sh title="Пример команд CLI"
oint google ОбновитьТокен --id %clientid% --secret %clientsecret% --refresh %refreshtoken% > token.json
oint tools РазложитьJSON --json token.json --name access_token > token.tmp
set /p token=<token.tmp
oint gcalendar ДобавитьКалендарьВСписок --token %token% --calendar %calendar%
```
![Результат](img/1.png)
```json title="Результат"

View File

@ -7,13 +7,13 @@ sidebar_position: 4
*Функция ИзменитьКалендарьСписка(Знач Токен, Знач Календарь, Знач ОсновнойЦвет, Знач ДополнительныйЦвет, Знач Скрытый = Ложь) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Календарь | Строка | ID календаря для добавления |
| ОсновнойЦвет | Строка | HEX основного цвета (цвета шрифта) в формате #ffffff |
| ДополнительныйЦвет | Строка | HEX дополнительного цвета (цвета фона) в формате #ffffff |
| Скрытый | Булево (необяз.) | Признак скрытости календаря |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Календарь | --calendar | Строка | ID календаря для добавления |
| ОсновнойЦвет | --primary | Строка | HEX основного цвета (цвета шрифта) в формате #ffffff |
| ДополнительныйЦвет | --secondary | Строка | HEX дополнительного цвета (цвета фона) в формате #ffffff |
| Скрытый | --hidden | Булево (необяз.) | Признак скрытости календаря |
Вовзращаемое значение: Соответствие - сериализованный JSON ответа от Google
@ -28,6 +28,15 @@ sidebar_position: 4
```
```sh title="Пример команд CLI"
oint google ОбновитьТокен --id %clientid% --secret %clientsecret% --refresh %refreshtoken% > token.json
oint tools РазложитьJSON --json token.json --name access_token > token.tmp
set /p token=<token.tmp
oint gcalendar ИзменитьКалендарьСписка --token %token% --calendar %calendar% --primary "#000000" --secondary "#ffffff" --hidden false
```
![Результат](img/2.png)
```json title="Результат"

View File

@ -7,10 +7,10 @@ sidebar_position: 2
*Функция ПолучитьКалендарьСписка(Знач Токен, Знач Календарь) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Календарь | Строка | ID календаря для получения |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Календарь | --calendar | Строка | ID календаря для получения |
Вовзращаемое значение: Соответствие - сериализованный JSON ответа от Google
@ -21,6 +21,15 @@ sidebar_position: 2
```
```sh title="Пример команд CLI"
oint google ОбновитьТокен --id %clientid% --secret %clientsecret% --refresh %refreshtoken% > token.json
oint tools РазложитьJSON --json token.json --name access_token > token.tmp
set /p token=<token.tmp
oint gcalendar ПолучитьКалендарьСписка --token %token% --calendar %calendar%
```
```json title="Результат"
{

View File

@ -7,9 +7,9 @@ sidebar_position: 1
*Функция ПолучитьСписокКалендарей(Знач Токен) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
Вовзращаемое значение: Массив из Соответствие - массив данных календарей
@ -20,6 +20,15 @@ sidebar_position: 1
```
```sh title="Пример команд CLI"
oint google ОбновитьТокен --id %clientid% --secret %clientsecret% --refresh %refreshtoken% > token.json
oint tools РазложитьJSON --json token.json --name access_token > token.tmp
set /p token=<token.tmp
oint gcalendar ПолучитьСписокКалендарей --token %token%
```
```json title="Результат"
[

View File

@ -7,10 +7,10 @@ sidebar_position: 5
*Функция УдалитьКалендарьИзСписка(Знач Токен, Знач Календарь) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Календарь | Строка | ID календаря для получения |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Календарь | --calendar | Строка | ID календаря для получения |
Вовзращаемое значение: Пустая строка
@ -21,6 +21,15 @@ sidebar_position: 5
```
```sh title="Пример команд CLI"
oint google ОбновитьТокен --id %clientid% --secret %clientsecret% --refresh %refreshtoken% > token.json
oint tools РазложитьJSON --json token.json --name access_token > token.tmp
set /p token=<token.tmp
oint gcalendar УдалитьКалендарьИзСписка --token %token% --calendar %calendar%
```
```json title="Результат"
""

View File

@ -7,12 +7,12 @@ sidebar_position: 6
*Функция ОбновитьФайл(Знач Токен, Знач Идентификатор, Знач Файл, Знач НовоеИмя = "") Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Идентификатор | Строка | ID копируемого объекта |
| Файл | ДвоичныеДанные,Строка | Двоичные данные или путь к новым данным |
| НовоеИмя | Строка (необяз.) | Новое имя файла |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Идентификатор | --object | Строка | ID копируемого объекта |
| Файл | --file | ДвоичныеДанные,Строка | Двоичные данные или путь к новым данным |
| НовоеИмя | --title | Строка (необяз.) | Новое имя файла |
Вовзращаемое значение: Соответствие - сериализованный JSON ответа от Google

View File

@ -7,10 +7,10 @@ sidebar_position: 1
*Функция ПолучитьИнформациюОбОбъекте(Знач Токен, Знач Идентификатор) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Идентификатор | Строка | Идентификатор объекта |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Идентификатор | --object | Строка | Идентификатор объекта |
Вовзращаемое значение: Соответствие - сериализованный JSON ответа от Google

View File

@ -7,11 +7,11 @@ sidebar_position: 3
*Функция ПолучитьСписокФайлов(Знач Токен, Знач ИмяСодержит = "", Знач Каталог = "") Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| ИмяСодержит | Строка (необяз.) | Отбор по нахождению строки в имени файла |
| Каталог | Строка (необяз.) | ID каталога для отбора файлов |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| ИмяСодержит | --querry | Строка (необяз.) | Отбор по нахождению строки в имени файла |
| Каталог | --catalog | Строка (необяз.) | ID каталога для отбора файлов |
Вовзращаемое значение: Массив из Соответствие - массив описаний файлов

View File

@ -7,11 +7,11 @@ sidebar_position: 2
*Функция ПолучитьСписокКаталогов(Знач Токен, Знач ИмяСодержит = "", Знач Подробно = Ложь) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| ИмяСодержит | Строка (необяз.) | Отбор по нахождению строки в имени каталога |
| Подробно | Булево (необяз.) | Истина - добавляет к описанию каталога массив содержащихся в нем файлов (поле files - массив) |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| ИмяСодержит | --querry | Строка (необяз.) | Отбор по нахождению строки в имени каталога |
| Подробно | --depth | Булево (необяз.) | Добавляет к описанию каталога массив содержащихся в нем файлов |
Вовзращаемое значение: Массив из Соответствие - массив описаний каталогов

View File

@ -7,10 +7,10 @@ sidebar_position: 7
*Функция СкачатьФайл(Знач Токен, Знач Идентификатор) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Идентификатор | Строка | Идентификатор файла |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Идентификатор | --object | Строка | Идентификатор файла |
Вовзращаемое значение: ДвоичныеДанные - двоичные данные файла

View File

@ -7,12 +7,12 @@ sidebar_position: 5
*Функция СкопироватьОбъект(Знач Токен, Знач Идентификатор, Знач НовоеИмя = "", Знач НовыйРодитель = "") Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Идентификатор | Строка | ID копируемого объекта |
| НовоеИмя | Строка (необяз.) | Новое имя файла |
| НовыйРодитель | Строка (необяз.) | Новое расположение (каталог) файла |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Идентификатор | --object | Строка | ID копируемого объекта |
| НовоеИмя | --title | Строка (необяз.) | Новое имя файла |
| НовыйРодитель | --catalog | Строка (необяз.) | Новое расположение (каталог) файла |
Вовзращаемое значение: Соответствие - сериализованный JSON ответа от Google

View File

@ -7,11 +7,11 @@ sidebar_position: 8
*Функция СоздатьПапку(Знач Токен, Знач Имя, Знач Родитель = "") Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Имя | Строка | Имя нового каталога |
| Родитель | Строка | ID родительского каталога (по умолчанию - корень) |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Имя | --title | Строка | Имя нового каталога |
| Родитель | --catalog | Строка | ID родительского каталога (по умолчанию - корень) |
Вовзращаемое значение: Соответствие - сериализованный JSON ответа от Google

View File

@ -7,10 +7,10 @@ sidebar_position: 9
*Функция УдалитьОбъект(Знач Токен, Знач Идентификатор) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Идентификатор | Строка | Идентификатор объекта |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Идентификатор | --object | Строка | Идентификатор объекта |
Вовзращаемое значение: Пустой ответ

View File

@ -7,11 +7,11 @@ sidebar_position: 4
*Функция ЗагрузитьФайл(Знач Токен, Знач Файл, Знач Описание) Экспорт*
| Параметр | Тип | Назначение |
|-|-|-|
| Токен | Строка | Токен доступа |
| Файл | ДвоичныеДанные,Строка | Двоичные данные или путь к файлу |
| Описание | Соответствие | Описание файла. См. [ПолучитьОписаниеФайла](./Poluchit-opisanye-fayla) |
| Параметр | CLI | Тип | Назначение |
|-|-|-|-|
| Токен | --token | Строка | Токен доступа |
| Файл | --file | ДвоичныеДанные,Строка | Двоичные данные или путь к файлу |
| Описание | --props | Соответствие | Описание файла. См. [ПолучитьОписаниеФайла](./Poluchit-opisanye-fayla) |
Вовзращаемое значение: Соответствие - сериализованный JSON ответа от Google
@ -26,7 +26,7 @@ sidebar_position: 4
Картинка = "C:\OPI\image.jpg";
Ответ = OPI_GoogleDrive.ЗагрузитьФайл(Токен, Картинка, Описание); //Соответствие
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //Строка
```