capacitor-jpush-core

v0.0.4

Published

11 days ago

极光推送Capacitor插件，支持Android和iOS平台基本推送功能

Downloads

363

0High
0Medium
0Low

hybrid_engineer

capacitor jpush core 极光推送 plugin native android ios jiguang push notification 推送通知

capacitor-jpush-core

极光推送Capacitor插件，支持Android和iOS平台的一些简单功能。

Install

npm install capacitor-jpush-core
npx cap sync

平台支持

| 功能 | iOS | Android | 备注 | |------|-----|---------|------| | 设置别名 | ✅ | ✅ | | | 删除别名 | ✅ | ✅ | | | 获取注册ID | ✅ | ✅ | | | 设置角标 | ✅ | ❌ | 未集成厂商通道 | | 通知接收 | ✅ | ✅ | | | 通知点击回调 | ✅ | ✅ | Android仅限App运行时 | | 自定义消息 | ✅ | ✅ | | | 权限检查 | ✅ | ✅ | | | 权限请求 | ✅ | ✅ | |

Capacitor.config 配置

{
    "plugins": {
        "JPush": {
            // 极光推送AppKey
            "appKey": "your_app_key",
            // 推送通道，默认值为default, 没统计需求随便填
            "channel": "default",
            // 是否为生产环境，默认值为false
            "production": false,
            // 进入App时是否自动清除角标，默认值为false
            "activeClearBadge": false,
            // 是否跟随App启动时自动注册极光推送，默认值为false
            "iosAutoRegister": true
        }
    }
}

iOS 准备工作

xcode 配置

在 sign & capabilities 中点击 + capability 按钮，搜索并添加 Background Modes 和 Push Notifications 选项。
在 Background Modes 中勾选 Remote notifications 子项。

AppDelegate 基础配置

在主工程的AppDelegate以下代理方法中，添加发送通知的代码

class AppDelegate: UIResponder, UIApplicationDelegate {

    func applicationDidBecomeActive(_ application: UIApplication) {
        // 从后台到前台，包括冷启动都会进入这个方法
        NotificationCenter.default.post(name: UIApplication.didBecomeActiveNotification, object: nil)
    }

    func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
        // 通知设备注册成功的消息
        NotificationCenter.default.post(name: .capacitorDidRegisterForRemoteNotifications, object: deviceToken)
    }
    func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
        // 通知设备注册失败的消息
        NotificationCenter.default.post(name: .capacitorDidFailToRegisterForRemoteNotifications, object: error)
    }
}

推送唤醒

当应用在后台收到远程推送时，会触发 application(_:didReceiveRemoteNotification:fetchCompletionHandler:) 方法。如果需要增加该消息处理，需要在 AppDelegate 中添加以下代码和通知扩展，插件就能把该推送传给web层的接收消息监听JPushEventName.NotificationReceived。

class AppDelegate: UIResponder, UIApplicationDelegate {
    func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {

        NotificationCenter.default.post(name: .didReceiveRemotePush, object: userInfo)
        completionHandler(.newData)
    }
}
// 注意: 包括这个事件的定义也要复制进去
extension NSNotification.Name {
    static let didReceiveRemotePush = NSNotification.Name("CapacitorJPushCoreBackgroundPush")
}

注意：后端发的推送需要配置推送唤醒

未运行时点击推送消息

如果需要处理回调的话，Capacitor.config 配置文件需要设置iosAutoRegister为true。必须在启动时就注册极光推送，否则本次点击推送消息不会触发后续在应用中添加的监听。

{
    "plugins": {
        "JPush": {
            "iosAutoRegister": true
        }
    }
}

Android 准备工作

我们使用capacitor配置，但是这里JPush需要一些元数据的占位符。在 Android 项目的 app/build.gradle 文件中，找到 android.defaultConfig 或对应 productFlavor 块，添加以下 manifestPlaceholders 配置：

defaultConfig {
    manifestPlaceholders = [
        JPUSH_PKGNAME: applicationId,
        JPUSH_APPKEY: "",
        JPUSH_CHANNEL: "default"
    ]
}

API

setupJPush()

setupJPush() => Promise<void>

getRegistrationID()

getRegistrationID() => Promise<RegistrationIDResult>

Returns: Promise<RegistrationIDResult>

setAlias(...)

setAlias(options: AliasOptions) => Promise<void>

| Param | Type | | ------------- | ----------------------------------------------------- | | options | AliasOptions |

deleteAlias(...)

deleteAlias(options?: DeleteAlias | undefined) => Promise<void>

| Param | Type | | ------------- | --------------------------------------------------- | | options | DeleteAlias |

setTags(...)

setTags(options: SetTagsOptions) => Promise<void>

| Param | Type | | ------------- | --------------------------------------------------------- | | options | SetTagsOptions |

addTags(...)

addTags(options: SetTagsOptions) => Promise<void>

| Param | Type | | ------------- | --------------------------------------------------------- | | options | SetTagsOptions |

deleteTags(...)

deleteTags(options: SetTagsOptions) => Promise<void>

| Param | Type | | ------------- | --------------------------------------------------------- | | options | SetTagsOptions |

cleanTags()

cleanTags() => Promise<void>

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Returns: Promise<PermissionStatus>

requestPermissions()

requestPermissions() => Promise<PermissionStatus>

Returns: Promise<PermissionStatus>

setBadge(...)

setBadge(options: SetBadgeOptions) => Promise<void>

| Param | Type | | ------------- | ----------------------------------------------------------- | | options | SetBadgeOptions |

addListener(JPushEventName.NotificationReceived, ...)

addListener(eventName: JPushEventName.NotificationReceived, listener: (data: PushNotificationData) => void) => Promise<PluginListenerHandle>

| Param | Type | | --------------- | ---------------------------------------------------------------------------------------- | | eventName | JPushEventName.NotificationReceived | | listener | (data: PushNotificationData) => void |