更新记录

1.0.1（2023-11-27）

文档更新

1.0.0（2023-11-27）

1.0.0

平台兼容性

xwe-push（推送插件）

HBuilder X 支持版本

vue版本兼容

平台兼容

权限/配置说明文档

• 【ios】

内置配置：插件内配置了Info.plist，内置配置如下：

注意：下面配置项已经在插件内配置，项目中不需要重复配置了

<dict>
    <key>UIBackgroundModes</key>
    <array>
        <string>remote-notification</string>
    </array>
</dict>

manifest.json中的配置项：

App模块配置 > Push（消息推送） - 注意：不需要勾选里面的具体版本，只需勾选了Push模块即可。

源码试图配置 > app-plus > distribute > ios > pushRegisterMode 字段设置为 manual - 注意：设置这个是为了不让系统自动注册推送token，否则系统的UTSiOSHookProxy生命周期didRegisterForRemoteNotifications会触发多次。设置了不需要系统自动注册，本插件就会按照自己的体系去进行初始化和注册等操作。详见

关于aps-environment的配置：

勾选了Push模块，云打包会自动加上aps-environment的配置，打基座包是development，打正式包就是production。

动态注册通知权限：app初始化启动会动态注册通知权限，通知权限必须打开，否则无法使用推送功能。

接口使用文档

• 引入插件和实例化

【用的ts语法，非ts自行转换】

import {XWEPush} from '@/uni_modules/xwe-push';

let xwePush:XWEPush = new XWEPush();

• 获取-推送信息

xwePush.getPushInfo(callback)

说明：主要获取推送的token信息。

callback返回参数说明

callbackOption结构说明

data结构说明

调用代码示例

【用的ts语法，非ts自行转换】

xwePush.getPushInfo((callbackOption:Object) => {

    if(callbackOption.code == 30){
        console.log('获取推送信息-成功',callbackOption.data.token);
    }

    if(callbackOption.code == -30){
        console.log('获取推送信息-失败',callbackOption.data.error);
    }
});

• 创建-本地通知

xwePush.createLocalNotification(option)

option结构说明

callback返回参数说明

callbackOption结构说明

调用代码示例

【用的ts语法，非ts自行转换】

xwePush.createLocalNotification({
    title:'推送测试',
    body:'推送内容信息测试',
    identifier:'XWELocalNotification1',
    timeInterval:0,
    userInfo:{'id':1001,'name':{'mag':'ok'}},
    callback:(callbackOption:Object) => {

        if(callbackOption.code == 31){
            console.log('创建本地通知-成功',callbackOption);
        }

        if(callbackOption.code == -31){
            console.log('创建本地通知-失败',callbackOption);
        }        
    }
});

• 获取-所有通知消息

xwePush.getAllNotification(callback)

callback返回参数说明

callbackOption结构说明

data结构说明

details object结构说明

• 监听-通知变化

xwePush.onNotificationChange(callback)

说明：服务端推送的时候，自定义数据userInfo最好是包裹在键名为aps内，因为插件只会去获取aps键名的数据，示例："aps":{"id":0,"name":"test"}。

callback返回参数说明

callbackOption结构说明

data结构说明

details object结构说明

调用代码示例

【用的ts语法，非ts自行转换】

xwePush.onNotificationChange((callbackOption:Object) => {

    if(callbackOption.code == 40){
        console.log('已开启监听通知变化事件');
    }

    if(callbackOption.code == 41){
        console.log('收到通知消息',callbackOption.data.details);
    }

    if(callbackOption.code == 42){
        console.log('读取通知消息',callbackOption.data.details);
    }
});

• 删除-通知角标

xwePush.clearBadgeNumber(badgeNumber)

调用代码示例

【用的ts语法，非ts自行转换】

//删除1条消息角标数量
xwePush.clearBadgeNumber(1);

//清空消息角标数量
xwePush.clearBadgeNumber(0);

• 删除-通知消息

xwePush.removeNotifications(identifier)

调用代码示例

【用的ts语法，非ts自行转换】

//删除通知消息
xwePush.removeNotifications(['XWELocalNotification1']);

//删除全部通知消息
xwePush.removeNotifications(null);

• 请求-通知权限

xwePush.requestNotificationPermission(callback)

callback返回参数说明

callbackOption结构说明

• 检测-通知权限

xwePush.checkPushNotificationPermission(callback)

callback返回参数说明

callbackOption结构说明

code状态码说明