FMPWeb

Описание

Класс FMPWeb предназначен для описания запроса к веб-ресурсу.

class FMPWeb

Свойства

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

httpMethod

 Метод HTTP. 
var httpMethod: HTTPMethod { get }

isKerberosAuth

 Использование типа аутентификации Kerberos для источника данных. 
var isKerberosAuth: Bool { get }

path

 Путь URI. 
var path: String? { get }

queryParams

 Параметры строки запроса. 
var queryParams: QueryParameters? { get }
resource Веб-ресурс, к которому строится запрос. 
var resource: FMPResource? { get }

webAuthentication

 Значение для аутентификации пользователя API в источнике данных. 
var webAuthorization: String? { get }

Методы

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

copy()

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

request(completion:)

 Отправка запроса к веб-ресурсу. 
func request(completion: @escaping (RequestResult) -> Void)

Параметры:

  • completion. Замыкающее выражение, содержащее результат выполнения метода.

Псевдонимы типов

Псевдоним типа Описание
QueryParameters Тип параметров строки запроса. Используется свойством queryParams. 
typealias QueryParameters = [String : AnyHashable]
RequestResult Результат запроса к веб-ресурсу. Используется методом request(completion:). 
typealias RequestResult = Result<Data, Error>

Примеры

Отправка запроса к веб-ресурсу:

// Построим экземпляр класса FMPWeb
let web: FMPWeb = fmp.web.build()
 
// Отправим запрос к веб-ресурсу
web.request() { (result) in
    switch result {
    case .success(let data):
    // Успешный запрос к веб-ресурсу
    case .failure(let error):
        // Выведем код и описание ошибки
        print((error as? FMPError)?.code, (error as? FMPError)?.description)
    }
}

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

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

См. также:

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