FMP/ru.fsight.fmp/FMP/Builder

Builder

class Builder

Конструктор для FMP. Требуемые параметры: address, environment, project, api, deviceID, storage и username.

Since

21.04.01

See also

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
fun address(address: String): FMP.Builder

Указать URL адрес сервера FMP.

Link copied to clipboard
fun api(api: FMP.API): FMP.Builder

Указать API версию сервера.

Link copied to clipboard
fun build(): FMP

Создать FMP объект.

Link copied to clipboard
fun cert(data: ByteArray): FMP.Builder

Указать содержимое .pem файла сертификата. Требуется для проверки самоподписного сертификата на сервере.

Link copied to clipboard
fun certCheck(state: Boolean): FMP.Builder

Указать использование проверки сертификатов сервера.

Link copied to clipboard
fun connectTimeout(timeout: Long): FMP.Builder

Указать максимальное время на попытку установить соединение с сервером в миллисекундах.

Link copied to clipboard
fun debug(state: Boolean): FMP.Builder

Включить подробное логирование событий внутри фреймворка в релизной версии. В SNAPSHOT версии включено по умолчанию. Имеет приоритет над значением по умолчанию.

Link copied to clipboard
fun debugNoEncryption(state: Boolean): FMP.Builder

Отключить шифрование для отладки. Все файлы, включая БД, будут без шифрования. Только для отладки.

Link copied to clipboard
fun deviceID(id: String): FMP.Builder

Указать Device ID вручную. Device ID определяется автоматически при передаче Context в конструкторе Builder.

Link copied to clipboard
fun environment(environment: String): FMP.Builder

Указать среду на сервере FMP.

Link copied to clipboard
fun headers(headers: Map<String, String>): FMP.Builder

Указать HTTP хедеры, которые будут передаваться в каждом запросе.

Link copied to clipboard
fun locale(json: String): FMP.Builder

Указать локализацию, которая будет использоваться во фреймворке. Пример содержимого можно получить в документации. По умолчанию используется русский язык.

Link copied to clipboard
fun project(project: String): FMP.Builder

Указать проект внутри среды на сервере FMP.

Link copied to clipboard
fun readTimeout(timeout: Long): FMP.Builder

Указать максимальное время на ожидание ответа от сервера в миллисекундах.

Link copied to clipboard
fun requestTimeout(timeout: Int): FMP.Builder

Указать максимальное время на попытку соединения с сервером в секундах.

Link copied to clipboard
fun retryCount(count: Int): FMP.Builder

Указать количество повторов запросов к серверу в случае ошибок. По умолчанию 10 повторов.

Link copied to clipboard
fun retryInterval(interval: Int): FMP.Builder

fun retryInterval(interval: Long): FMP.Builder

Указать интервал между повторами запросов к серверу в миллисекундах.

Link copied to clipboard
fun storage(path: String): FMP.Builder

Указать путь к месту хранения данных фреймворка вручную. Путь определяется автоматически при передаче Context в конструкторе Builder.

Link copied to clipboard
fun strictSecurityRequirements(enable: Boolean): FMP.Builder

Активировать строгие требования к безопасности среды выполнения (устройства). На данный момент единственным требованием при активации является

Link copied to clipboard
fun username(username: String): FMP.Builder

Указать имя пользователя. Имя регистрозависимое, что влияет на изоляцию данных пользователей. Если сервер поддерживает регистронезависимую аутентификацию, то можете передавать username всегда в lowercase или uppercase.