Saltar al contenido

Guía de integración básica del SDK de iOS 7.0+

Esta sección contiene información sobre cómo integrar el SDK de Pushwoosh en su aplicación de iOS.

Prerrequisitos

Anchor link to

Para integrar el SDK de Pushwoosh para iOS en su aplicación, necesitará lo siguiente:

Pasos de integración

Anchor link to

1. Instalación

Anchor link to

Puede integrar el SDK de Pushwoosh en su aplicación utilizando Swift Package Manager o CocoaPods.

Swift Package Manager

Anchor link to

En la sección Package Dependencies, agregue el siguiente paquete:

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

Para usar el SDK de Pushwoosh para iOS, asegúrese de agregar los siguientes tres frameworks al target de su aplicación al integrar a través de Swift Package Manager:

  • PushwooshFramework
  • PushwooshCore
  • PushwooshBridge

Abra su Podfile y agregue la dependencia:

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

Luego, en la terminal, ejecute el siguiente comando para instalar las dependencias:

Terminal window
pod install

2. Capacidades

Anchor link to

Para habilitar las Notificaciones Push en su proyecto, necesita agregar ciertas capacidades.

En la sección Signing & Capabilities, agregue las siguientes capacidades:

  • Push Notifications
  • Background Modes. Después de agregar esta capacidad, marque la casilla para Remote notifications.

Si tiene la intención de usar Notificaciones Sensibles al Tiempo (iOS 15+), agregue también la capacidad de Time Sensitive Notifications.

3. Código de inicialización

Anchor link to

AppDelegate

Anchor link to

Agregue el siguiente código a su clase AppDelegate:

import SwiftUI
import PushwooshFramework
@main
struct MyApp: App {
// Registrar AppDelegate como 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 {
// Código de inicialización
// Establecer delegado personalizado para el manejo de push
Pushwoosh.configure.delegate = self
// Registrarse para notificaciones push
Pushwoosh.configure.registerForPushNotifications()
return true
}
// Manejar token recibido de APNS
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
Pushwoosh.configure.handlePushRegistration(deviceToken)
}
// Manejar error al recibir el token
func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
Pushwoosh.configure.handlePushRegistrationFailure(error)
}
//para notificaciones push silenciosas
func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable: Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
Pushwoosh.configure.handlePushReceived(userInfo)
completionHandler(.noData)
}
// Se dispara cuando se recibe un push
func pushwoosh(_ pushwoosh: Pushwoosh, onMessageReceived message: PWMessage) {
print("onMessageReceived: ", message.payload!.description)
}
// Se dispara cuando un usuario toca la notificación
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

En su Info.plist:

4. Seguimiento de la entrega de mensajes

Anchor link to

Pushwoosh admite el seguimiento de eventos de entrega para notificaciones push a través de la Extensión de Servicio de Notificación

Agregar Extensión de Servicio de Notificación

Anchor link to
  1. En Xcode, seleccione Archivo > Nuevo > Target…
  2. Elija Extensión de Servicio de Notificación y presione Siguiente.
  3. Ingrese el nombre del target y presione Finalizar.
  4. Cuando se le pida la activación, presione Cancelar.

Dependencias para la Extensión de Servicio de Notificación (solo CocoaPods)

Anchor link to

Nota: Si está utilizando Swift Package Manager para gestionar las dependencias, puede omitir este paso, ya que las dependencias se agregan automáticamente.

Abra su Podfile y agregue la dependencia para el 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

Ejecute el siguiente comando en la terminal para actualizar las dependencias:

Terminal window
pod update

Agregar el SDK de Pushwoosh a la Extensión de Servicio de Notificación

Anchor link to

Reemplace la clase NotificationService generada con una subclase de PushwooshNotificationServiceExtension. Pushwoosh se encarga de todo lo que necesita un push: enviar el evento de entrega, contar las insignias, descargar el adjunto multimedia y el fallback de tiempo de espera obligatorio serviceExtensionTimeWillExpire. No se requiere ningún otro código.

import PushwooshFramework
class NotificationService: PushwooshNotificationServiceExtension {}

Nota: puede omitir el archivo fuente por completo — establezca la NSExtensionPrincipalClass de la extensión en PushwooshNotificationServiceExtension en su Info.plist y no escriba ningún código.

Para modificar la notificación antes de que se muestre, anule didReceive(_:withContentHandler:), llame a super con su propio manejador de contenido, mute el contenido dentro de él y luego reenvíelo al manejador original. Pushwoosh seguirá ejecutando el evento de entrega, la insignia, el adjunto y el fallback de tiempo de espera.

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
// Modifique el contenido de la notificación aquí...
contentHandler(mutable)
}
}
}

Info.plist

Anchor link to

La extensión hereda Pushwoosh_APPID (y otras claves Pushwoosh_*) de la aplicación anfitriona, por lo que no necesita duplicarlas en el Info.plist de la extensión. Agregue una clave allí solo cuando desee anular el valor del anfitrión.

Para sincronizar el recuento de insignias y la configuración del proxy inverso con la aplicación, comparta un Grupo de Aplicaciones entre la aplicación y la extensión. Agregue la capacidad de Grupos de Aplicaciones a ambos targets, luego establezca el ID del Grupo de Aplicaciones en el Info.plist de la aplicación principal:

  • PW_APP_GROUPS_NAME - su identificador de Grupo de Aplicaciones (por ejemplo, group.com.example.app).

La extensión hereda este valor de la aplicación anfitriona, por lo que no necesita repetirlo en el Info.plist de la extensión — agréguelo allí solo para anular el anfitrión. Alternativamente, proporciónelo en el código anulando pushwooshAppGroupsName.

5. Ejecutar el proyecto

Anchor link to
  1. Compile y ejecute el proyecto.
  2. Vaya al Panel de Control de Pushwoosh y envíe una notificación push.
  3. Debería ver la notificación en la aplicación.

Integración extendida de Pushwoosh para iOS

Anchor link to

En esta etapa, ya ha integrado el SDK y puede enviar y recibir notificaciones push. Ahora, exploremos la funcionalidad principal

Notificaciones push

Anchor link to

En el SDK de Pushwoosh, hay dos callbacks diseñados para manejar las notificaciones push:

  • onMessageReceived: Este método se invoca cuando se recibe una notificación push.
  • onMessageOpened: Este método se llama cuando el usuario interactúa con (abre) la notificación

Estos callbacks permiten a los desarrolladores gestionar la recepción y la interacción del usuario con las notificaciones push dentro de sus aplicaciones

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

Configuración de usuario

Anchor link to

Al centrarse en el comportamiento y las preferencias individuales de los usuarios, puede ofrecer contenido personalizado, lo que conduce a una mayor satisfacción y lealtad del usuario

import PushwooshFramework
class Registration {
func afterUserLogin(user: User) {
let pushwoosh = Pushwoosh.configure
// establecer ID de usuario
if let userId = user.userId {
pushwoosh.setUserId(userId)
}
// establecer email de usuario
if let userEmail = user.email {
pushwoosh.setEmail(userEmail)
}
// establecer número de SMS del usuario
if let userSmsNumber = user.SmsNumber {
pushwoosh.registerSmsNumber(userSmsNumber)
}
// establecer número de WhatsApp del usuario
if let userWhatsAppNumber = user.WhatsAppNumber {
pushwoosh.registerSmsNumber(userWhatsAppNumber)
}
// establecer información adicional del usuario como etiquetas para 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
])
}
}
}

Las etiquetas son pares clave-valor asignados a usuarios o dispositivos, lo que permite la segmentación basada en atributos como preferencias o comportamiento, habilitando la mensajería dirigida.

import PushwooshFramework
class UpdateUser {
func afterUserUpdateProfile(user: User) {
let pushwoosh = Pushwoosh.configure
// establecer lista de categorías favoritas
pushwoosh.setTags(["favorite_categories" : user.getFavoriteCategories()])
// establecer información de pago
pushwoosh.setTags([
"is_subscribed": user.isSubscribed(),
"payment_status": user.getPaymentStatus(),
"billing_address": user.getBillingAddress()
])
}
}

Los eventos son acciones u ocurrencias específicas del usuario dentro de la aplicación que se pueden rastrear para analizar el comportamiento y desencadenar mensajes o acciones correspondientes

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
// Rastrear evento de compra
PWInAppManager.shared().postEvent("purchase", withAttributes: [
"product_id": product.getId(),
"product_name": product.getName(),
"price": product.getPrice(),
"quantity": product.getQuantity()
])
// Establecer etiquetas de usuario
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 se refiere a contenido interactivo y multimedia, como imágenes, videos o HTML, utilizado en notificaciones y mensajes in-app para mejorar la participación del usuario

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

Solución de problemas

Anchor link to

Error al compilar el módulo ‘PushwooshFramework’

Anchor link to

Al compilar su proyecto, puede encontrar un error similar a:

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)')

Causa: Este error no está relacionado con la incompatibilidad de la versión del compilador de Swift. A partir de la versión 6.8.0 del SDK de Pushwoosh para iOS, el SDK está modularizado en varios componentes que interactúan entre sí. El error ocurre cuando no todos los frameworks requeridos se agregan a su proyecto.

Solución: Asegúrese de que los cuatro frameworks requeridos se agreguen al target de su aplicación al integrar a través de Swift Package Manager:

  • PushwooshFramework
  • PushwooshCore
  • PushwooshBridge
  • PushwooshLiveActivities

Para verificar esto en Xcode:

  1. Seleccione su proyecto en el Navegador de Proyectos
  2. Seleccione el target de su aplicación
  3. Vaya a General > Frameworks, Libraries, and Embedded Content
  4. Confirme que los cuatro frameworks están en la lista

Si encuentra algún problema durante el proceso de integración, consulte la sección de soporte y comunidad.