Функционал SDK
Предварительно вам необходимо настроить SDK для работы с вашим приложением. Подробная инструкция находится здесь
SDK разделён на модули: core (авторизация, события), push, target (цели), profile и in-app. Каждый модуль подключается отдельной зависимостью и доступен через своё статическое свойство AltcraftSDK — AltcraftSDK.push, AltcraftSDK.target, AltcraftSDK.profile, AltcraftSDK.inApp.
Core: авторизация
AltcraftSDK
// Доступ к аутентификации пользователя
└─ static var auth: AuthAPI
// Аутентифицировать текущего пользователя SDK
├─ func authenticate(): Void
// Выйти из профиля (возврат к анонимной сессии)
└─ func logOut(): Void
Функции авторизации:
func authenticate()— аутентифицирует текущего пользователя: отправляет на сервер запрос с текущими данными аутентификации (JWT-токен или rToken) и привязывает устройство к профилю пользователя. После успешной аутентификации пользователь получает доступ к персонализированным In-App уведомлениям.func logOut()— завершает текущую сессию аутентификации и переводит устройство в анонимный режим. В анонимном режиме недоступны персонализированные In-App уведомления и управление подпиской.
Установка JWT-провайдера выполняется функцией AltcraftSDK.auth.setJWTProvider(provider:) (в NSE — AltcraftNSE.setJWTProvider(provider:)) (см. настройку SDK).
Вызывайте authenticate() только тогда, когда пользователь действительно выполняет вход в приложение и известен для клиента (например, после успешной авторизации через форму логина, OAuth или другой механизм аутентификации вашего приложения). С logOut() — аналогично: только при реальном выходе пользователя.
Пример использования:
AltcraftSDK.auth.authenticate()
Очистка данных SDK
AltcraftSDK
// Полная очистка данных SDK (кэш, БД, настройки), затем вызов completion
└── func clear(
completion: (() -> Void)? = nil
): Void
Функция выполняет полную очистку данных SDK: кэша, базы данных и локальных настроек. Необязательный параметр completion вызывается после завершения очистки.
Core: события SDK
// API событий SDK
AltcraftSDK
└── static var sdkEvents: SDKEvents
// Подписка на события SDK (заменяет существующего подписчика)
├── func subscribe(
│ callback: @escaping (Event) -> Void
│ ): Void
// Отписка от событий
└── func unsubscribe(): Void
В приложении может быть только один активный подписчик на события SDK.
Типы событий SDK:
- Event — общее событие (информация, успешные запросы);
- ErrorEvent — событие об ошибке;
- RetryEvent — событ ие об ошибке при выполнении запроса, для которого предусмотрен автоматический повтор на стороне SDK.
Каждое событие содержит поля:
- function — имя функции, вызвавшей событие;
- event — тип события SDK (
SDKEvent, список см. в таблице ниже); - message — сообщение события;
- value — дополнительные данные (
[String: Any]?), добавляемые к некоторым событиям; - date — время события.
Подписка на события
func subscribe(callback: @escaping (Event) -> Void): Void
Функция подписывает приложение на события SDK. При возникновении события SDK она вызывает переданный callback и передаёт в него экземпляр Event (или его наследника). Колбэк всегда вызывается на главном потоке.
Пример использования:
AltcraftSDK.sdkEvents.subscribe { event in
// Обработка события
}
Классы событий SDK
open class Event: NSObject {
public let id = UUID()
public let function: String
public let event: SDKEvent?
public let message: String?
public let value: [String: Any]?
public let date: Date
}
// Ошибка без автоматического повтора
open class ErrorEvent: Event {}
// Ошибка запроса, для которого предусмотрен автоматический повтор
public final class RetryEvent: ErrorEvent {}
Отписка от событий
func unsubscribe(): Void
Отменяет доставку событий SDK. Подписчик остаётся назначенным, но события больше не передаются.
Пример использования:
AltcraftSDK.sdkEvents.unsubscribe()
Список всех событий SDK
Список событий по модулям
События SDK доступны как значения перечислений: CoreEvents (core), PushModuleEvents, TargetModuleEvents, ProfileModuleEvents, InAppModuleEvents. Каждый элемент — значение перечисления со строковым сообщением (message).
Core:
| Значение | Сообщение |
|---|---|
configSet | SDK configuration is installed. |
sdkCleared | SDK data has been cleared |
initAwait | waiting for SDK initialization to complete |
userLogOut | User logged out. Anonymous session started |
backgroundTaskRegister | SDK background task is registered |
backgroundTaskCompleted | SDK background task completed |
configIsNotSet | the configuration is not set |
appGroupIsNotSet | App Group name was not set. |
notAuthenticatedError | user is not authenticated |
invalidUrlValue | invalid apiUrl value - empty or null. |
invalidRTokenValue | invalid resource token value - resource token is empty. |
fieldsIsObjects | invalid values: not all values are primitives |
permissionDenied | notification permission denied. |
jwtIsNil | JWT token is nil |
authenticateSuccessful | successful request: profile/authenticate |
authenticateFailed | failed request: profile/authenticate |
Перечисление CoreEvents содержит и внутренние события (ошибки CoreData, парсинга JWT, недоступности окружения и т.п.), которые не входят в таблицу выше и не являются частью публичного API. Внутренние события также есть в PushModuleEvents и InAppModuleEvents — в таблицах ниже перечислены только события публичного API.
Push:
| Значение | Сообщение |
|---|---|
pushProviderSet | push provider set: |
pushReceive | received Altcraft push notification. |
pushIsPosted | push is posted. |
pushTokenUpdateAwait | waiting for push token update to complete |
pushSubscribeRequestSuccessful | successful request: push/subscribe |
pushSubscribeRequestFailed | failed request: push/subscribe |
pushSuspendRequestSuccessful | successful request: push/suspend |
pushSuspendRequestFailed | failed request: push/suspend |
pushUnsubscribeRequestSuccessful | successful request: push/unsubscribe |
pushUnsubscribeRequestFailed | failed request: push/unsubscribe |
tokenUpdateRequestSuccessful | successful request: push/update |
tokenUpdateRequestFailed | failed request: push/update |
pushStatusRequestSuccessful | successful request: push/status |
pushStatusRequestFailed | failed request: push/status |
unsuspendRequestSuccessful | successful request: push/unsuspend |
unsuspendRequestFailed | failed request: push/unsuspend |
pushEventRequestSuccessful | successful request: event/push |
pushEventRequestFailed | failed request: event/push |
invalidPushProviders | invalid provider. Available - ios-apns, ios-firebase, ios-huawei. |
invalidPushProvider | invalid provider. |
errorHandleUserInfo | invalid userInfo format |
uidIsNil | uid in the push data is null, it is impossible to send a push event to the server. |
errorMediaDownload | could not download image data from URL. |
errorMediaKeyMissing | 'media' key is missing or URL string is invalid. |
errorButtonsKeyMissing | 'buttons' key is missing or is invalid. |
invalidButtonIdentifier | invalid button identifier. See event value |
outOfRangeForIdentifier | out of range for identifier. See event value |
unknownButtonIdentifier | unknown button identifier. See event value |
subscribeRequestDataIsNil | subscribe request data is nil |
updateRequestDataIsNil | update request data is nil |
pushEventRequestDataIsNil | push event request data is nil |
unsuspendRequestDataIsNil | unsuspend request data is nil |
pushStatusRequestDataIsNil | push status request data is nil |
invalidSubRequestData | invalid push subscribe request data |
invalidPushEventRequestData | invalid push event request data |
pushConfigurationSaveFailed | failed to save the push configuration to the local database |
pushConfigurationClearFailed | failed to clear the push configuration from the local database |
apnsIsNotUpdated | forcing a push token update is not possible: the operation is not supported for APNs. |
pushTokenIsNil | current push token is nil |
Target:
| Значение | Сообщение |
|---|---|
mobileRequestDataIsNil | mobile event request data is nil |
mobileEventRequestSuccessful | successful request: event/post |
mobileEventRequestFailed | failed request: event/post |
Profile:
| Значение | Сообщение |
|---|---|
profileUpdateRequestDataIsNil | profile update request data is nil |
profileUpdateRequestSuccessful | successful request: profile/update |
profileUpdateRequestFailed | failed request: profile/update |
In-App:
| Значение | Сообщение |
|---|---|
errorInAppImageLoad | failed to load in-app image |
invalidStaticField | invalid in-app static field |
smidIsNil | smid in the in-app data is null, it is impossible to send a in-app event to the server. |
acidIsNil | acid in the in-app data is null, it is impossible to send a in-app event to the server. |
inAppStatusRequestDataIsNil | in-app status request data is nil |
inAppEventRequestDataIsNil | in-app event request data is nil |
subscribeRequestDataIsNil | in-app subscribe request data is nil |
invalidSubRequestData | invalid in-app subscribe request data |
inAppSubscribeRequestSuccessful | successful request: inapp/subscribe |
inAppSubscribeRequestFailed | failed request: inapp/subscribe |
inAppUnsubscribeRequestSuccessful | successful request: inapp/unsubscribe |
inAppUnsubscribeRequestFailed | failed request: inapp/unsubscribe |
inAppStatusRequestSuccessful | successful request: inapp/status |
inAppStatusRequestFailed | failed request: inapp/status |
inAppEventRequestSuccessful | successful request: inapp/event |
inAppEventRequestFailed | failed request: inapp/event |
inAppPlacementsRequestSuccessful | successful request: inapp/placements |
inAppPlacementsRequestFailed | failed request: inapp/placements |
inAppStaticErrorLoad | error loading in-app notification static resources |
inAppContentErrorLoad | error loading in-app notification content |
maxPlacementsInvalid | Invalid in-app configuration: maxPlacements must be >= 1 |
requestIntervalInvalid | Invalid in-app configuration: placementsRequestInterval must be > 0 |
placementsLimitExceeded | in-app placements limit exceeded |
Push: работа со статусами подписки
Изменение статуса подписки
AltcraftSDK
└─ static var push: Push
└─ var subscription: SubscriptionAPI
// Подписка (статус = SUBSCRIBED)
├─ func subscribe(
│ sync: Bool = true,
│ profileFields: [String: Any?]? = nil,
│ customFields: [String: Any?]? = nil,
│ cats: [CategoryData]? = nil,
│ replace: Bool? = nil,
│ skipTriggers: Bool? = nil
│ ): Void
// Приостановка (статус = SUSPENDED)
├─ func suspend(
│ sync: Bool = true,
│ profileFields: [String: Any?]? = nil,
│ customFields: [String: Any?]? = nil,
│ cats: [CategoryData]? = nil,
│ replace: Bool? = nil,
│ skipTriggers: Bool? = nil
│ ): Void
// Отписка (статус = UNSUBSCRIBED)
├─ func unsubscribe(
│ sync: Bool = true,
│ profileFields: [String: Any?]? = nil,
│ customFields: [String: Any?]? = nil,
│ cats: [CategoryData]? = nil,
│ replace: Bool? = nil,
│ skipTriggers: Bool? = nil
│ ): Void
// Переключение подписок между профилями (LogIn/LogOut)
├─ func unSuspend(
│ completion: @escaping @Sendable (
│ ResponseModel.ResponseWithHttpCode<ResponseModel.ResponseWithProfile>?
│ ) -> Void
│ ): Void
// Построение функциональных операций над полями профиля
└─ func actionField(key: String) -> ActionFieldBuilder
Функции изменения статуса подписки:
func subscribe()— выполняет подписку на push-уведомления;func suspend()— приостанавливает подписку на push-уведомления (уведомления не приходят, но при этом не создаётся событие отписки в профиле пользователя);func unsubscribe()— отменяет подписку на push-уведомления;func unSuspend()— используется для созданияLogIn-,LogOut-переходов;func actionField()— создаётActionFieldBuilderдля построения функциональных операций (set,unset,incr,add,delete,upsert) над полями профиля внутриprofileFields.
Функции изменения статуса имеют одинаковую сигнатуру, содержащую следующие параметры:
sync: Bool
По умолчанию: true
Обязательный: Нет
Описание: Флаг, устанавливающий синхронность выполнения запроса.
Успешное выполнение запроса:
В случае успешного выполнения запроса данной группы функций будет создано событие pushSubscribeRequestSuccessful, pushSuspendRequestSuccessful или pushUnsubscribeRequestSuccessful, содержащее в event.value данные ответа:
Если sync == true
event.value
├─ error: 0
├─ error_text: ""
├─ http_code: 200
└─ profile
├─ id: "your id"
├─ status: "subscribed"
├─ isTest: false
└─ subscription
├─ subscriptionId: "your subscriptionId"
├─ hashId: "c52b28d2"
├─ provider: "ios-apns"
├─ status: "subscribed"
├─ fields
│ ├─ _os_ver: {"raw":"18.6.2","ver":"[\"18.0\", \"6.0\", \"2.0\"]"}
│ ├─ _device_type: "mob"
│ ├─ _ad_track: false
│ ├─ _device_name: "iPhone"
│ ├─ _os_language: "en"
│ ├─ _os_tz: "+0300"
│ ├─ _os: "IOS"
│ └─ _device_model: "iPhone14,7"
└─ cats
└─ [ { name: "developer_news", title: "dev_news", steady: false, active: false } ]
При синхронном запросе в значении события event.value доступны:
-
error – внутренний код ошибки сервера (0, если ошибок нет);
-
error_text – текст ошибки (пустая строка, если ошибок нет);
-
http_code – транспортный код ответа;
-
profile – данные профиля, если запрос успешный:
- информация о профиле (ProfileData)
- подписка (SubscriptionData)
- категории подписки (CategoryData)
- если запрос завершился с ошибкой, то вернётся только
profile = nil
Структуры данных
public struct ProfileData: Codable {
public let id: String?
public let status: String?
public let acid: String?
public let isTest: Bool?
public let subscription: SubscriptionData?
}
public struct SubscriptionData: Codable {
public let subscriptionId: String?
public let hashId: String?
public let provider: String?
public let status: String?
public let fields: [String: JSONValue]?
public let cats: [CategoryData]?
}
public struct CategoryData: Codable {
public var name: String?
public var title: String?
public var steady: Bool?
public var active: Bool?
}
Если sync == false
event.value
├─ error: Int?
├─ error_text: String?
├─ http_code: Int
└─ profile: ProfileData? = nil
При асинхронном запросе profile в значении события event.value всегда равен nil.
Выполнение запроса с ошибкой:
Если запрос данной группы функций завершился ошибкой, будет создано событие с типом ошибки:
pushSubscribeRequestFailed— подписка на уведомления;pushSuspendRequestFailed— приостановка подписки;pushUnsubscribeRequestFailed— отписка.
Содержимое события:
event.valueне содержит данных (nil), если сервер Altcraft был недоступен;- только
http_code, если сервер вернул ответ без корректного JSON-тела; errorиerror_text, если сервер вернул ошибку.
Получение значений событий
AltcraftSDK.sdkEvents.subscribe { event in
let sdkEvent = event.event
if sdkEvent == PushModuleEvents.pushSubscribeRequestSuccessful ||
sdkEvent == PushModuleEvents.pushSubscribeRequestFailed
{
let value = event.value
let error = value?["error"] as? Int
let errorText = value?["error_text"] as? String
let httpCode = value?["http_code"] as? Int
let profile = value?["profile"] as? ProfileData
let subscription = profile?.subscription
}
}
profileFields:[String: Any?]?
По умолчанию: nil
Обязательный: Нет
Описание: Словарь, содержащий поля профиля.
Параметр может принимать как системные поля (например, _fname — имя или _lname — фамилия), так и опциональные (заранее создаются вручную в интерфейсе платформы). Допустимые структуры (JSON-совместимые):
- Скалярные значения:
- String
- Bool
- Int
- Int64 / UInt64 (или эквиваленты
NSNumber) - Float
- Double
nil
- Объекты:
[String: Any?] - Списки:
[Any?] - Массивы карт:
[[String: Any?]]
Если передано невалидное опциональное поле, запрос завершится с ошибкой:
http_code: 400
error: 400
error_text: Platform profile processing error: with field "название_поля": Incorrect field
Для функциональных операций над полями профиля используйте actionField():
AltcraftSDK.push.subscription.subscribe(
profileFields: AltcraftSDK.push.subscription.actionField("orders_count").incr(1)
)
customFields:[String: Any?]?
По умолчанию: nil
Обязательный: Нет
Описание: Словарь, содержащий поля подписки.
Параметр может принимать как системные поля (например, _device_model — модель устройства или _os — операционная система), так и опциональные (заранее создаются вручную в интерфейсе платформы). Допустимые типы значений (JSON-совместимые, только скаляры):
- String
- Bool
- Int
- Float
- Double
nil
Если передано невалидное опциональное поле, запрос завершится с ошибкой:
http_code: 400
error: 400
error_text: Platform profile processing error: field "название_поля" is not valid: failed convert custom field
Вложенные объекты, массивы и коллекции не допускаются.
Большая часть системных полей подписки автоматически собирается SDK и добавляется к push-запросам. К таким системным полям относятся: "_os", "_os_tz", "_os_language", "_device_type", "_device_model", "_device_name", "_os_ver".
cats:[CategoryData]?
По умолчанию: nil
Обязательный: Нет
Описание: Категории подписок.
Структура категории:
public struct CategoryData: Codable {
public var name: String?
public var title: String?
public var steady: Bool?
public var active: Bool?
}
При отправке push-запроса достаточно заполнить поля name (название категории) и active (статус активности категории). Поля title и steady также передаются в запросе, если заполнены; при получении информации о подписке они заполняются сервером.
Пример запроса:
let cats: [CategoryData] = [CategoryData(name: "football", active: true)]
Категории, используемые в запросе, должны быть предварительно созданы и добавлены к ресурсу в платформе Altcraft. Если в запросе будет использована категория, которая не добавлена в ресурс, — запрос вернётся с ошибкой:
http_code: 400
error: 400
error_text: Platform profile processing error: field "subscriptions.cats" is not valid: category not found in resource
replace:Bool?
По умолчанию: nil
Обязательный: Нет
Описание: При активации флага все подписки других профилей с тем же push-токеном в текущей базе данных переводятся в статус unsubscribed после успешного запроса.
skipTriggers:Bool?
По умолчанию: nil
Обязательный: Нет
Описание: При активации флага профиль, содержащий данную подписку, будет игнорироваться в триггерах рассылок и сценариев.
Примеры реализации запроса
Пример выполнения запроса подписки на push-уведомления
Минимальная рабочая настройка:
AltcraftSDK.push.subscription.subscribe()
Передача всех доступных параметров:
AltcraftSDK.push.subscription.subscribe(
sync: true,
profileFields: ["_fname": "Andrey", "_lname": "Pogodin"],
customFields: ["developer": true],
cats: [CategoryData(name: "developer_news", active: true)],
replace: false,
skipTriggers: false
)
Для subscribe, suspend и unsubscribe предусмотрен автоматический повтор запроса со стороны SDK, если http-код ответа находится в диапазоне 500..599. Запрос не повторяется, если код ответа в этот диапазон не входит.
Функция unSuspend()
Функция unSuspend() предназначена для создания LogIn-, LogOut-переходов. Она работает следующим образом:
- проводит поиск подписок с тем же push-токеном, что и текущий, не относящихся к профилю, на который указывает текущий JWT-токен;
- меняет статус найденных подписок с
subscribedнаsuspended; - меняет статус в подписках профиля, на который указывает текущий JWT, с
suspendedнаsubscribed(если профиль, на который указывает JWT, существует и в нём содержатся подписки); - возвращает
ResponseModel.ResponseWithHttpCode<ResponseModel.ResponseWithProfile>?, в которомresponse.profile— текущий профиль, на котор ый указывает JWT (если профиля не существует, вернётсяnil).
Пример использования:
AltcraftSDK.push.subscription.unSuspend { response in
// обработка ответа
}
Рекомендуемая реализация LogIn-, LogOut-переходов
LogIn-переход:
- Анонимный пользователь входит в приложение. Данному пользователю присвоен
JWT_1, указывающий на базу д анных #1Anonymous; - Выполнена подписка на push-уведомления, профиль создан в базе данных #1Anonymous;
- Пользователь регистрируется, ему присваивается
JWT_2, указывающий на базу данных #2Registered; - Вызывается функция
unSuspend()— подписка анонимного пользователя в базе данных #1Anonymous приостанавливается; - Выполняется поиск профиля в базе данных #2Registered для восстановления подписки;
- Так как подписки с таким push-токеном в базе данных #2Registered не существует, функция
unSuspend()вернёт профиль без подписки; - После этого можно выполнить запрос на подписку
subscribe(), который создаст новый профиль в базе #2Registered.
LogOut-переход:
- Пользователь выполнил выход из профиля на стороне приложения (
LogOut); - Пользователю присваивается
JWT_1, указывающий на базу данных #1Anonymous; - Вызывается функция
unSuspend(), которая приостановит подписку в базе данных #2Registered и сменит статус подписки в базе #1Anonymous наsubscribed; - Запрос верн ёт непустой профиль — подписка уже существует, новая не требуется.
Пример реализации:
func logIn() {
// Установите JWT зарегистрированного пользователя через ваш JWTInterface-провайдер
jwtProvider.currentJWT = registeredJWT
AltcraftSDK.auth.authenticate()
AltcraftSDK.push.subscription.unSuspend { result in
if result?.httpCode == 200, result?.response?.profile?.subscription == nil {
AltcraftSDK.push.subscription.subscribe(
// Укажите необходимые параметры
)
}
}
}
func logOut() {
// Установите JWT анонимного пользователя через ваш JWTInterface-провайдер
jwtProvider.currentJWT = anonymousJWT
AltcraftSDK.push.subscription.unSuspend { result in
if result?.httpCode == 200, result?.response?.profile?.subscription == nil {
AltcraftSDK.push.subscription.subscribe(
// Укажите необходимые параметры
)
}
}
}
Запрос статуса подписки
AltcraftSDK
└── static var push: Push
└── var subscription: SubscriptionAPI
// Статус последней подписки профиля
├── func latest(
│ completion: @escaping @Sendable (
│ ResponseModel.ResponseWithHttpCode<ResponseModel.ResponseWithProfile>?
│ ) -> Void
│ ): Void
// Статус подписки по текущему push-токену/провайдеру
├── func current(
│ completion: @escaping @Sendable (
│ ResponseModel.ResponseWithHttpCode<ResponseModel.ResponseWithProfile>?
│ ) -> Void
│ ): Void
// Статус последней подписки по указанному провайдеру (если nil — используется текущий)
└── func latestForProvider(
provider: String? = nil,
completion: @escaping @Sendable (
ResponseModel.ResponseWithHttpCode<ResponseModel.ResponseWithProfile>?
) -> Void
): Void
Функции запроса статуса подписки:
func latest()— статус последней подписки профиля;func current()— статус подписки для текущего push-токена и провайдера;func latestForProvider()— статус последней подписки по указанному провайдеру. Если провайдер не указан (provider = nil), используется провайдер текущего push-токена.
func latest(completion: @escaping @Sendable (ResponseModel.ResponseWithHttpCode<ResponseModel.ResponseWithProfile>?) -> Void): Void
Функция получения статуса последней подписки профиля. В completion передаётся объект ResponseModel.ResponseWithHttpCode<ResponseModel.ResponseWithProfile>?, содержащий response?.profile?.subscription — последнюю созданную подписку в профиле. Если такой подписки не существует, будет передан nil.
Пример использования:
AltcraftSDK.push.subscription.latest { response in
// обработка ответа
}
func current(completion: @escaping @Sendable (ResponseModel.ResponseWithHttpCode<ResponseModel.ResponseWithProfile>?) -> Void): Void
Функция получения статуса подписки для текущего push-токена и провайдера. В completion передаётся объект ResponseModel.ResponseWithHttpCode<ResponseModel.ResponseWithProfile>?, содержащий response?.profile?.subscription — подписку, найденную по текущему push-токену и провайдеру. Если такой подписки не существует, будет передан nil.
Пример использования:
AltcraftSDK.push.subscription.current { response in
// обработка ответа
}
func latestForProvider(provider: String? = nil, completion: @escaping @Sendable (ResponseModel.ResponseWithHttpCode<ResponseModel.ResponseWithProfile>?) -> Void): Void
Функция получения статуса последней подписки по провайдеру. В completion передаётся объект ResponseModel.ResponseWithHttpCode<ResponseModel.ResponseWithProfile>?, содержащий response?.profile?.subscription — последнюю созданную подписку с указанным провайдером push-уведомлений. Если провайдер не указан (provider = nil), используется провайдер текущего push-токена. Если такой подписки не существует, будет передан nil.
Пример использования:
AltcraftSDK.push.subscription.latestForProvider(provider: nil) { response in
// обработка ответа
}
Ниже представлен пример извлечения данных о профиле, подписке и категориях из ответа функций получения статуса. Данный подход актуален для всех функций получения статуса:
Данные из функций получения статуса
AltcraftSDK.push.subscription.current { response in
// HTTP code
let httpCode = response?.httpCode
// Response
let resp = response?.response
let error = resp?.error
let errorText = resp?.errorText
// Profile
let profile = resp?.profile
let profileId = profile?.id
let profileStatus = profile?.status
let profileIsTest = profile?.isTest
// Subscription
let subscription = profile?.subscription
let subscriptionId = subscription?.subscriptionId
let hashId = subscription?.hashId
let provider = subscription?.provider
let subscriptionStatus = subscription?.status
// Fields (dictionary [String: JSONValue])
let fields = subscription?.fields
// Cats (array of CategoryData)
let cats = subscription?.cats
// CategoryData (every element of cats array)
let firstCat = cats?.first
let catName = firstCat?.name
let catTitle = firstCat?.title
let catSteady = firstCat?.steady
let catActive = firstCat?.active
}
В случае успешно выполненного запроса будет создано событие pushStatusRequestSuccessful. В случае ошибки — pushStatusRequestFailed.
Push: управление push-токенами
AltcraftSDK
└── static var push: Push
└── var token: TokenAPI
// Сохранить токен вручную
├── func setToken(
│ provider: String,
│ pushToken: Any?
│ ): Void
// Получить текущие данные токена устройства
├── func getToken(
│ completion: (@Sendable (TokenData?) -> Void)? = nil
│ ): Void
// Установить провайдера Apple Push Notification service (nil — удалить)
├── func setAPNSTokenProvider(
│ _ provider: APNSInterface?
│ ): Void
// Установить провайдера Firebase Cloud Messaging (nil — удалить)
├── func setFCMTokenProvider(
│ _ provider: FCMInterface?
│ ): Void
// Установить провайдера Huawei Mobile Services (nil — удалить)
├── func setHMSTokenProvider(
│ _ provider: HMSInterface?
│ ): Void
// Удалить токен push указанного провайдера
├── func deleteToken(
│ provider: String,
│ completion: (@Sendable () -> Void)? = nil
│ ): Void
// Принудительное обновление токена (удалить —> обновить)
├── func forcedTokenUpdate(
│ completion: (@Sendable () -> Void)? = nil
│ ): Void
// Изменить список приоритетов провайдеров и инициировать обновление токена
└── func changeProviderPriority(
_ list: [String]
): Void
Функции для работы с токеном провайдера в SDK:
func setToken()— ручная установка push-токена устройства и провайдера в локальном хранилище;func getToken()— получение текущего push-токена;func setAPNSTokenProvider()— установка и снятие провайдера Apple Push Notification service;func setFCMTokenProvider()— установка и снятие провайдера Firebase Cloud Messaging;func setHMSTokenProvider()— установка и снятие провайдера Huawei Mobile Services;func changeProviderPriority()— динамическая смена порядка провайдеров с обновле нием push-токена подписки;func deleteToken()— удаление push-токена указанного провайдера;func forcedTokenUpdate()— удаление текущего push-токена с последующим обновлением.
func setToken(provider: String, pushToken: Any?): Void
Функция предназначена для ручной установки push-токена устройства и провайдера. Используется как упрощённый вариант передачи push-токена в SDK без реализации протоколов провайдеров.
Не рекомендуется использовать эту функцию для передачи токена. Рекомендуемый подход передачи push-токена в SDK — реализация FCMInterface, HMSInterface или APNSInterface.
Пример использования:
AltcraftSDK.push.token.setToken(provider: "ios-apns", pushToken: "your token")
func getToken(completion: (@Sendable (TokenData?) -> Void)? = nil): Void
Функция передаёт в completion объект TokenData(provider: String, token: String), содержащий текущий push-токен устройства и его провайдера. Если push-токен недоступен, в completion будет передано nil.
Пример использования:
AltcraftSDK.push.token.getToken { data in
let provider = data?.provider
let token = data?.token
}
func setFCMTokenProvider(_ provider: FCMInterface?): Void
Функция устанавливает или снимает провайдера токенов Firebase Cloud Messaging. Чтобы отключить провайдера, передайте nil.
Пример использования:
AltcraftSDK.push.token.setFCMTokenProvider(FCMProvider())
Вызывайте setFCMTokenProvider() в AppDelegate.application(_:didFinishLaunchingWithOptions:) до вызова AltcraftSDK.initialization(). Это гарантирует регистрацию провайдера на старте процесса приложения, независимо от состояния жизненного цикла других компонентов и того, запущено приложение в foreground или background.
func setHMSTokenProvider(_ provider: HMSInterface?): Void
Функция устанавливает или снимает провайдера токенов Huawei Mobile Services. Чтобы отключить провайдера, передайте nil.
AltcraftSDK.push.token.setHMSTokenProvider(HMSProvider())
Вызывайте setHMSTokenProvider() в AppDelegate.application(_:didFinishLaunchingWithOptions:) до вызова AltcraftSDK.initialization(). Это гарантирует регистрацию провайдера на старте процесса приложения, независимо от состояния жизненного цикла других компонентов и того, запущено приложение в foreground или background.
func setAPNSTokenProvider(_ provider: APNSInterface?): Void
Функция устанавливает или снимает провайдера токенов Apple Push Notification service. Чтобы отключить провайдера, передайте nil.
AltcraftSDK.push.token.setAPNSTokenProvider(APNSProvider())
Вызывайте setAPNSTokenProvider() в AppDelegate.application(_:didFinishLaunchingWithOptions:) до вызова AltcraftSDK.initialization(). Это гарантирует регистрацию провайдера на старте процесса приложения, независимо от состояния жизненного цикла других компонентов и того, запущено приложение в foreground или background.
func changeProviderPriority(_ list: [String]): Void
Функция, позволяющая выполнить динамическую смену push-провайдера с обновлением токена подписки. Для этого необходимо передать новый массив с другим порядком провайдеров. Например: [PushConstants.ProviderName.firebase, PushConstants.ProviderName.apns, PushConstants.ProviderName.huawei].
Пример использования:
AltcraftSDK.push.token.changeProviderPriority([
PushConstants.ProviderName.firebase,
PushConstants.ProviderName.apns,
PushConstants.ProviderName.huawei
])
func deleteToken(provider: String, completion: (@Sendable () -> Void)? = nil): Void
Функция удаления push-токена указанного провайдера. Токен инвалидируется и удаляется из локального кеша на устройстве и с сервера push-провайдера. После удаления можно запросить новый токен. Для провайдера APNs удаление не поддерживается — будет зафиксирована ошибка apnsIsNotUpdated.
Пример использования:
AltcraftSDK.push.token.deleteToken(provider: "ios-firebase") {
// токен удалён
}
func forcedTokenUpdate(completion: (@Sendable () -> Void)? = nil): Void
Функция удаления текущего push-токена с его последующим обновлением. Для APNs операция не поддерживается — будет зафиксирована ошибка apnsIsNotUpdated.
Пример использования:
AltcraftSDK.push.token.forcedTokenUpdate {
// токен обновлён
}
Пример регистрации провайдеров
Мы не рекомендуем использовать функцию setToken для установки push-токена. Вместо этого настройте функции получения токена для каждого используемого провайдера. Ниже указан пример реализации этого метода:
Рекомендуемый способ регистрации провайдеров в AppDelegate
class AppDelegate: UIResponder, UIApplicationDelegate {
func application(
_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {
let appGroup = "your appGroup id"
AltcraftSDK.setAppGroup(groupName: appGroup)
AltcraftSDK.backgroundTasks.registerBackgroundTask()
AltcraftSDK.auth.setJWTProvider(provider: JWTProvider())
// APNs provider
AltcraftSDK.push.token.setAPNSTokenProvider(APNSProvider())
// FCM provider
AltcraftSDK.push.token.setFCMTokenProvider(FCMProvider())
// HMS provider
AltcraftSDK.push.token.setHMSTokenProvider(HMSProvider())
AltcraftSDK.push.notificationManager.registerForPushNotifications(for: application)
let config = AltcraftConfiguration.Builder(
apiUrl: "your api url"
).build()
AltcraftSDK.initialization(configuration: config)
return true
}
}
Push: передача push-уведомлений в SDK
// Используется внутри Notification Service Extension (NSE) — фасад для обработки
// push-уведомлений Altcraft, определения уведомлений Altcraft и регистрации целей
// без зависимости от UIApplication
AltcraftNSE
// Все методы доступны статически
// Общий (singleton) экземпляр для централизованной логики NSE