Описание методов iOS-фреймворка

HHFWController.sharedInstance().auth(_ login: String, password: String, handler: HHFWCompletionHandler? = nil)

let userName: String = "user"
let password: String = "password"
 
HHFWController.sharedInstance().auth(userName, password: password){ (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит статус аутентификации, описание ошибок и другую информацию
    // Также в этом блоке можно открыть соединение с базой данных
}

HHFWController.sharedInstance().auth(_ login: String, password: String, newPassword: String, confirmPassword confirm: String, handler: HHFWCompletionHandler? = nil)

let userName: String = "user"
let password: String = "password"
let newPassword: String = "newPassword"
let confirmPassword: String = "newPassword"
 
HHFWController.sharedInstance().auth(userName, password: password, newPassword: newPassword, confirmPassword: confirmPassword){ (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит статус аутентификации, описание ошибок и другую информацию    
    // Также в этом блоке можно открыть соединение с базой данных
}

HHFWController.sharedInstance().unAuth()

HHFWController.sharedInstance().connectionStatus(_ host: String, handler: HHFWCompletionHandler? = nil)

let host: String = "https://<IP-адрес или DNS-имя сервера>"

 
HHFWController.sharedInstance().connectionStatus(host){ (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит статус аутентификации, описание ошибок и другую информацию
    // Также в этом блоке можно открыть соединение с базой данных
}

HHFWController.sharedInstance().openBase(_ pathBase: String, key: String) -> Bool

let paths: [URL] = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)
let fullDatabaseURL: URL = paths[0].appendingPathComponent("database.sqlite")
let databaseKey: String = "key" // если шифрование не нужно, то key = ""
 
let success = HHFWController.sharedInstance().openBase(fullDatabaseURL.path, key: databaseKey)

HHFWController.sharedInstance().rekeyBase(_ pathBase: String, newKey key: String) -> Bool

let databaseName: String = "database.sqlite"
let newKey: String = "newKey"
 
HHFWController.sharedInstance().rekeyBase("/Documents/\(databaseName)", newKey: newKey)

HHFWController.sharedInstance().query(_ base: String?, query: String) -> String?

let jsonResult: String? = HHFWController.sharedInstance().query("/Documents/\(databaseName)", query: "SELECT * FROM TableNameInDatabase WHERE `key` = 'value'")

HHFWController.sharedInstance().getTablesName(_ databasePath: String, resourceName resource: String, requestParams params: String, tableName table: String?) -> String?

let databaseName: String = "database.sqlite"
let resourceName: String = "ResourceName"
let params: String = "{}"
let tableName: String = "TableName"
let jsonResult: String! = HHFWController.sharedInstance().getTablesName("/Documents/\(databaseName)", resourceName: resourceName, requestParams: "", tableName: tableName)

HHFWController.sharedInstance().dropCache(_ databasePath: String, resourceName resource: String, requestParams params: String) -> String?

let databaseName: String = "database.sqlite"
let resourceName: String = "ResourceName"
let params: String = "{}"
let jsonResult: String! = HHFWController.sharedInstance().dropCache("/Documents/\(databaseName)", resourceName: resourceName, requestParams: params)

HHFWController.sharedInstance().dropCache()

HHFWController.sharedInstance().closeBase(_ pathBase: String) -> Bool

HHFWController.sharedInstance().resources(_ database: String?, handler: HHFWCompletionHandler? = nil)

let databaseName: String = "database.sqlite"
 
HHFWController.sharedInstance().resources(databaseName){ (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе схемы, ответ сервера и саму схему ресурсов
}

HHFWController.sharedInstance().deltaStream(_ resourseName: String, deltaStreamCallParams: DeltaStreamCallParams?, handler: HHFWCompletionHandler? = nil)

let deltaStreamCallParams: DeltaStreamCallParams = DeltaStreamCallParams(defaultDb: ())
deltaStreamCallParams?.dataBasePath = fullDatabaseURL.path
let resourceName: String = "ResourceName" // название ресурса
 
HHFWController.sharedInstance().deltaStream(resourceName, deltaStreamCallParams: deltaStreamCallParams){ (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().deltaStreamAsync(resourceName: String, withCache: Bool, deltaStreamCallParams: DeltaStreamCallParams?, handler: HHFWCompletionHandler? = nil)

let deltaStreamCallParams: DeltaStreamCallParams = DeltaStreamCallParams(defaultDb: ())
deltaStreamCallParams?.dataBasePath = fullDatabaseURL.path
let resourceName: String = "ResourceName" // название ресурса
let isCached: Bool = true
 
HHFWController.sharedInstance().deltaStreamAsync(resourceName, withCache: isCached, deltaStreamCallParams: deltaStreamCallParams){ (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().tableStream(_ resourseName: String, transactionID: String?, tableCallParams: RequestCallParams?, handler: HHFWCompletionHandler? = nil)

let requestCallParams: RequestCallParams = RequestCallParams(defaultDb: ())
requestCallParams?.dataBasePath = fullDatabaseURL.path
let resourceName: String = "ResourceName" // название ресурса
 
HHFWController.sharedInstance().tableStream(resourceName, withCache: isCached, transactionID: nil, tableCallParams: requestCallParams){ (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json   
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

let requestCallParams: RequestCallParams = RequestCallParams(defaultDb: ())
requestCallParams?.dataBasePath = fullDatabaseURL.path
requestCallParams?.args = ["col_columnName1": value1, "col_columnName2": value2, ...]

HHFWController.sharedInstance().tableStreamAsync(_ resourseName: String, withCache: Bool, transactionID: String, tableCallParams: RequestCallParams?, handler: HHFWCompletionHandler? = nil)

let requestCallParams: RequestCallParams = RequestCallParams(defaultDb: ())
requestCallParams?.dataBasePath = fullDatabaseURL.path
let resourceName: String = "ResourceName" // название ресурса
 
HHFWController.sharedInstance().tableStreamAsync(resourceName, withCache: isCached, transactionID: nil, tableCallParams: requestCallParams){ (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().table(_ resourseName: String, transactionID: String?, tableCallParams: TableCallParams?, handler: HHFWCompletionHandler? = nil)

let tableCallParams: TableCallParams = TableCallParams(defaultProperty: ())
 
HHFWController.sharedInstance().table(resourceName, transactionID: nil, tableCallParams: tableCallParams){ (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().tableAsync(_ resourseName: String, transactionID: String, tableCallParams: TableCallParams?, handler: HHFWCompletionHandler? = nil)

let tableCallParams: TableCallParams = TableCallParams(defaultProperty: ())
 
HHFWController.sharedInstance().tableAsync(resourceName, transactionID: nil, tableCallParams: tableCallParams){ (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().request(_ resourseName: String, requestCallParams: RequestCallParams?, handler: HHFWCompletionHandler? = nil)

let requestCallParams: RequestCallParams = RequestCallParams(defaultProperty: ())
 
HHFWController.sharedInstance().request(resourceName, requestCallParams: requestCallParams){ (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().requestAsync(_ resourseName: String, requestCallParams: RequestCallParams?, handler: HHFWCompletionHandler? = nil)

let requestCallParams: RequestCallParams = RequestCallParams(defaultProperty: ())
 
HHFWController.sharedInstance().requestAsync(resourceName, requestCallParams: requestCallParams){ (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().useDownload(_ val: Bool)

let path = self.getURL(forFolder: "DownloadPath").path
HHFWController.sharedInstance().setDownloadPath(path)
HHFWController.sharedInstance().useDownload(true)
 
let requestCallParams: RequestCallParams = RequestCallParams(defaultDb: ())
requestCallParams?.dataBasePath = fullDatabaseURL.path
requestCallParams?.retryCount = 10
requestCallParams?.retryIntervalSec = 1
 
let resourceName: String = "ResourceName" // название ресурса
let isCached: Bool = true
 
HHFWController.sharedInstance().tableStream(resourceName, withCache: isCached, transactionID: nil, tableCallParams: requestCallParams){ (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json   
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().setDownloadPath(_ path: String)

let path = downloadFileURL.path
HHFWController.sharedInstance().setDownloadPath(path)

HHFWController.sharedInstance().getTokens(_ handler: HHFWCompletionHandler? = nil)

HHFWController.sharedInstance().getTokens() { (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().addToken(_ token: String, service: String, completionHandler handler: HHFWCompletionHandler? = nil)

let token: String = "DeviceToken" // получаем в ходе регистрации для remote-уведомлений
let service: String = "apns"
 
HHFWController.sharedInstance().addToken(token, service: service) { (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().removeTokens(_ tokens: NSMutableArray, completionHandler handler: HHFWCompletionHandler? = nil)

let tokens: [String] = [token1, token2, ...] // наименования тем сообщений
 
HHFWController.sharedInstance().removeTokens(tokens) { (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().getTopics(_ handler: HHFWCompletionHandler? = nil)

HHFWController.sharedInstance().getTopics { (jsonResult) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().subscribeTopics(_ topics: NSMutableArray, completionHandler handler: HHFWCompletionHandler? = nil)

let topics: [String] = [topic1, topic2, ...] // наименования тем сообщений
 
HHFWController.sharedInstance().subscribeTopics(topics) { (jsonResult) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().unsubscribeTopics(_ topics: NSMutableArray, completionHandler handler: HHFWCompletionHandler? = nil)

let topics: [String] = [topic1, topic2, ...] // наименования тем сообщений
 
HHFWController.sharedInstance().unsubscribeTopics(topics) { (jsonResult) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().getDirectory(_ directory: String, mountName: String, completionHandler handler: HHFWCompletionHandler? = nil)

let directory: String = "DirectoryName"
let mountName: String = "MountName"
 
HHFWController.sharedInstance().getDirectory(directory, mountName: mountName) { (jsonResult) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().getFileMeta(_ filename: String, mountName: String, completionHandler handler: HHFWCompletionHandler? = nil)

let fileName: String = "FileName"
let mountName: String = "MountName"
 
HHFWController.sharedInstance().getFileMeta(fileName, mountName: mountName) { (jsonResult) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().getFile(_ filename: String, fromServerPath serverFileName: String, mountName: String, password: String, completionHandler handler: HHFWCompletionHandler? = nil)

let fileName: String = "FileName" // путь к файлу в директории мобильного приложения
let serverFileName: String = "ServerFileName" // путь к файлу на сервере мобильной платформы
let mountName: String = "MountName" // название подключения к файловому серверу
let fileKey: String = "FileKey" // ключ шифрования файла
  
HHFWController.sharedInstance().getFile(fileName, fromServerPath: serverFileName, mountName: mountName, password: fileKey) { (jsonResult) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json   
    // «jsonResult» содержит информацию о запросе, ответ сервера мобильной платформы и сам результат запроса
}

HHFWController.sharedInstance().putFile(_ filename: String, toServerPath serverFileName: String, mountName: String, password: String, completionHandler handler: HHFWCompletionHandler? = nil)

let fileName: String = "FileName" // путь к файлу в директории мобильного приложения
let serverFileName: String = "ServerFileName" // путь к файлу на сервере мобильной платформы
let mountName: String = "MountName" // название подключения к файловому серверу
let fileKey: String = "FileKey" // ключ расшифровки файла
  
HHFWController.sharedInstance().putFile(fileName, toServerPath: serverFileName, mountName: mountName, password: fileKey) { (jsonResult) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json   
    // «jsonResult» содержит информацию о запросе, ответ сервера мобильной платформы и сам результат запроса
}

HHFWController.sharedInstance().decryptFile(_ filename: String, toFile decryptedFilename: String, withPassword password: String)

let fileName: String = "FileName"
let fileKey: String = "FileKey"
let decryptedFilename: String = "DecryptedFilename"
 
HHFWController.sharedInstance().decryptFile(fileName, toFile: decryptedFilename, withPassword: fileKey)

HHFWController.sharedInstance().decryptFileToString(_ filename: String, withPassword password: String) -> String

let fileName: String = "FileName"
let fileKey: String = "FileKey"
 
let decryptString: String = HHFWController.sharedInstance().decryptFileToString(fileName, withPassword: fileKey)

HHFWController.sharedInstance().decryptFileToData(_ filename: String, withPassword password: String) -> Data

let fileName: String = "FileName"
let fileKey: String = "FileKey"
 
let decryptData: Data = HHFWController.sharedInstance().decryptFileToData(fileName, withPassword: password)

HHFWController.sharedInstance().deleteFile(_ filename: String, mountName: String, completionHandler handler: HHFWCompletionHandler? = nil)

let fileName: String = "FileName"
let mountName: String = "MountName"
 
HHFWController.sharedInstance().deleteFile(fileName, mountName: mountName) { (jsonResult) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().getAllTransactionResourceName(_ name: String, completionHandler handler: HHFWCompletionHandler? = nil)

HHFWController.sharedInstance().getAllTransactionResourceName(resourceName, completionHandler: { (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().getTransaction(_ transactionID: String, resourceName name: String, completionHandler handler: HHFWCompletionHandler? = nil)

let transactionID: String = UUID().uuidString
let tableCallParams: TableCallParams = TableCallParams(defaultProperty: ())
 
HHFWController.sharedInstance().table(resourceName, transactionID: transactionID, tableCallParams: tableCallParams, handler: {(jsonResult) in
    // Получение ответа на запрос по transactionID
    HHFWController.sharedInstance().getTransaction(transactionID, resourceName: resourceName, completionHandler: { (jsonResult: Any?) in
        // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
        // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
    })
})

HHFWController.sharedInstance().retryTable(_ resuurceName: String, transactionID: String?, tableCallParams: TableCallParams?, handler: HHFWCompletionHandler? = nil)

let tableCallParams: TableCallParams = TableCallParams(defaultProperty: ())
 
HHFWController.sharedInstance().retryTable(resourceName, transactionID: transactionID, tableCallParams: tableCallParams){ (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса}

HHFWController.sharedInstance().deleteTransaction(_ transactionID: String, resourceName name: String, completionHandler handler: HHFWCompletionHandler? = nil)

let transactionID: String = "c4f64acd-7e0f-4bd7-ba32-9a15271f3eb4"
 
HHFWController.sharedInstance().deleteTransaction(transactionID, resourceName: resourceName, completionHandler: { (jsonResult: Any?) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
})

HHFWController.sharedInstance().getCertificatesWithPassword(_ password: String, completionHandler handler: HHFWCompletionHandler? = nil)

let dssPassword: String = "DSSPassword"
 
HHFWController.sharedInstance().getCertificatesWithPassword(dssPassword) { (jsonResult) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().signs(completionHandler handler: HHFWCompletionHandler? = nil)

HHFWController.sharedInstance().signs { (jsonResult) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().signCertificate(withResource resource: String, table: String, params requestParams: String, column: String, hhiveId: String, password: String, certificateId: String, certificatePin: String, completionHandler handler: HHFWCompletionHandler? = nil)

let resourceName: String = "ResourceName"
let tableName: String = "TableName"
let params: String = "{key1: value1, key2: value2, ...}"
let column: String = "ColumnName"
let hhiveId: String = "HhiveId"
let dssPassword: String = "DSSPassword"
let certificateId: String = "CertificateId"
let certificatePin: String = "CertificatePin"
 
HHFWController.sharedInstance().signCertificate(
    withResource: resourceName,
    table: tableName,
    params: params,
    column: column,
    hhiveId: hhiveId,
    password: dssPassword,
    certificateId: certificateId,
    certificatePin: certificatePin
) { (jsonResult) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().remove(withSignId signId: Int, completionHandler handler: HHFWCompletionHandler? = nil)

let signatureID: Int = 1
 
HHFWController.sharedInstance().remove(withSignId: signatureId) { (jsonResult) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().request(_ resourseName: String, requestCallParams: RequestCallParams?, handler: HHFWCompletionHandler? = nil)

let resourceName: String = "WebResourceName"
let requestCallParams: RequestCallParams = RequestCallParams(defaultProperty: ())
 
//  Для POST-запроса
requestCallParams?.data = "{}"
HHFWController.sharedInstance().request(resourceName, requestCallParams: requestCallParams) { (jsonResult) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().request(_ resourseName: String, requestCallParams: RequestCallParams?, handler: HHFWCompletionHandler? = nil)

let resourceName: String = "FAPResourceName"
let requestCallParams: RequestCallParams = RequestCallParams(defaultProperty: ())
 
requestCallParams?.data = "{}"
HHFWController.sharedInstance().request(resourceName, requestCallParams: requestCallParams) { (jsonResult) in
    // В данном блоке можно обработать ответ с сервера мобильной платформы «jsonResult», который представлен в виде json    
    // «jsonResult» содержит информацию о запросе, ответ сервера и сам результат запроса
}

HHFWController.sharedInstance().setLogLevel(_ level: Int32)

let logLevel: Int32 = 1
 
HHFWController.sharedInstance().setLogLevel(logLevel)

HHFWController.sharedInstance().setLogEnabled(_ enabled: Bool)

let isDebugMode: Bool = true
 
HHFWController.sharedInstance().setLogEnabled(isDebugMode)