wx.miniapp.getXGPushManager

WARNING

请注意，当前域名 https://dev.weixin.qq.com/docs/framework 文档已不维护，请前往微信文档中心 找到对应的新文档继续使用

该能力封装了腾讯云移动推送服务实现，具体接入流程可以查看消息推送说明文档。

getXGPushManager

获取详细管理对象（单例）。

事例

const xgpushMgr = wx.miniapp.getXGPushManager()

registerPush

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

参数

属性	类型	默认值	必填	说明
success	function	-	否	注册成功，参数是设备信息 注意！iOS Android的回调参数是不一样的
fail	function	-	否	注册失败

事例

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	整数	是	角标数值
success	function	否	设置成功
fail	function	否	设置失败

事例

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)