Методы для инициализации

initialization

Метод инициализации SDK.

Нужно вызывать после получения ответа пользователя на отслеживание IDFA/IDFV

Нужно вызывать только в Main потоке

Swift
Mindbox.shared.initialization(configuration: MBConfiguration)

notificationsRequestAuthorization

Метод передачи в SDK статуса разрешения на уведомления

Code
Mindbox.shared.notificationsRequestAuthorization(granted: Bool)

apnsTokenUpdate

Метод передачи в SDK полученного APNS токена

Вызывается в методе didRegisterForRemoteNotificationsWithDeviceToken в AppDelegate

Swift
Mindbox.shared.apnsTokenUpdate(deviceToken: deviceToken)

registerBGTasks

Метод регистрации фоновых задач для iOS 13 и выше

Вызывается в методе didFinishLaunchingWithOptions в AppDelegate

Swift
if #available(iOS 13.0, *) {
  Mindbox.shared.registerBGTasks()
}
UIApplication.shared.setMinimumBackgroundFetchInterval(UIApplication.backgroundFetchIntervalMinimum)

Получение данных от SDK

getDeviceUUID

Метод вызывает переданный колбек со значением DeviceUUID, который используется для работы SDK

Возвращает идентификатор, который можно использовать для отписки от колбека

Code
public func getDeviceUUID(_ completion: @escaping (String) -> Void)

sdkVersion

Свойство, в котором хранится текущая версия SDK.

Пример
Mindbox.shared.sdkVersion

isMindboxPush (since 2.8.3)

Метод принимает в качестве параметра UNNotification

Возвращает значение true/false, в зависимости от того пришло пуш-уведомление от Mindbox или нет.

Code
public func isMindboxPush(notification: UNNotification) -> Bool

getMindboxPushData (since 2.8.3)

Метод принимает в качестве параметра UNNotification

Возвращает опциональную модель MBPushNotification если пуш-уведомление пришло от Mindbox. В ином случае вернется nil

Code
public func getMindboxPushData(notification: UNNotification) -> MBPushNotification?

getAPNSToken

Метод вызывает переданный колбек со значением APNS токена, который сохранен в SDK
Возвращает идентификатор, который можно использовать для отписки от колбека.

Code
public func getAPNSToken(_ completion: @escaping (String) -> Void)

Передача статистики по пушу

pushClicked

Метод передачи факта клика по пуш уведомления.
Принимает либо целиком объект нотификации, либо строки уникальных ключей.
В случае клика на тело пуша надо передать только строку uniqueKey. Если был клик по кнопке, то uniqueKey и buttonUniqueKey (той кнопки, на которую кликнул пользователь)

Принимает 3 варианта аргументов:

• response: <#T##UNNotificationResponse#>
• uniqueKey: <#T##String#>
• uniqueKey: <#T##String#>, buttonUniqueKey: <#T##String?#>

Code
Mindbox.shared.pushClicked( )

Передача событий

Передача событий в Mindbox происходит через выполнение операций, заведенных в административном разделе. Операции можно выполнять в 2 режимах:

• асинхронно - API Mindbox отвечает 200 сразу, как получил данные. Обработка данных происходит в фоновом режиме
• синхронно - API Mindbox начинает обрабатывать запрос в момент получения и отвечает актуальным статусом обработки

Подробное описание передачи событий через iOS SDK

executeAsyncOperation

Метод выполнения операции в асинхронном режиме.

Swift
Mindbox.shared.executeAsyncOperation(
  operationSystemName: "<системное имя операции>",
  operationBody:  <тело запроса>
)

executeSyncOperation

Метод для выполнения операции в синхронном режиме. Данные возвращаются в переданные колбеки

Code
public func executeSyncOperation<T>(
  operationSystemName: "<системное имя операции>",
  operationBody: <тело запроса>,
  completion: @escaping (Result<OperationResponse, MindboxError>) -> Void
) where T: OperationBodyRequestType {}

Управление логированием

Для управления уровнем логирования во время разработки вы можете установить нужное значение в параметр logger

Принимаемые значения:

• debug - 🪲
• info - ℹ️
• default - 💡
• error - ‼️
• fault - ⚠️
• none

Swift
Mindbox.logger.logLevel = .error

Mindbox.logger.log()

Специальная функция для отображения данных через наш логгер. Используйте ее, если вам нужно залогировать что-то относящееся к работе Mindbox

Code
Mindbox.logger.log(level: LogLevel, message: String)