Руководство по базовой интеграции iOS SDK
В этом разделе содержится информация о том, как интегрировать Pushwoosh SDK в ваше iOS-приложение.
Предварительные требования
Anchor link toДля интеграции Pushwoosh iOS SDK в ваше приложение вам потребуется следующее:
Шаги интеграции
Anchor link to1. Установка
Anchor link toВы можете интегрировать Pushwoosh SDK в ваше приложение, используя Swift Package Manager или CocoaPods.
Swift Package Manager
Anchor link toВ разделе Package Dependencies добавьте следующий пакет:
https://github.com/Pushwoosh/Pushwoosh-XCFramework
Чтобы использовать Pushwoosh iOS SDK, убедитесь, что при интеграции через Swift Package Manager в цель вашего приложения добавлены следующие четыре фреймворка:
PushwooshFramework
PushwooshCore
PushwooshBridge
PushwooshLiveActivities

CocoaPods
Anchor link toОткройте ваш Podfile
и добавьте зависимость:
# Раскомментируйте следующую строку, чтобы определить глобальную платформу для вашего проекта# platform :ios, '9.0'
target 'MyApp' do # Раскомментируйте следующую строку, если вы не хотите использовать динамические фреймворки use_frameworks!
pod 'PushwooshXCFramework'
end
Затем в терминале выполните следующую команду для установки зависимостей:
pod install
2. Capabilities (Возможности)
Anchor link toЧтобы включить push-уведомления в вашем проекте, вам необходимо добавить определенные возможности (capabilities).
В разделе Signing & Capabilities добавьте следующие возможности:
Push Notifications
Background Modes
. После добавления этой возможности установите флажокRemote notifications
.
Если вы планируете использовать Time Sensitive Notifications (iOS 15+), добавьте также возможность Time Sensitive Notifications
.
3. Код инициализации
Anchor link toAppDelegate
Anchor link toДобавьте следующий код в ваш класс AppDelegate:
import SwiftUIimport PushwooshFramework
@mainstruct MyApp: App { // Регистрируем AppDelegate как UIApplicationDelegate @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate
var body: some Scene { WindowGroup { ContentView() } }}
class AppDelegate: NSObject, UIApplicationDelegate, PWMessagingDelegate {
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { // Код инициализации // Устанавливаем кастомный делегат для обработки push-уведомлений Pushwoosh.sharedInstance().delegate = self
// Регистрируемся для получения push-уведомлений Pushwoosh.sharedInstance().registerForPushNotifications()
return true }
// Обработка токена, полученного от APNS func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) { Pushwoosh.sharedInstance().handlePushRegistration(deviceToken) }
// Обработка ошибки получения токена func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) { Pushwoosh.sharedInstance().handlePushRegistrationFailure(error) }
//для тихих push-уведомлений func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable: Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) { Pushwoosh.sharedInstance().handlePushReceived(userInfo) completionHandler(.noData) }
// Вызывается при получении push-уведомления func pushwoosh(_ pushwoosh: Pushwoosh, onMessageReceived message: PWMessage) { print("onMessageReceived: ", message.payload!.description) }
// Вызывается, когда пользователь нажимает на уведомление func pushwoosh(_ pushwoosh: Pushwoosh, onMessageOpened message: PWMessage) { print("onMessageOpened: ", message.payload!.description) }}
struct ContentView: View { var body: some View { Text("Pushwoosh with SwiftUI") .padding() }}
import PushwooshFramework
@UIApplicationMainclass AppDelegate: UIResponder, UIApplicationDelegate, PWMessagingDelegate {
var window: UIWindow?
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { //код инициализации //устанавливаем кастомный делегат для обработки push-уведомлений, в нашем случае AppDelegate Pushwoosh.sharedInstance().delegate = self;
//регистрируемся для получения push-уведомлений Pushwoosh.sharedInstance().registerForPushNotifications()
return true }
//обработка токена, полученного от APNS func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) { Pushwoosh.sharedInstance().handlePushRegistration(deviceToken) }
//обработка ошибки получения токена func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) { Pushwoosh.sharedInstance().handlePushRegistrationFailure(error); }
//для тихих push-уведомлений func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) { Pushwoosh.sharedInstance().handlePushReceived(userInfo) completionHandler(.noData) }
//это событие вызывается при получении push-уведомления func pushwoosh(_ pushwoosh: Pushwoosh, onMessageReceived message: PWMessage) { print("onMessageReceived: ", message.payload!.description) }
// Вызывается, когда пользователь нажимает на уведомление func pushwoosh(_ pushwoosh: Pushwoosh, onMessageOpened message: PWMessage) { print("onMessageOpened: ", message.payload!.description) }}
#import <PushwooshFramework/PushwooshFramework.h>
@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { //-----------ЧАСТЬ PUSHWOOSH-----------
// устанавливаем кастомный делегат для обработки push-уведомлений, в нашем случае AppDelegate [Pushwoosh sharedInstance].delegate = self;
//регистрируемся для получения push-уведомлений! [[Pushwoosh sharedInstance] registerForPushNotifications];
return YES;}
//обработка токена, полученного от APNS- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { [[Pushwoosh sharedInstance] handlePushRegistration:deviceToken];}
//обработка ошибки получения токена- (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error { [[Pushwoosh sharedInstance] handlePushRegistrationFailure:error];}
//для тихих push-уведомлений- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler { [[Pushwoosh sharedInstance] handlePushReceived:userInfo]; completionHandler(UIBackgroundFetchResultNoData);}
//это событие вызывается при получении push-уведомления- (void)pushwoosh:(Pushwoosh *)pushwoosh onMessageReceived:(PWMessage *)message { NSLog(@"onMessageReceived: %@", message.payload);}
//это событие вызывается, когда пользователь нажимает на уведомление- (void)pushwoosh:(Pushwoosh *)pushwoosh onMessageOpened:(PWMessage *)message { NSLog(@"onMessageOpened: %@", message.payload);}
@end
Info.plist
Anchor link toВ вашем Info.plist
:
- установите для ключа
Pushwoosh_APPID
значение кода приложения Pushwoosh (Application Code). - установите для ключа
Pushwoosh_API_TOKEN
значение токена Pushwoosh Device API
4. Отслеживание доставки сообщений
Anchor link toPushwoosh поддерживает отслеживание событий доставки для push-уведомлений через Notification Service Extension.
Добавление Notification Service Extension
Anchor link to- В Xcode выберите File > New > Target…
- Выберите Notification Service Extension и нажмите Next.
- Введите имя цели (target) и нажмите Finish.
- При запросе на активацию нажмите Cancel.
Зависимости для Notification Service Extension (только для CocoaPods)
Anchor link toПримечание: Если вы используете Swift Package Manager для управления зависимостями, вы можете пропустить этот шаг, так как зависимости добавляются автоматически.
Откройте ваш Podfile
и добавьте зависимость для цели:
# Раскомментируйте следующую строку, чтобы определить глобальную платформу для вашего проекта# platform :ios, '9.0'
target 'MyApp' do # Раскомментируйте следующую строку, если вы не хотите использовать динамические фреймворки use_frameworks!
pod 'PushwooshXCFramework'
end
target 'MyAppNotificationExtension' do use_frameworks!
pod 'PushwooshXCFramework'
end
Выполните следующую команду в терминале, чтобы обновить зависимости:
pod update
Добавление Pushwoosh SDK в Notification Service Extension
Anchor link toЭтот код позволяет перехватывать и обрабатывать уведомления в вашем расширении уведомлений.
import UserNotificationsimport PushwooshFramework
class NotificationService: UNNotificationServiceExtension {
var contentHandler: ((UNNotificationContent) -> Void)? var bestAttemptContent: UNMutableNotificationContent?
override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) { // Pushwoosh ********** PWNotificationExtensionManager.shared().handle(request, contentHandler: contentHandler) // ********************
self.contentHandler = contentHandler bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
if let bestAttemptContent = bestAttemptContent { // Измените содержимое уведомления здесь... contentHandler(bestAttemptContent) } }
override func serviceExtensionTimeWillExpire() { // Вызывается непосредственно перед тем, как система завершит работу расширения. // Используйте это как возможность доставить ваш "лучший вариант" измененного контента, иначе будет использована исходная полезная нагрузка push-уведомления. if let contentHandler = contentHandler, let bestAttemptContent = bestAttemptContent { contentHandler(bestAttemptContent) } }
}
#import "PWNotificationExtensionManager.h"
@interface NotificationService : UNNotificationServiceExtension
@end
@implementation NotificationService
- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler { // Pushwoosh ********** [[PWNotificationExtensionManager sharedManager] handleNotificationRequest:request contentHandler:contentHandler]; //*********************}
@end
Info.plist
Anchor link toВ Info.plist вашего Notification Service Extension добавьте:
Pushwoosh_APPID
- ваш код приложения (Application Code).
5. Запуск проекта
Anchor link to- Соберите и запустите проект.
- Перейдите в Панель управления Pushwoosh и отправьте push-уведомление.
- Вы должны увидеть уведомление в приложении.
Расширенная интеграция Pushwoosh для iOS
Anchor link toНа этом этапе вы уже интегрировали SDK и можете отправлять и получать push-уведомления. Теперь давайте рассмотрим основной функционал.
Push-уведомления
Anchor link toВ Pushwoosh SDK есть два колбэка для обработки push-уведомлений:
onMessageReceived
: Этот метод вызывается при получении push-уведомления.onMessageOpened
: Этот метод вызывается, когда пользователь взаимодействует с уведомлением (открывает его).
Эти колбэки позволяют разработчикам управлять получением push-уведомлений и взаимодействием с ними со стороны пользователя в своих приложениях.
import PushwooshFramework
class AppDelegate: NSObject, UIApplicationDelegate, PWMessagingDelegate {
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool { Pushwoosh.sharedInstance().delegate = self; }
func pushwoosh(_ pushwoosh: Pushwoosh, onMessageOpened message: PWMessage) { if let payload = message.payload { print("onMessageOpened: \(payload)") } }
func pushwoosh(_ pushwoosh: Pushwoosh, onMessageReceived message: PWMessage) { if let payload = message.payload { print("onMessageReceived: \(payload)") } }}
#import <PushwooshFramework/PushwooshFramework.h>
@interface AppDelegate () <PWMessagingDelegate>
@end
@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { [[Pushwoosh sharedInstance] setDelegate:self]; return YES;}
- (void)pushwoosh:(Pushwoosh *)pushwoosh onMessageOpened:(PWMessage *)message { if (message.payload) { NSLog(@"onMessageOpened: %@", message.payload); }}
- (void)pushwoosh:(Pushwoosh *)pushwoosh onMessageReceived:(PWMessage *)message { if (message.payload) { NSLog(@"onMessageReceived: %@", message.payload); }}@end
Конфигурация пользователя
Anchor link toСосредоточившись на поведении и предпочтениях отдельных пользователей, вы можете предоставлять персонализированный контент, что приведет к повышению удовлетворенности и лояльности пользователей.
import PushwooshFramework
class Registration {
func afterUserLogin(user: User) { let pushwoosh = Pushwoosh.sharedInstance() // установить User ID if let userId = user.userId { pushwoosh.setUserId(userId) }
// установить email пользователя if let userEmail = user.email { pushwoosh.setEmail(userEmail) }
// установка дополнительной информации о пользователе в виде тегов для Pushwoosh if let age = user.userDetails.age, let name = user.userDetails.userName, let lastLogin = user.userDetails.lastLoginDate { pushwoosh.setTags([ "age": age, "name": name, "last_login": lastLogin ]) } }}
#import <PushwooshFramework/PushwooshFramework.h>
@implementation Registration
- (void)afterUserLogin:(User *)user { Pushwoosh *pushwoosh = [Pushwoosh sharedInstance];
// установить User ID if (user.userId) { [pushwoosh setUserId:user.userId]; }
// установить email пользователя if (user.email) { [pushwoosh setEmail:user.email]; }
// установка дополнительной информации о пользователе в виде тегов для Pushwoosh if (user.userDetails.age && user.userDetails.userName && user.userDetails.lastLoginDate) { NSDictionary *tags = @{ @"age": user.userDetails.age, @"name": user.userDetails.userName, @"last_login": user.userDetails.lastLoginDate }; [pushwoosh setTags:tags]; }}
@end
Теги
Anchor link toТеги — это пары «ключ-значение», присваиваемые пользователям или устройствам, что позволяет сегментировать их по таким атрибутам, как предпочтения или поведение, и отправлять таргетированные сообщения.
import PushwooshFramework
class UpdateUser { func afterUserUpdateProfile(user: User) { let pushwoosh = Pushwoosh.sharedInstance()
// установить список любимых категорий pushwoosh.setTags(["favorite_categories" : user.getFavoriteCategories()])
// установить платежную информацию pushwoosh.setTags([ "is_subscribed": user.isSubscribed(), "payment_status": user.getPaymentStatus(), "billing_address": user.getBillingAddress() ]) }}
#import <PushwooshFramework/PushwooshFramework.h>
@implementation UpdateUser
- (void)afterUserUpdateProfile:(User *)user { Pushwoosh *pushwoosh = [Pushwoosh sharedInstance];
// установить список любимых категорий [pushwoosh setTags:@{@"favorite_categories" : user.getFavoriteCategories}];
// установить платежную информацию NSDictionary *tags = @{ @"is_subscribed": @(user.isSubscribed), @"payment_status": user.getPaymentStatus, @"billing_address": user.getBillingAddress }; [pushwoosh setTags:tags];}
@end
События
Anchor link toСобытия — это определенные действия или происшествия пользователя в приложении, которые можно отслеживать для анализа поведения и запуска соответствующих сообщений или действий.
import PushwooshFramework
class Registration {
func afterUserLogin(user: User) { if let userName = user.getUserName(), let lastLogin = user.getLastLoginDate() { PWInAppManager.shared().postEvent("login", withAttributes: [ "name": userName, "last_login": lastLogin ]) } }
func afterUserPurchase(user: User, product: Product) { let pushwoosh = Pushwoosh.sharedInstance()
// Отслеживание события покупки PWInAppManager.shared().postEvent("purchase", withAttributes: [ "product_id": product.getId(), "product_name": product.getName(), "price": product.getPrice(), "quantity": product.getQuantity() ])
// Установка тегов пользователя let lastPurchaseDate = Date().timeIntervalSince1970 let lifetimeSpend = getCurrentLifetimeSpend() + product.getPrice()
pushwoosh.setTags([ "last_purchase_date": lastPurchaseDate, "lifetime_spend": lifetimeSpend ]) }}
#import <PushwooshFramework/PushwooshFramework.h>#import <PushwooshFramework/PWInAppManager.h>
@implementation Registration
- (void)afterUserLogin:(User *)user { NSString *userName = [user getUserName]; NSDate *lastLogin = [user getLastLoginDate];
if (userName && lastLogin) { [[PWInAppManager sharedManager] postEvent:@"login" withAttributes:@{ @"name": userName, @"last_login": lastLogin }]; }}
- (void)afterUserPurchase:(User *)user product:(Product *)product { Pushwoosh *pushwoosh = [Pushwoosh sharedInstance];
// Отслеживание события покупки [[PWInAppManager sharedManager] postEvent:@"purchase" withAttributes:@{ @"product_id": [product getId], @"product_name": [product getName], @"price": @([product getPrice]), @"quantity": @([product getQuantity]) }];
// Установка тегов пользователя NSTimeInterval lastPurchaseDate = [[NSDate date] timeIntervalSince1970]; double lifetimeSpend = /* получить текущие пожизненные траты */ + [product getPrice];
NSDictionary *tags = @{ @"last_purchase_date": @(lastPurchaseDate), @"lifetime_spend": @(lifetimeSpend) };
[pushwoosh setTags:tags];}
@end
Rich Media
Anchor link toRich Media — это интерактивный и мультимедийный контент, такой как изображения, видео или HTML, используемый в уведомлениях и in-app сообщениях для повышения вовлеченности пользователей.
import PushwooshFramework
class ViewController: UIViewController, PWRichMediaPresentingDelegate {
override func viewDidLoad() { super.viewDidLoad() let richMediaConfiguration = PWModalWindowConfiguration.shared()
PWRichMediaManager.shared().delegate = self richMediaConfiguration.configureModalWindow(with: .PWModalWindowPositionBottom, present: .PWAnimationPresentFromBottom, dismiss: .PWAnimationDismissDown) }
func richMediaManager(_ richMediaManager: PWRichMediaManager!, shouldPresent richMedia: PWRichMedia!) -> Bool { print("Rich media будет представлен с: \(richMedia.pushPayload!)") return true }
func richMediaManager(_ richMediaManager: PWRichMediaManager!, didPresent richMedia: PWRichMedia!) { print("Rich media был представлен с: \(richMedia.pushPayload!)") }
func richMediaManager(_ richMediaManager: PWRichMediaManager!, didClose richMedia: PWRichMedia!) { print("Rich media был закрыт с: \(richMedia.pushPayload!)") }
func richMediaManager(_ richMediaManager: PWRichMediaManager!, presentingDidFailFor richMedia: PWRichMedia!, withError error: (any Error)!) { print("Не удалось представить rich media с: \(richMedia.pushPayload!). Ошибка: \(error.localizedDescription)") }}
#import "ViewController.h"#import <PushwooshFramework/PushwooshFramework.h>#import <PushwooshFramework/PWRichMediaManager.h>#import <PushwooshFramework/PWModalWindowConfiguration.h>
@interface ViewController () <PWRichMediaPresentingDelegate>
@end
@implementation ViewController
- (void)viewDidLoad { [super viewDidLoad];
[[PWRichMediaManager sharedManager] setDelegate:self]; [[PWModalWindowConfiguration shared] configureModalWindowWith:PWModalWindowPositionBottom presentAnimation:PWAnimationPresentFromBottom dismissAnimation:PWAnimationDismissDown];}
- (BOOL)richMediaManager:(PWRichMediaManager *)richMediaManager shouldPresentRichMedia:(PWRichMedia *)richMedia { NSLog(@"Rich media будет представлен с: %@", richMedia.pushPayload); return YES;}
- (void)richMediaManager:(PWRichMediaManager *)richMediaManager didPresentRichMedia:(PWRichMedia *)richMedia { NSLog(@"Rich media был представлен с: %@", richMedia.pushPayload);}
- (void)richMediaManager:(PWRichMediaManager *)richMediaManager didCloseRichMedia:(PWRichMedia *)richMedia { NSLog(@"Rich media был закрыт с: %@", richMedia.pushPayload);}
- (void)richMediaManager:(PWRichMediaManager *)richMediaManager presentingDidFailForRichMedia:(PWRichMedia *)richMedia withError:(NSError *)error { NSLog(@"Не удалось представить rich media с: %@. Ошибка: %@", richMedia.pushPayload, error.localizedDescription);}
@end
Устранение неполадок
Anchor link toЕсли у вас возникнут какие-либо проблемы в процессе интеграции, обратитесь к разделу поддержка и сообщество.