FMPFile

Описание

Интерфейс FMPFile предназначен для работы с файлами.

interface FMPFile: FMPObject

Свойства

Свойство Описание
name Имя файла или директории. 
val name: String

remotePath

 Относительный путь к файлу или директории на сервере. 
val remotePath: String
localPath Полный путь к файлу или директории в локальной файловой системе. 
val localPath: String
mount Имя подключения к хранилищу на сервере. 
val mount: String
depth Глубина поиска и загрузки при работе с директориями. 
val depth: String
isDirectory Определение использования файла или директории. 
val isDirectory: Boolean

Значение true - директория, false - файл.

Методы

Метод Описание

ls

 Получение содержимого директории. Рекурсивно проходится по содержимому директории, получая список дочерних элементов. Для файла возвращает значение «null». 
fun ls(): List<FMPFile>
download Загрузка файла или содержимого директории с сервера на устройство. Загружает с сервера файл или содержимое директории с указанной глубиной и сохраняет по указанному пути в локальной директории приложения на устройстве. Если свойство key экземпляра FMPFile не является пустой строчкой, файлы шифруются с этим ключом. 
fun download(): Boolean
upload Загрузка файла с устройства на сервер. Загружает на сервер файл, находящийся по указанному пути в локальной директории файловой системы. Если свойство key экземпляра FMPFile не является пустой строчкой, файлы перед отправкой расшифровываются с этим ключом. Для директории возвращает ошибку. 
fun upload(): Boolean
deleteRemote Удаление файла на сервере. Для директории возвращает ошибку. 
fun deleteRemote(): Boolean
getMeta Запрос метаданных файла с сервера. Для директории возвращает ошибку. 
fun getMeta(): Meta
isExist Запрос на проверку существования файла на сервере. Для директории возвращает ошибку. 
fun isExist(): Boolean
search Рекурсивный поиск в дочерних элементах по имени файла или директории. Поиск производится по условию содержания параметра search в имени файла/директории. При вызове метода перед поиском производится получение списка дочерних элементов. 
fun search(search: String, ignoreCase: Boolean): List<FMPFile>

Параметры:

  • search. Условие поиска по имени файла или директории;

  • ignoreCase. Если true, то регистр букв игнорируется при поиске. Если false - регистр букв не игнорируется.
search Рекурсивный поиск в дочерних элементах по имени файла или директории. Поиск производится по условию соответствия имени файла/директории регулярному выражению. При вызове метода перед поиском производится получение списка дочерних элементов. 
fun search(regex: Regex): List<FMPFile>

Параметры:

  • regex. Регулярное выражение для поиска по имени файла или директории.
encryptToFile Шифрование файла в локальной директории файловой системы в файл. 
fun encryptToFile(path: String): Boolean

Параметры:

  • path. Полный путь в локальной файловой системе, где будет размещён зашифрованный файл.
decryptToFile Расшифровка файла в локальной директории файловой системы в файл. 
fun decryptToFile(path: String): Boolean

Параметры:

  • path. Полный путь в локальной файловой системе, где будет размещён расшифрованный файл.
encryptToByte Шифрование файла в локальной директории файловой системы в байтовый буфер. Возвращает зашифрованный байтовый буфер. 
fun encryptToByte(): FMPData
decryptToByte Расшифровка файла в локальной директории файловой системы в байтовый буфер. Возвращает расшифрованный байтовый буфер. 
fun decryptToByte(): FMPData
deleteLocal Удаление файла или папки из локальной файловой системы. 
fun deleteLocal(): Boolean

Методы, унаследованные от интерфейса FMPObject

Метод Описание
toJSON Сериализация объекта в JSON. 
fun toJSON(): String
copy Получение экземпляра конструктора для копирования интерфейса. Возвращает экземпляр в виде: <название интерфейса>.Builder. 
fun copy(): Builder
equals Сравнивает объекты между собой по ключевым параметрам. Например, два FMPUser одинаковы, если имеют одинаковый логин. 
fun equals(other: Any?): Boolean

Параметры:

  • other. Любой другой объект.
hashCode Выдает хэш-код на основе ключевых параметров. 
fun hashCode(): Int
toString Выводит основную информацию об объекте в не сериализованном виде. Для сериализации используйте метод toJSON(). 
fun toString(): String

См. также:

Фреймворк FMP | Интерфейсы