FMPWeb.Builder

Описание

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

class Builder

Методы

Метод Описание
build() Построение экземпляра класса FMPWeb. Возвращает объект типа FMPWeb. 
func build() -> FMPWeb
httpMethod(_:) Сохранение метода HTTP в переменную. 
func httpMethod(_ method: FMPWeb.HTTPMethod) -> Builder

Параметры:

  • method . Метод HTTP.
isKerberosAuth(_:) Сохранение признака использования типа аутентификации Kerberos для источника данных в переменную. 
func isKerberosAuth(_ isKerberosAuth: Bool = true) -> Builder

Параметры:

  • isKerberosAuth. Признак использования типа аутентификации Kerberos для источника данных.
path(_:) Сохранение пути URI в переменную. 
func path(_ path: String?) -> Builder

Параметры:

  • path. Путь URI.
queryParams(_:) Сохранение параметров строки запроса в переменную. 
func queryParams(_ params: FMPWeb.QueryParameters?) -> Builder

Параметры:

  • params. Параметры строки запроса.
resource(_:) Сохранение веб-ресурса, к которому строится запрос, в переменную. 
func resource(_ resource: FMPResource?) -> Builder

Параметры:

  • resource. Веб-ресурс, к которому строится запрос.
webAuthentication(_:) Сохранение в переменной значения для аутентификации пользователя API в источнике данных. 
func webAuthorization(_ webAuthValue: String?) -> Builder

Параметры:

  • webAuthValue. Значение для аутентификации пользователя API в источнике данных.

Пример

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

// Построим экземпляр класса FMPResource
let resource: FMPResource = fmp.resource.build()
 
// Построим экземпляр класса FMPWeb с различными настройками
let web: FMPWeb = fmp.web
    .httpMethod(.post) // По умолчанию FMPWeb.HTTPMethod.get
    .resource(resource) // По умолчанию nil
    .path(path) // По умолчанию nil
    .queryParams(["key" : "value"]) // По умолчанию nil
    .webAuthorization(webAuthorization) // По умолчанию nil
    .isKerberosAuth(isKerberosAuth) // По умолчанию false
    .build()

См. также:

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