ข้ามไปยังเนื้อหา

คู่มือการผสานการทำงานพื้นฐาน iOS SDK 7.0+

ส่วนนี้ประกอบด้วยข้อมูลเกี่ยวกับวิธีการผสานการทำงาน Pushwoosh SDK เข้ากับแอปพลิเคชัน iOS ของคุณ

ข้อกำหนดเบื้องต้น

Anchor link to

ในการผสานการทำงาน Pushwoosh iOS SDK เข้ากับแอปของคุณ คุณจะต้องมีสิ่งต่อไปนี้:

ขั้นตอนการผสานการทำงาน

Anchor link to

1. การติดตั้ง

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 ตรวจสอบให้แน่ใจว่าได้เพิ่มเฟรมเวิร์กสามตัวต่อไปนี้ไปยัง target ของแอปของคุณเมื่อทำการผสานการทำงานผ่าน Swift Package Manager:

  • PushwooshFramework
  • PushwooshCore
  • PushwooshBridge

เปิด Podfile ของคุณและเพิ่ม dependency:

Terminal window
# Uncomment the next line to define a global platform for your project
# platform :ios, '9.0'
target 'MyApp' do
# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!
pod 'PushwooshXCFramework'
end

จากนั้นใน terminal ให้รันคำสั่งต่อไปนี้เพื่อติดตั้ง dependency:

Terminal window
pod install

2. Capabilities

Anchor link to

ในการเปิดใช้งาน Push Notifications ในโปรเจกต์ของคุณ คุณต้องเพิ่ม capabilities บางอย่าง

ในส่วน Signing & Capabilities ให้เพิ่ม capabilities ต่อไปนี้:

  • Push Notifications
  • Background Modes หลังจากเพิ่ม capability นี้แล้ว ให้เลือกช่องสำหรับ Remote notifications

หากคุณต้องการใช้ Time Sensitive Notifications (iOS 15+) ให้เพิ่ม capability Time Sensitive Notifications ด้วย

3. โค้ดสำหรับเริ่มต้น

Anchor link to

AppDelegate

Anchor link to

เพิ่มโค้ดต่อไปนี้ลงในคลาส AppDelegate ของคุณ:

import SwiftUI
import PushwooshFramework
@main
struct MyApp: App {
// Register AppDelegate as 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 {
// Initialization code
// Set custom delegate for push handling
Pushwoosh.configure.delegate = self
// Register for push notifications
Pushwoosh.configure.registerForPushNotifications()
return true
}
// Handle token received from APNS
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
Pushwoosh.configure.handlePushRegistration(deviceToken)
}
// Handle token receiving error
func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
Pushwoosh.configure.handlePushRegistrationFailure(error)
}
//for silent push notifications
func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable: Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
Pushwoosh.configure.handlePushReceived(userInfo)
completionHandler(.noData)
}
// Fired when a push is received
func pushwoosh(_ pushwoosh: Pushwoosh, onMessageReceived message: PWMessage) {
print("onMessageReceived: ", message.payload!.description)
}
// Fired when a user taps the notification
func pushwoosh(_ pushwoosh: Pushwoosh, onMessageOpened message: PWMessage) {
print("onMessageOpened: ", message.payload!.description)
}
}
struct ContentView: View {
var body: some View {
Text("Pushwoosh with SwiftUI")
.padding()
}
}

Info.plist

Anchor link to

ใน Info.plist ของคุณ:

  • ตั้งค่าคีย์ Pushwoosh_APPID เป็น Pushwoosh Application Code
  • ตั้งค่าคีย์ Pushwoosh_API_TOKEN เป็น Pushwoosh Device API Token

4. การติดตามการส่งข้อความ

Anchor link to

Pushwoosh รองรับการติดตาม event การส่งสำหรับ push notification ผ่าน Notification Service Extension

เพิ่ม Notification Service Extension

Anchor link to
  1. ใน Xcode เลือก File > New > Target…
  2. เลือก Notification Service Extension และกด Next
  3. ป้อนชื่อ target และกด Finish
  4. เมื่อมีข้อความแจ้งให้เปิดใช้งาน ให้กด Cancel

Dependencies สำหรับ Notification Service Extension (สำหรับ CocoaPods เท่านั้น)

Anchor link to

หมายเหตุ: หากคุณใช้ Swift Package Manager ในการจัดการ dependency คุณสามารถข้ามขั้นตอนนี้ได้ เนื่องจาก dependency จะถูกเพิ่มโดยอัตโนมัติ

เปิด Podfile ของคุณและเพิ่ม dependency สำหรับ target:

Podfile
# Uncomment the next line to define a global platform for your project
# platform :ios, '9.0'
target 'MyApp' do
# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!
pod 'PushwooshXCFramework'
end
target 'MyAppNotificationExtension' do
use_frameworks!
pod 'PushwooshXCFramework'
end

รันคำสั่งต่อไปนี้ใน terminal เพื่ออัปเดต dependency:

Terminal window
pod update

เพิ่ม Pushwoosh SDK ไปยัง Notification Service Extension

Anchor link to

แทนที่คลาส NotificationService ที่สร้างขึ้นด้วย subclass ของ PushwooshNotificationServiceExtension จากนั้น Pushwoosh จะจัดการทุกอย่างที่ push ต้องการ — การส่ง event การส่ง, การนับ badge, การดาวน์โหลด media attachment และการ fallback เมื่อ serviceExtensionTimeWillExpire หมดเวลา ไม่จำเป็นต้องใช้โค้ดอื่นใด

import PushwooshFramework
class NotificationService: PushwooshNotificationServiceExtension {}

หมายเหตุ: คุณสามารถข้ามไฟล์ source ทั้งหมดได้ โดยตั้งค่า NSExtensionPrincipalClass ของ extension เป็น PushwooshNotificationServiceExtension ใน Info.plist ของมัน และไม่ต้องเขียนโค้ดใดๆ เลย

ในการแก้ไขการแจ้งเตือนก่อนที่จะแสดง ให้ override didReceive(_:withContentHandler:) เรียก super ด้วย content handler ของคุณเอง แก้ไข content ภายในนั้น แล้วส่งต่อไปยัง handler เดิม Pushwoosh จะยังคงรัน event การส่ง, badge, attachment และ fallback เมื่อหมดเวลา

import UserNotifications
import PushwooshFramework
class NotificationService: PushwooshNotificationServiceExtension {
override func didReceive(_ request: UNNotificationRequest,
withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
super.didReceive(request) { content in
let mutable = (content.mutableCopy() as? UNMutableNotificationContent) ?? content
// Modify the notification content here...
contentHandler(mutable)
}
}
}

Info.plist

Anchor link to

extension จะสืบทอด Pushwoosh_APPID (และคีย์ Pushwoosh_* อื่นๆ) จากแอปโฮสต์ ดังนั้นคุณไม่จำเป็นต้องทำซ้ำใน Info.plist ของ extension เพิ่มคีย์ที่นั่นเฉพาะเมื่อคุณต้องการ override ค่าของโฮสต์

ในการซิงค์การนับ badge และการตั้งค่า reverse-proxy กับแอป ให้แชร์ App Group ระหว่างแอปและ extension เพิ่ม capability App Groups ไปยัง target ทั้งสอง จากนั้นตั้งค่า App Group ID ใน Info.plist ของแอปหลัก:

  • PW_APP_GROUPS_NAME - ตัวระบุ App Group ของคุณ (ตัวอย่างเช่น group.com.example.app)

extension จะสืบทอดค่านี้จากแอปโฮสต์ ดังนั้นคุณไม่จำเป็นต้องทำซ้ำใน Info.plist ของ extension — เพิ่มที่นั่นเฉพาะเพื่อ override โฮสต์ หรืออีกทางหนึ่งคือให้ระบุในโค้ดโดยการ override pushwooshAppGroupsName

5. รันโปรเจกต์

Anchor link to
  1. Build และรันโปรเจกต์
  2. ไปที่ Pushwoosh Control Panel และ ส่ง push notification
  3. คุณควรเห็นการแจ้งเตือนในแอป

การผสานการทำงาน Pushwoosh iOS แบบขยาย

Anchor link to

ณ จุดนี้ คุณได้ผสานการทำงาน SDK เรียบร้อยแล้ว และสามารถส่งและรับ push notification ได้ ตอนนี้เรามาดูฟังก์ชันการทำงานหลักกัน

Push notifications

Anchor link to

ใน Pushwoosh SDK มี callback สองตัวที่ออกแบบมาเพื่อจัดการ push notification:

  • onMessageReceived: เมธอดนี้จะถูกเรียกเมื่อได้รับ push notification
  • onMessageOpened: เมธอดนี้จะถูกเรียกเมื่อผู้ใช้โต้ตอบกับ (เปิด) การแจ้งเตือน

callback เหล่านี้ช่วยให้นักพัฒนาสามารถจัดการการรับและการโต้ตอบของผู้ใช้กับ push notification ภายในแอปพลิเคชันของตนได้

import PushwooshFramework
class AppDelegate: NSObject, UIApplicationDelegate, PWMessagingDelegate {
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
Pushwoosh.configure.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)")
}
}
}

การกำหนดค่าผู้ใช้

Anchor link to

โดยการมุ่งเน้นไปที่พฤติกรรมและความชอบของผู้ใช้แต่ละราย คุณสามารถส่งเนื้อหาที่ปรับให้เป็นส่วนตัว ซึ่งนำไปสู่ความพึงพอใจและความภักดีของผู้ใช้ที่เพิ่มขึ้น

import PushwooshFramework
class Registration {
func afterUserLogin(user: User) {
let pushwoosh = Pushwoosh.configure
// set user ID
if let userId = user.userId {
pushwoosh.setUserId(userId)
}
// set user email
if let userEmail = user.email {
pushwoosh.setEmail(userEmail)
}
// set user SMS number
if let userSmsNumber = user.SmsNumber {
pushwoosh.registerSmsNumber(userSmsNumber)
}
// set user WhatsApp number
if let userWhatsAppNumber = user.WhatsAppNumber {
pushwoosh.registerSmsNumber(userWhatsAppNumber)
}
// setting additional user information as tags for 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
])
}
}
}

Tags คือคู่ของ key-value ที่กำหนดให้กับผู้ใช้หรืออุปกรณ์ ช่วยให้สามารถแบ่งกลุ่มตามคุณลักษณะต่างๆ เช่น ความชอบหรือพฤติกรรม ทำให้สามารถส่งข้อความที่ตรงเป้าหมายได้

import PushwooshFramework
class UpdateUser {
func afterUserUpdateProfile(user: User) {
let pushwoosh = Pushwoosh.configure
// set list of favorite categories
pushwoosh.setTags(["favorite_categories" : user.getFavoriteCategories()])
// set payment information
pushwoosh.setTags([
"is_subscribed": user.isSubscribed(),
"payment_status": user.getPaymentStatus(),
"billing_address": user.getBillingAddress()
])
}
}

Events คือการกระทำหรือเหตุการณ์ที่เกิดขึ้นโดยผู้ใช้ภายในแอป ซึ่งสามารถติดตามเพื่อวิเคราะห์พฤติกรรมและกระตุ้นข้อความหรือการกระทำที่สอดคล้องกัน

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.configure
// Track purchase event
PWInAppManager.shared().postEvent("purchase", withAttributes: [
"product_id": product.getId(),
"product_name": product.getName(),
"price": product.getPrice(),
"quantity": product.getQuantity()
])
// Set user tags
let lastPurchaseDate = Date().timeIntervalSince1970
let lifetimeSpend = getCurrentLifetimeSpend() + product.getPrice()
pushwoosh.setTags([
"last_purchase_date": lastPurchaseDate,
"lifetime_spend": lifetimeSpend
])
}
}

Rich Media

Anchor link to

Rich media หมายถึงเนื้อหาแบบโต้ตอบและมัลติมีเดีย เช่น รูปภาพ วิดีโอ หรือ HTML ที่ใช้ในการแจ้งเตือนและข้อความในแอปเพื่อเพิ่มการมีส่วนร่วมของผู้ใช้

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 will be presented with: \(richMedia.pushPayload!)")
return true
}
func richMediaManager(_ richMediaManager: PWRichMediaManager!, didPresent richMedia: PWRichMedia!) {
print("Rich media has been presented with: \(richMedia.pushPayload!)")
}
func richMediaManager(_ richMediaManager: PWRichMediaManager!, didClose richMedia: PWRichMedia!) {
print("Rich media has been closed with: \(richMedia.pushPayload!)")
}
func richMediaManager(_ richMediaManager: PWRichMediaManager!, presentingDidFailFor richMedia: PWRichMedia!, withError error: (any Error)!) {
print("Failed to present rich media with: \(richMedia.pushPayload!). Error: \(error.localizedDescription)")
}
}

การแก้ไขปัญหา

Anchor link to

ไม่สามารถ build module ‘PushwooshFramework’ ได้

Anchor link to

เมื่อ build โปรเจกต์ของคุณ คุณอาจพบข้อผิดพลาดคล้ายกับ:

Failed to build module 'PushwooshFramework'; this SDK is not supported by the compiler
(the SDK is built with 'Apple Swift version 5.10 (swiftlang-5.10.0.13 clang-1500.3.9.4)',
while this compiler is 'Apple Swift version 6.1.2 effective-5.10 (swiftlang-6.1.2.1.2 clang-1700.0.13.5)')

สาเหตุ: ข้อผิดพลาดนี้ไม่เกี่ยวข้องกับความไม่เข้ากันของเวอร์ชันคอมไพเลอร์ Swift ตั้งแต่ Pushwoosh iOS SDK เวอร์ชัน 6.8.0 เป็นต้นไป SDK จะถูกแบ่งออกเป็นส่วนประกอบหลายส่วนที่โต้ตอบกัน ข้อผิดพลาดเกิดขึ้นเมื่อไม่ได้เพิ่มเฟรมเวิร์กที่จำเป็นทั้งหมดลงในโปรเจกต์ของคุณ

วิธีแก้ไข: ตรวจสอบให้แน่ใจว่าได้เพิ่มเฟรมเวิร์กที่จำเป็นทั้งสี่ตัวลงใน target ของแอปของคุณเมื่อทำการผสานการทำงานผ่าน Swift Package Manager:

  • PushwooshFramework
  • PushwooshCore
  • PushwooshBridge
  • PushwooshLiveActivities

ในการตรวจสอบสิ่งนี้ใน Xcode:

  1. เลือกโปรเจกต์ของคุณใน Project Navigator
  2. เลือก target ของแอปของคุณ
  3. ไปที่ General > Frameworks, Libraries, and Embedded Content
  4. ยืนยันว่ามีเฟรมเวิร์กทั้งสี่ตัวอยู่ในรายการ

หากคุณพบปัญหาใดๆ ในระหว่างกระบวนการผสานการทำงาน โปรดดูที่ส่วน การสนับสนุนและชุมชน