FMPFile.Builder

Описание

Класс FMPFile.Builder является строителем для класса FMPFile.

class Builder

Методы

Метод Описание
build() Построение экземпляра класса FMPFile. Возвращает объект типа FMPFile. 
func build() -> FMPFile
depth(_:) Сохранение глубины при работе с директорией в переменную. 
func depth(_ depth: Int) -> Builder

Параметры:

  • depth. Глубина при работе с директорией. По умолчанию параметр принимает значение «-1».
isDirectory(_:) Сохранение в переменную типа - файл или директория. 
func isDirectory(_ isDirectory: Bool = true) -> Builder

Параметры:

  • isDirectory. Если true, то устанавливается тип directory. Если false - устанавливается тип file. По умолчанию параметр принимает значение false.
mount(_:) Сохранение в переменную имени подключения к хранилищу на сервере. 
func mount(_ mount: String) -> Builder

Параметры:

  • mount. Имя подключения к хранилищу на сервере.
localPath(_:) Сохранение в переменную пути к файлу или директории в локальной директории приложения относительно папки Documents. 
func localPath(_ path: String) -> Builder

Параметры:

  • path. Путь к файлу или директории в локальной директории приложения относительно папки Documents. По умолчанию используется путь <currentDirectoryPath>/files/<mount>/<remotePath>,  где currentDirectoryPath - путь к директории с данными текущего пользователя. Если mount и remotePath не указаны, то используется пустая строка.

Примечание. Для хранения загруженных файлов с сервера мобильной платформы используйте директорию текущего пользователя, которую можно получить с помощью свойства currentDirectoryURL экземпляра класса FMP.

remotePath(_:)

 Сохранение в переменную пути к файлу или директории на сервере. По умолчанию используется корневая директория «.». 
func remotePath(_ path: String) -> Builder

Параметры:

  • path. Путь к файлу или директории на сервере. Путь должен начинаться с «./» или равен «.».

Пример

Построение экземпляра класса FMPFile:

let file: FMPFile = fmp.file
    .remotePath("remotePath") // По умолчанию "."
    .mount("mount") // По умолчанию "local_storage"
    .isDirectory() // По умолчанию false
    .localPath("localPath") // По умолчанию ""
    .depth(2) // По умолчанию -1
    .build()

См. также:

Фреймворк FMPKit | Классы