跳到内容

Capacitor SDK 快速入门

通过这个快速简单的示例开始使用 Pushwoosh Capacitor SDK。

前提条件

Anchor link to

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

下载示例项目

Anchor link to

克隆 SDK 仓库:

Terminal window
git clone https://github.com/Pushwoosh/pushwoosh-capacitor-plugin.git

导航到插件目录:

Terminal window
cd pushwoosh-capacitor-plugin

构建插件

Anchor link to

在运行示例应用之前,您需要构建 Capacitor 插件。 安装插件依赖项:

Terminal window
npm i

构建插件:

Terminal window
npm run build

配置示例应用

Anchor link to

导航到示例应用目录:

Terminal window
cd example

安装应用依赖项:

Terminal window
npm i

构建 Web 资源:

Terminal window
npm run build

打开 src/js/example.js 并更新 Pushwoosh.onDeviceReady 调用:

Pushwoosh.onDeviceReady({
projectid: "__YOUR_FCM_SENDER_ID__",
appid: "__YOUR_APP_CODE__"
});

其中:

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

1. 安装 CocoaPods 依赖项
Anchor link to

导航到 iOS 平台目录并安装 CocoaPods 依赖项:

Terminal window
cd ios/App
pod install --repo-update
cd ../..
2. 将 Capacitor 同步到 iOS
Anchor link to

安装 CocoaPods 后,同步 Capacitor 配置:

Terminal window
npx cap sync ios
3. 打开 iOS 项目
Anchor link to

在 Xcode 中打开项目:

Terminal window
npx cap open ios
4. 设置 Bundle Identifier
Anchor link to

在 Xcode 中,将 Bundle Identifier 设置为您的应用的包名(例如 com.example.pushwoosh)。

5. 添加功能
Anchor link to

要启用推送通知,您需要添加某些功能。

Signing & Capabilities 部分,添加以下功能:

  • 推送通知
  • 后台模式。添加此功能后,选中 Remote notifications 复选框。
6. 设置 API 令牌
Anchor link to

在 Xcode 中打开 ios/App/App/Info.plist 并使用您的 Pushwoosh Device API Token 添加以下条目:

Info.plist
<key>Pushwoosh_API_TOKEN</key>
<string>__YOUR_PUSHWOOSH_DEVICE_API_TOKEN__</string>
1. 将 Capacitor 同步到 Android
Anchor link to

将 Capacitor 配置同步到 Android 平台:

Terminal window
npx cap sync android
2. 设置 google-services.json
Anchor link to

将您的 google-services.json 文件复制到 android/app 目录。

3. 设置包名
Anchor link to

打开 android/app/build.gradle 并将 applicationId 设置为您的应用的包名(例如 com.example.pushwoosh)。

4. 设置 API 令牌
Anchor link to

打开您的 android/app/src/main/AndroidManifest.xml 文件,并在 <application> 标签内添加以下元数据:

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

__YOUR_PUSHWOOSH_DEVICE_API_TOKEN__ 替换为您的 Pushwoosh Device API Token

5. 打开 Android 项目
Anchor link to

在 Android Studio 中打开项目:

Terminal window
npx cap open android

运行项目

Anchor link to
  1. 构建并运行项目。
  2. 点击 “Click Me!” 按钮。
  3. 授予推送通知权限。设备将在 Pushwoosh 注册。

发送推送通知

Anchor link to

返回 Pushwoosh 控制面板并向您注册的设备发送推送通知