Capacitor SDK 基础集成指南

本节包含有关如何将 Pushwoosh Capacitor SDK 集成到您的应用程序中的信息。

先决条件

要将 Pushwoosh Capacitor SDK 集成到您的应用中，您需要满足以下条件：

集成步骤

1. 添加 Pushwoosh Capacitor SDK 依赖

将 Pushwoosh Capacitor SDK 依赖项添加到您的项目中：

npm install pushwoosh-capacitor-plugin

同步 Capacitor 配置：

npx cap sync

2. Capacitor SDK 初始化

在您的主 JavaScript 文件中，导入并初始化 Pushwoosh SDK：

import { Pushwoosh } from 'pushwoosh-capacitor-plugin';

// Initialize the SDK
Pushwoosh.onDeviceReady({
    appid: "__YOUR_APP_CODE__",
    projectid: "__YOUR_FCM_SENDER_ID__"
});

// Register for push notifications
Pushwoosh.registerDevice()
    .then(result => {
        console.log("Push token:", result.pushToken);
        // Handle successful registration
    })
    .catch(error => {
        console.error("Failed to register device:", error);
        // Handle registration error
    });

其中：

__YOUR_APP_ID__ 是来自 Pushwoosh 控制面板的应用程序代码。
__YOUR_FCM_SENDER_ID__ 是来自 Firebase 控制台的 Firebase 项目编号。

3. iOS 原生设置

3.1 功能 (Capabilities)

要在您的项目中启用推送通知，您需要添加某些功能。

在 Signing & Capabilities 部分，添加以下功能：

Push Notifications
Background Modes。添加此功能后，勾选 Remote notifications 复选框。

如果您打算使用 Time Sensitive Notifications (iOS 15+)，还需添加 Time Sensitive Notifications 功能。

3.2 Info.plist

在您的 Runner/Info.plist 中，将 __PUSHWOOSH_DEVICE_API_TOKEN__ 键设置为 Pushwoosh Device API Token：

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

3.3 消息送达跟踪

您必须向您的项目添加一个 Notification Service Extension 目标。这对于准确的送达跟踪和 iOS 上的 Rich Media 等功能至关重要。

请遵循原生指南中的步骤来添加扩展目标并在其中添加必要的 Pushwoosh 代码。

4. Android 原生设置

4.1 安装依赖

确保所需的依赖项和插件已添加到您的 Gradle 脚本中：

将 Google Services Gradle 插件添加到您的项目级 build.gradle 依赖项中：

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

在您的应用级 build.gradle 文件中应用该插件：

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

4.2 添加 Firebase 配置文件

将 google-services.json 文件放入您项目目录的 android/app 文件夹中。

4.3 添加 Pushwoosh 元数据

在您的 main/AndroidManifest.xml 文件中，在 <application> 标签内添加 Pushwoosh Device API Token：

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

重要提示： 请确保在您的 Pushwoosh 控制面板中为该令牌授予对正确应用的访问权限。了解更多

5. 运行项目

构建并运行项目。
前往 Pushwoosh 控制面板并发送一条推送通知。
您应该会在应用中看到该通知。

扩展集成

至此，您已经集成了 SDK，可以发送和接收推送通知。现在，让我们来探索核心功能。

推送通知事件监听器

在 Pushwoosh Capacitor SDK 中，有两个用于处理推送通知的回调方法：

pushReceivedCallback 在收到推送通知时触发
pushOpenedCallback 在用户打开通知时触发

您应该在 SDK 初始化后立即设置这些回调：

import { Pushwoosh } from 'pushwoosh-capacitor-plugin';

// Set up push received callback
await Pushwoosh.pushReceivedCallback((notification, err) => {
    if (err) {
        console.error("Failed to process received notification:", err);
    } else {
        console.log("Push received:", JSON.stringify(notification));
        // Handle the received notification
    }
});

// Set up push opened callback
await Pushwoosh.pushOpenedCallback((notification, err) => {
    if (err) {
        console.error("Failed to process opened notification:", err);
    } else {
        console.log("Push opened:", JSON.stringify(notification));
        // Handle the opened notification
    }
});

用户配置

通过关注个体用户的行为和偏好，您可以提供个性化内容，从而提高用户满意度和忠诚度。

import { Pushwoosh } from 'pushwoosh-capacitor-plugin';

class Registration {
  async afterUserLogin(user) {

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

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

标签 (Tags)

标签是分配给用户或设备的键值对，允许根据偏好或行为等属性进行分段，从而实现有针对性的消息传递。

import { Pushwoosh } from 'pushwoosh-capacitor-plugin';

class UpdateUser {
 async afterUserUpdateProfile(user) {

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

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

事件 (Events)

事件是应用内特定的用户操作或发生的事情，可以被跟踪以分析行为并触发相应的消息或操作。

import { Pushwoosh } from 'pushwoosh-capacitor-plugin';

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()
    });
  }
}

故障排除

如果您在集成过程中遇到任何问题，请参阅支持和社区部分。