Skip to content

arkuznetsov/nextcloud-lib

Repository files navigation

GitHub release GitHub license GitHub Releases GitHub All Releases

Build Status Quality Gate Coverage Tech debt

Checked by Silver Bulleters SonarQube BSL plugin

Библиотека работы с сервисами NextCloud

Библиотека (oscript) nextcloud-lib предоставляет интерфейс для работы с сервисом NextCloud.

Зависимости

Основной класс

Подключение = Новый ПодключениеNextCloud(http://localhost:8080, "admin", "P@$$w0rd");

Работа с файлами

Подключение = Новый ПодключениеNextCloud(http://localhost:8080, "admin", "P@$$w0rd");

Файлы = Подключение.Файлы();

Методы

Методы / Параметры
Список() Соответствие получает список файлов сервиса NextCloud в указанном каталоге
* Каталог Строка каталог для получения списка файлов
Существует() Булево проверяет существование файла/каталога на сервисе NextCloud
* ПутьКФайлу Строка путь к файлу/каталогу
ЭтоФайл() Булево проверяет что по указанному пути на сервисе NextCloud расположен файл
* ПутьКФайлу Строка путь к файлу/каталогу
ЭтоКаталог() Булево проверяет что по указанному пути на сервисе NextCloud расположен каталог
* ПутьКФайлу Строка путь к файлу/каталогу
Отправить() отправляет указанный файл в сервис NextCloud
* ПутьКФайлу Строка путь к отправляемому файлу
* ПутьДляСохранения Строка путь к каталогу для сохранения отправленного файла на сервисе NextCloud
* ИмяДляСохранения Строка имя с которым будет сохранен файл, если не указано, то будет использовано имя исходного файла
* Перезаписывать Булево Истина - если файл существует, то он будет перезаписан; Ложь - если файл существует, то будет выдано исключение
Получить() получает указанный файл из сервиса NextCloud
* ПутьКФайлу Строка путь к получаемому файлу на сервисе NextCloud
* ПутьДляСохранения Строка путь для сохранения полученного файла
* Перезаписывать Булево Истина - если файл существует, то он будет перезаписан; Ложь - если файл существует, то будет выдано исключение
Удалить() удаляет указанный файл/каталог на сервисе NextCloud
* ПутьКФайлу Строка путь к удаляемому файлу/каталогу
* ОшибкаЕслиНеСуществует Булево Истина - если файл/каталог не существует на сервере выдавать ошибку
СоздатьКаталог() создает каталог на сервисе NextCloud
* ПутьККаталогу Строка путь к создаваемому каталогу
* ОшибкаЕслиСуществует Булево Истина - если каталог уже существует на сервере выдавать ошибку

Управление пользователями

Подключение = Новый ПодключениеNextCloud(http://localhost:8080, "admin", "P@$$w0rd");

Пользователи = Подключение.Пользователи();

Методы

Методы / Параметры
Список() Массив получает список пользователей сервиса NextCloud
* СтрокаПоиска Строка строка поиска идентификатора пользователя (если не указано выводятся все существующие пользователи)
* Количество Число количество элементов в результате (если 0 - выводятся все найденные пользователи)
* Смещение Число номер страницы результата (если 0 - то с начала списка найденных пользователей)
ИзменяемыеПоля() Массив возвращает список доступных для изменения полей
ДанныеПользователя() Структура возвращает описание пользователя NextCloud
* ПользовательИд Строка идентификатор пользователя NextCloud
Добавить() добавляет пользователя NextCloud
* ПользовательИд Строка идентификатор пользователя NextCloud
* ПользовательПароль Строка пароль пользователя NextCloud
* ПараметрыПользователя Структура параметры пользователя NextCloud
ИзменитьЗначениеПоля() изменяет значение указанного поля пользователя NextCloud
* ПользовательИд Строка идентификатор пользователя NextCloud
* Поле Строка имя поля пользователя NextCloud
* Значение Строка новое значение поля пользователя NextCloud
ИзменитьАктивность() изменяет активность пользователя NextCloud
* ПользовательИд Строка идентификатор пользователя NextCloud
* Активность Булево Истина - включить пользователями; Ложь - отключить пользователя
Удалить() удаляет пользователя NextCloud
* ПользовательИд Строка идентификатор пользователя NextCloud
ГруппыПользователя() возвращает список групп пользователя NextCloud
* ПользовательИд Строка идентификатор пользователя NextCloud
ДобавитьПользователяВГруппу() добавляет пользователя NextCloud в группу пользователей
* ПользовательИд Строка идентификатор пользователя NextCloud
* ГруппаИд Строка идентификатор группы пользователей NextCloud
УдалитьПользователяИзГруппы() удаляет пользователя NextCloud из группы пользователей
* ПользовательИд Строка идентификатор пользователя NextCloud
* ГруппаИд Строка идентификатор группы пользователей NextCloud
АдминистрируемыеГруппыПользователя() возвращает список групп, где пользователь является администратором
* ПользовательИд Строка идентификатор пользователя NextCloud
ДобавитьПользователяВАдминистраторыГруппы() добавляет пользователю права администратора группы
* ПользовательИд Строка идентификатор пользователя NextCloud
* ГруппаИд Строка идентификатор группы пользователей NextCloud
УдалитьПользователяИзАдминистраторовГруппы() отключает пользователю права администратора группы
* ПользовательИд Строка идентификатор пользователя NextCloud
* ГруппаИд Строка идентификатор группы пользователей NextCloud
ОтправитьПриветственноеПисьмо() выполняет отправку приветственного письма пользователю
* ПользовательИд Строка идентификатор пользователя NextCloud

Управление группами пользователей

Подключение = Новый ПодключениеNextCloud(http://localhost:8080, "admin", "P@$$w0rd");

Группы = Подключение.ГруппыПользователей();

Методы

Методы / Параметры
Список() Массив получает список групп пользователей сервиса NextCloud
* СтрокаПоиска Строка строка поиска идентификатора группы пользователей (если не указано выводятся все существующие группы)
* Количество Число количество элементов в результате (если 0 - выводятся все найденные группы)
* Смещение Число номер страницы результата (если 0 - то с начала списка найденных групп)
Добавить() добавляет группу пользователей NextCloud
* ГруппаИд Строка идентификатор группы пользователей NextCloud
Удалить() удаляет группу пользователей NextCloud
* ГруппаИд Строка идентификатор группы пользователей NextCloud
ПользователиГруппы() Массив возвращает список пользователей группы пользователей NextCloud
* ГруппаИд Строка идентификатор группы пользователей NextCloud
АдминистраторыГруппы() Массив возвращает список администраторов группы пользователей NextCloud
* ГруппаИд Строка идентификатор группы пользователей NextCloud