FMP

Описание

Класс FMP является фабрикой для создания различных объектных моделей фреймворка.

class FMP

Вычисляемые свойства

Свойство Описание

connection

 Объект-строитель для класса FMPConnection. 
var connection: FMPConnection.Builder { get }
currentDirectoryURL Путь к папке с данными текущего пользователя в локальной директории устройства. 
var currentDirectoryURL: URL? { get }
file Объект-строитель для класса FMPFile. 
var file: FMPFile.Builder { get }
log Объект-строитель для класса FMPLog. 
var log: FMPLog.Builder { get }
push Объект-строитель для класса FMPPush. 
var push: FMPPush.Builder { get }
query Объект-строитель для класса FMPQuery. 
var query: FMPQuery.Builder { get }
resource Объект-строитель для класса FMPResource. 
var resource: FMPResource.Builder { get }
scheme Объект-строитель для класса FMPScheme. 
var scheme: FMPScheme.Builder { get }
table Объект-строитель для класса FMPTable. 
var table: FMPTable.Builder { get }
transaction Объект-строитель для класса FMPTransaction. 
var transaction: FMPTransaction.Builder { get }
user Объект-строитель для класса FMPUser. 
var user: FMPUser.Builder { get }
version Текущая версия фреймворка. 
var version: String { get }
web Объект-строитель для класса FMPWeb. 
var web: FMPWeb.Builder { get }

Методы

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

copy()

 Получение экземпляра класса-строителя для копирования FMP. Возвращает экземпляр класса-строителя FMP.Builder. 
func copy() -> FMP.Builder

reEncrypt(withKey:)

 Перешифровка баз данных и файлов, созданных в локальной директории приложения с помощью методов фреймворка. 
func reEncrypt(withKey newEncryptionKey: String) throws -> Bool

Параметры:

  • newEncryptionKey. Ключ шифрования баз данных и файлов.

Примечание.  Во избежание ошибок в процессе перешифровки файлы должны быть свободны от каких-либо процессов.

Примеры

Инициализация объектов:

// Получим экземпляр класса FMP
let fmp: FMP = FMP.Builder().build()
 
// Получим экземпляр класса FMPUser
let user: FMPUser = fmp.user
    .login()
    ...
    .build()

Получение версии фреймворка:

// Получим экземпляр класса FMP
let fmp: FMP = FMP.Builder().build()
  
// Получим версию фреймворка
let version: String = fmp.version // "v 23.05.01"

Получение пути к директории с данными текущего пользователя:

// Получим экземпляр класса FMP
let fmp: FMP = FMP.Builder().build()
 
// Получим путь к директории с данными текущего пользователя
let currentDirectoryURL: URL? = fmp.currentDirectoryURL // URL(string: "../app_path/Documents/user/")

Копирование экземпляра класса FMP:

// Построим экземпляр класса FMP
let fmp: FMP = FMP.Builder().build()
 
// Скопируем экземпляр класса FMP
let fmpCopy: FMP = fmp.copy().build()

Перешифровка баз данных и файлов:

// Построим экземпляр класса FMP
let fmp: FMP = FMP.Builder().build()
  
// Перешифруем базы данных и файлы
do {
    try fmp.reEncrypt(withKey: "newKey")
} catch let error {
    // Выведем код и описание ошибки
    print((response.error as? FMPError)?.code, (response.error as? FMPError)?.description)
}

См. также:

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