Guía de integración básica del SDK de Cordova

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

Prerrequisitos

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

Requisitos

• Una cuenta de Pushwoosh.
• Un proyecto de Pushwoosh configurado en su cuenta.
• Para la integración con iOS:
  • Una plataforma iOS configurada para enviar notificaciones push. Recomendamos usar la configuración de autenticación basada en token como el enfoque más simple.
  • Establezca el Gateway en Sandbox para enviar notificaciones push a un simulador.
• Para la integración con Android:
  • Una plataforma Android configurada
  • El project number (también conocido como Sender ID), el archivo google-services.json y el package name de su proyecto de Firebase.
  • Un proyecto de Firebase conectado a su aplicación de Android. Siga la guía de configuración de Firebase si es necesario.
• Su Pushwoosh Application Code y Pushwoosh Device API Token desde el Panel de Control de Pushwoosh para su aplicación.

Pasos de integración

1. Añadir la dependencia del SDK de Cordova de Pushwoosh

Añada la dependencia del SDK de Cordova de Pushwoosh a su proyecto:

cordova plugin add pushwoosh-cordova-plugin

2. Inicialización del SDK de Cordova

En el componente raíz de su archivo index.js:

• Inicialice el SDK de Pushwoosh.
• Llame a registerDevice() en su lógica de inicialización para registrarse para recibir notificaciones push.

index.js

function onDeviceReady() {
    var pushwoosh = cordova.require("pushwoosh-cordova-plugin.PushNotification");

    pushwoosh.onDeviceReady({
        appid: "__YOUR_APP_ID__",
        projectid: "__YOUR_FCM_SENDER_ID__"
    });

    pushwoosh.registerDevice(
    function(status) {
        var pushToken = status.pushToken;
        // Handle successful registration
    },
    function(status) {
        // Handle registration error
  }
);

Donde:

• __YOUR_APP_ID__ es el código de la aplicación del Panel de Control de Pushwoosh.
• __YOUR_FCM_SENDER_ID__ es el número de proyecto de Firebase de la Consola de Firebase.

3. Configuración nativa de iOS

3.1 Capacidades

Para habilitar las Notificaciones Push en su proyecto, necesita añadir ciertas capacidades.

En la sección Signing & Capabilities, añada las siguientes capacidades:

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

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

3.2 Info.plist

En su Runner/Info.plist establezca la clave __PUSHWOOSH_DEVICE_API_TOKEN__ al Pushwoosh Device API Token:

info.plist

<key>Pushwoosh_API_TOKEN</key>
<string>__PUSHWOOSH_DEVICE_API_TOKEN__</string>

3.3 Seguimiento de la entrega de mensajes

Debe añadir un objetivo de Extensión de Servicio de Notificación a su proyecto. Esto es esencial para un seguimiento preciso de la entrega y para funciones como Rich Media en iOS.

Siga los pasos de la guía nativa para añadir el objetivo de la extensión y el código de Pushwoosh necesario dentro de ella.

4. Configuración nativa de Android

4.1 Instalar dependencias

Asegúrese de que las dependencias y plugins requeridos se añaden a sus scripts de Gradle:

Añada el plugin de Gradle de Google Services a las dependencias de su build.gradle a nivel de proyecto:

android/build.gradle

buildscript {
  dependencies {
    classpath 'com.google.gms:google-services:4.3.15'
  }
}

Aplique el plugin en su archivo build.gradle a nivel de aplicación:

app/build.gradle

apply plugin: 'com.google.gms.google-services'

4.2 Añadir archivo de configuración de Firebase

Coloque el archivo google-services.json en la carpeta android/app de su directorio de proyecto.

4.3 Añadir metadatos de Pushwoosh

En su main/AndroidManifest.xml añada el Pushwoosh Device API Token dentro de la etiqueta <application>:

AndroidManifest.xml

<meta-data android:name="com.pushwoosh.apitoken" android:value="__YOUR_DEVICE_API_TOKEN__" />

Importante: Asegúrese de dar al token acceso a la aplicación correcta en su Panel de Control de Pushwoosh. Aprenda más

5. Ejecutar el proyecto

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

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

Escuchadores de eventos de notificaciones push

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

• El evento onPushReceived se dispara cuando se recibe una notificación push
• El evento onPushAccepted se dispara cuando un usuario abre una notificación

Debe configurar estos escuchadores de eventos justo después de la inicialización del SDK al iniciar la aplicación:

index.js

class PushwooshNotificationHandler {
  setupPushListeners() {

    document.addEventListener('push-receive',
      function(event) {
        console.log("Push received: " + event.notification.message);
      }
    );

    document.addEventListener('push-notification',
      function(event) {
        console.log("Push accepted: " + event.notification.message);
      }
    );
  }
}

Configuración de usuario

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

class Registration {
  afterUserLogin(user) {

    // Set user ID
    pushwoosh.setUserId(user.getId());

    // Setting additional user information as tags for Pushwoosh
    pushwoosh.setTags({
      "age": user.getAge(),
      "name": user.getName(),
      "last_login": user.getLastLoginDate()
    });
  }
}

Etiquetas

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

class UpdateUser {
  afterUserUpdateProfile(user) {

    // Set list of favorite categories
    pushwoosh.setTags({
      "favorite_categories": user.getFavoriteCategoriesList()
    });

    // Set payment information
    pushwoosh.setTags({
      "is_subscribed": user.isSubscribed(),
      "payment_status": user.getPaymentStatus(),
      "billing_address": user.getBillingAddress()
    });
  }
}

Eventos

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 los mensajes o acciones correspondientes

class Registration {

  // Track login event
  afterUserLogin(user) {
    pushwoosh.postEvent("login", {
      "name": user.getName(),
      "last_login": user.getLastLoginDate()
    });
  }

  // Track purchase event
  afterUserPurchase(product) {
    pushwoosh.postEvent("purchase", {
      "product_id": product.getId(),
      "product_name": product.getName(),
      "price": product.getPrice(),
      "quantity": product.getQuantity()
    });
  }
}

Solución de problemas

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