wx.miniapp.getXGPushManager

本接口基于腾讯云移动推送 TPNSopen in new window服务实现,即该接口使用前需按照腾讯云消息推送 TPNS 接入指南完成接入方可使用。

getXGPushManager

获取详细管理对象(单例)。

事例


const xgpushMgr = wx.miniapp.getXGPushManager()

registerPush

开启消息推送能力。执行成功后,会 success 回调设备 token(Android 和 iOS 数据结构不一样),才能给设备推送消息。

参数

属性类型默认值必填说明
successfunction-注册成功,参数是设备信息。 注意!iOS 与 Android 的回调参数是不一样的
failfunction-注册失败

事例

const xgpushMgr = wx.miniapp.getXGPushManager()
xgpushMgr.registerPush({
    success(args) {
        // 注意!iOS 与 Android 的回调参数是不一样的
        console.log('registerPush', args)
    },
    fail(e) {
        console.error(e)
    }
})

unregisterPush

取消监听消息推送。

事例

const xgpushMgr = wx.miniapp.getXGPushManager()
xgpushMgr.unregisterPush()

onNotificationClickedResult

监听监听用户点击的消息回调。

参数

类型默认值必填说明
function-监听方法

事例

const onTPNSClickResult = (result) => {
    console.log('onTPNSClickResult')
}
const xgpushMgr = wx.miniapp.getXGPushManager()
xgpushMgr.onNotificationClickedResult(onTPNSClickResult)

offNotificationClickedResult

取消监听用户点击的消息回调。

参数

类型默认值必填说明
function-监听方法

事例

const onTPNSClickResult = (result) => {
    console.log('onTPNSClickResult')
}
const xgpushMgr = wx.miniapp.getXGPushManager()
xgpushMgr.offNotificationClickedResult(onTPNSClickResult)

setBadge

设置应用本地角标值。仅在 iOS 生效。

参数

属性类型必填说明
number整数角标数值
successfunction设置成功
failfunction设置失败

事例

const xgpushMgr = wx.miniapp.getXGPushManager()
xgpushMgr.setBadge({
    number: -1,
    success() {
        console.log('xgpushSetBadge success')
    },
    fail(e) {
        console.error('xgpushSetBadge failed', e)
    }
})

onXgPushLog

获取消息推送的日志。

只支持 iOS

事例

const xgpushMgr = wx.miniapp.getXGPushManager()
const xgpushLog = (log) => {
    console.log(log)
}
// 注册监听
xgpushMgr.onXgPushLog(xgpushLog)

offXgPushLog

取消获取消息推送的日志。

只支持 iOS

事例

const xgpushMgr = wx.miniapp.getXGPushManager()
const xgpushLog = (log) => {
    console.log(log)
}
// 注册
xgpushMgr.offXgPushLog(xgpushLog)