सामग्री पर जाएं

iOS SDK बेसिक इंटीग्रेशन गाइड

इस सेक्शन में Pushwoosh SDK को आपके iOS एप्लिकेशन में इंटीग्रेट करने के तरीके के बारे में जानकारी है।

पूर्वापेक्षाएँ

Anchor link to

Pushwoosh iOS SDK को अपने ऐप में इंटीग्रेट करने के लिए, आपको निम्नलिखित की आवश्यकता होगी:

इंटीग्रेशन के चरण

Anchor link to

1. इंस्टॉलेशन

Anchor link to

आप Swift Package Manager या CocoaPods का उपयोग करके Pushwoosh SDK को अपने एप्लिकेशन में इंटीग्रेट कर सकते हैं।

Swift Package Manager

Anchor link to

Package Dependencies सेक्शन में, निम्नलिखित पैकेज जोड़ें:

https://github.com/Pushwoosh/Pushwoosh-XCFramework

Pushwoosh iOS SDK का उपयोग करने के लिए, सुनिश्चित करें कि Swift Package Manager के माध्यम से इंटीग्रेट करते समय आप अपने ऐप टारगेट में निम्नलिखित चार फ्रेमवर्क जोड़ते हैं:

  • PushwooshFramework
  • PushwooshCore
  • PushwooshBridge
  • PushwooshLiveActivities

अपना Podfile खोलें और डिपेंडेंसी जोड़ें:

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 window
pod install

2. कैपेबिलिटीज़

Anchor link to

अपने प्रोजेक्ट में पुश नोटिफिकेशन सक्षम करने के लिए, आपको कुछ कैपेबिलिटीज़ जोड़ने की आवश्यकता है।

Signing & Capabilities सेक्शन में, निम्नलिखित कैपेबिलिटीज़ जोड़ें:

  • Push Notifications
  • Background Modes। इस कैपेबिलिटी को जोड़ने के बाद, Remote notifications के लिए बॉक्स को चेक करें।

यदि आप टाइम सेंसिटिव नोटिफिकेशन (iOS 15+) का उपयोग करना चाहते हैं, तो 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.sharedInstance().delegate = self
// Register for push notifications
Pushwoosh.sharedInstance().registerForPushNotifications()
return true
}
// Handle token received from APNS
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
Pushwoosh.sharedInstance().handlePushRegistration(deviceToken)
}
// Handle token receiving error
func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
Pushwoosh.sharedInstance().handlePushRegistrationFailure(error)
}
//for silent push notifications
func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable: Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
Pushwoosh.sharedInstance().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 की (key) को Pushwoosh एप्लिकेशन कोड पर सेट करें।
  • Pushwoosh_API_TOKEN की (key) को Pushwoosh डिवाइस API टोकन पर सेट करें।

4. संदेश डिलीवरी ट्रैकिंग

Anchor link to

Pushwoosh, Notification Service Extension के माध्यम से पुश नोटिफिकेशन के लिए डिलीवरी इवेंट्स की ट्रैकिंग का समर्थन करता है।

Notification Service Extension जोड़ें

Anchor link to
  1. Xcode में, File > New > Target… चुनें।
  2. Notification Service Extension चुनें और Next दबाएँ।
  3. टारगेट का नाम दर्ज करें और Finish दबाएँ।
  4. जब एक्टिवेशन के लिए कहा जाए, तो Cancel दबाएँ।

Notification Service Extension के लिए डिपेंडेंसीज़ (केवल CocoaPods)

Anchor link to

ध्यान दें: यदि आप डिपेंडेंसीज़ को मैनेज करने के लिए Swift Package Manager का उपयोग कर रहे हैं, तो आप इस चरण को छोड़ सकते हैं, क्योंकि डिपेंडेंसीज़ स्वचालित रूप से जुड़ जाती हैं।

अपना Podfile खोलें और टारगेट के लिए डिपेंडेंसी जोड़ें:

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 window
pod update

Notification Service Extension में Pushwoosh SDK जोड़ें

Anchor link to

यह कोड आपको अपने नोटिफिकेशन एक्सटेंशन के भीतर नोटिफिकेशन को इंटरसेप्ट और प्रोसेस करने की अनुमति देता है।

import UserNotifications
import 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 {
// Modify the notification content here...
contentHandler(bestAttemptContent)
}
}
override func serviceExtensionTimeWillExpire() {
// Called just before the extension will be terminated by the system.
// Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used.
if let contentHandler = contentHandler, let bestAttemptContent = bestAttemptContent {
contentHandler(bestAttemptContent)
}
}
}

Info.plist

Anchor link to

अपने Notification Service Extension के Info.plist में, जोड़ें:

  • Pushwoosh_APPID - आपका एप्लिकेशन कोड।

5. प्रोजेक्ट चलाएँ

Anchor link to
  1. प्रोजेक्ट को बिल्ड और रन करें।
  2. Pushwoosh कंट्रोल पैनल पर जाएँ और एक पुश नोटिफिकेशन भेजें
  3. आपको ऐप में नोटिफिकेशन दिखना चाहिए।

विस्तारित Pushwoosh iOS इंटीग्रेशन

Anchor link to

इस स्तर पर, आपने SDK को पहले ही इंटीग्रेट कर लिया है और आप पुश नोटिफिकेशन भेज और प्राप्त कर सकते हैं। अब, आइए मुख्य कार्यक्षमता का पता लगाएँ।

पुश नोटिफिकेशन

Anchor link to

Pushwoosh SDK में, पुश नोटिफिकेशन को संभालने के लिए दो कॉलबैक डिज़ाइन किए गए हैं:

  • onMessageReceived: यह मेथड तब कॉल किया जाता है जब कोई पुश नोटिफिकेशन प्राप्त होता है।
  • onMessageOpened: यह मेथड तब कॉल किया जाता है जब यूज़र नोटिफिकेशन के साथ इंटरैक्ट करता है (खोलता है)।

ये कॉलबैक डेवलपर्स को अपने एप्लिकेशन के भीतर पुश नोटिफिकेशन की प्राप्ति और यूज़र इंटरैक्शन को मैनेज करने में सक्षम बनाते हैं।

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)")
}
}
}

यूज़र कॉन्फ़िगरेशन

Anchor link to

व्यक्तिगत यूज़र के व्यवहार और वरीयताओं पर ध्यान केंद्रित करके, आप व्यक्तिगत कंटेंट दे सकते हैं, जिससे यूज़र की संतुष्टि और वफादारी बढ़ती है।

import PushwooshFramework
class Registration {
func afterUserLogin(user: User) {
let pushwoosh = Pushwoosh.sharedInstance()
// 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
])
}
}
}

टैग्स

Anchor link to

टैग्स यूज़र्स या डिवाइस को असाइन किए गए की-वैल्यू पेयर होते हैं, जो वरीयताओं या व्यवहार जैसे एट्रिब्यूट्स के आधार पर सेगमेंटेशन की अनुमति देते हैं, जिससे लक्षित मैसेजिंग संभव होती है।

import PushwooshFramework
class UpdateUser {
func afterUserUpdateProfile(user: User) {
let pushwoosh = Pushwoosh.sharedInstance()
// 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()
])
}
}

इवेंट्स

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()
// 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
])
}
}

रिच मीडिया

Anchor link to

रिच मीडिया इंटरैक्टिव और मल्टीमीडिया कंटेंट को संदर्भित करता है, जैसे कि इमेज, वीडियो, या 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

’PushwooshFramework’ मॉड्यूल बनाने में विफल

Anchor link to

अपने प्रोजेक्ट को बनाते समय, आपको निम्न के समान एक त्रुटि का सामना करना पड़ सकता है:

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 को कई घटकों में मॉड्यूलर किया गया है जो एक दूसरे के साथ इंटरैक्ट करते हैं। त्रुटि तब होती है जब आपके प्रोजेक्ट में सभी आवश्यक फ्रेमवर्क नहीं जोड़े जाते हैं।

समाधान: सुनिश्चित करें कि Swift Package Manager के माध्यम से इंटीग्रेट करते समय सभी चार आवश्यक फ्रेमवर्क आपके ऐप टारगेट में जोड़े गए हैं:

  • PushwooshFramework
  • PushwooshCore
  • PushwooshBridge
  • PushwooshLiveActivities

Xcode में इसे सत्यापित करने के लिए:

  1. प्रोजेक्ट नेविगेटर में अपना प्रोजेक्ट चुनें
  2. अपना ऐप टारगेट चुनें
  3. General > Frameworks, Libraries, and Embedded Content पर जाएँ
  4. पुष्टि करें कि सभी चार फ्रेमवर्क सूचीबद्ध हैं

यदि आपको इंटीग्रेशन प्रक्रिया के दौरान कोई समस्या आती है, तो कृपया समर्थन और समुदाय सेक्शन देखें।