Методы и поля iOS SDK

OZSDK

Синглтон (шаблон-одиночка) для Oz SDK.

Методы

OZSDK

Инициализирует OZSDK, используя данные лицензии. В качестве замыкания передаются либо данные о лицензии, либо LicenseError.

Возвращает

-

setLicense

Принудительно устанавливает лицензию.

setApiConnection

Запрашивает токен доступа для пользователя.

Возвращает

Токен доступа или ошибку.

setEventsConnection

Запрашивает токен доступа для отправки телеметрии.

Возвращает

Токен доступа или ошибку.

isLoggedIn

Проверяет, существует ли токен доступа.

Параметры

-

Возвращает

Результат проверки – true или false.

logout

Удаляет сохраненный токен доступа.

Параметры

-

Возвращает

-

createVerificationVCWithDelegate

Создает контроллер для проверки Liveness.

Возвращает

UIViewController или исключение.

createVerificationVC

Создает контроллер для проверки Liveness.

Возвращает

UIViewController или исключение.

cleanTempDirectory

Удаляет все видеоролики.

Параметры

-

Возвращает

-

getEventSessionId

Запрашивает идентификатор сессии телеметрии.

Параметры

-

Возвращает

Идентификатор сессии телеметрии (String).

set

Устанавливает кастомный бандл, в котором содержатся переводы строк.

Возвращает

-

setSelfieLength

Устанавливает длительность жеста Селфи (в миллисекундах).

generateSignedPayload

Создает payload с подписями медиафайлов.

Возвращает

payload для загрузки вместе с медиафайлами, для которых он был сгенерирован.

Поля

localizationCode

Язык SDK (если язык не указывается, локаль устанавливается автоматически).

host

Хост, к которому обращается система для проверки Liveness.

attemptSettings

Количество попыток выполнения анализов, после которого SDK выдаст ошибку.

version

Версия SDK.

OZLivenessDelegate

Делегат OZSDK.

Методы

onOZLivenessResult

Запрашивает результаты проверки Liveness.

Возвращает

-

onError

Обрабатывает ошибки.

Возвращает

-

AnalysisRequest

Протокол для выполнения проверок.

Методы

AnalysisRequestBuilder

Создает инстанс AnalysisRequest.

Возвращает

Инстанс AnalysisRequest.

addAnalysis

Добавляет в AnalysisRequest анализы.

Возвращает

-

uploadMedia

Загружает медиафайл(ы) на сервер.

Возвращает

-

addFolderId

Добавляет идентификатор папки для загрузки на сервер.

Возвращает

-

addFolderMeta

Добавляет в папку метаданные.

Возвращает

-

run

Запускает анализы.

Возвращает

Результат проверок или ошибку.

Customization

Настройки кастомизации OzLivenessSDK (используйте OZSDK.customization).

toolbarCustomization

Настройки кастомизации верхней панели.

centerHintCustomization

Настройки кастомизации текста подсказки, ориентируясь на который, пользователь снимает фото или видео.

hintAnimationCustomization

Настройки кастомизации для анимации подсказки.

faceFrameCustomization

Настройки кастомизации рамки вокруг лица.

backgroundCustomization

Настройки кастомизации фона за рамкой.

versionCustomization

Настройки кастомизации текста версии SDK.

antiscamCustomization

Настройки защиты от мошенников – сообщения, предупреждающего человека о том, что его снимают.

logoCustomization

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

Переменные и объекты

enum LicenseSource

Источник лицензии.

struct LicenseData

Полная информация о лицензии

enum OzVerificationMovement

Действие, представленное на видео.

enum OZLocalizationCode

Код языка SDK в соответствии с ISO 639-1.

struct OZMedia

Содержит информацию о медиафайле.

enum MediaType

Тип медиафайла.

enum OZVerificationStatus

Описание ошибки.

struct Analysis

Содержит информацию о том, какие анализы и к каким медиафайлам применять.

enum AnalysisType

Тип анализа.

В настоящее время для типа DOCUMENTS режим onDevice не поддерживается.

enum AnalysisMode

Режим анализа.

enum ScenarioState

Отображает статус обработки медиафайлов.

struct AnalysisStatus

Отображает статус загрузки файлов.

RequestStatus

Отображает промежуточный результат обработки анализов.

ResultMedia

Описывает результат анализа для одного медиафайла.

RequestResult

Сводный результат анализа для всех медиафайлов.

class AnalysisResult

Содержит результат проверок.

enum AnalyseResolutionStatus

Сводный статус по выполненным анализам.

struct AnalyseResolution

Содержит результаты одиночных анализов.

enum GeometryType

Форма рамки.

enum LicenseError

Возможные ошибки лицензирования.

enum Connection

Тип авторизации.

struct UploadMediaSettings

Настройки повторной отправки медиафайлов.

enum SizeReductionStrategy

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