{ "name": "service.push" }
import push from '@service.push' 或 const push = require('@service.push')
1000+
获取服务提供商。
无
字符串,服务提供商的代号,如厂商的英文品牌名称,假如无此服务则返回空字符串
console.log(push.getProvider())
订阅 push,后续可以收到 push 消息(一般可在应用初始化的地方进行调用。比如在 app 的 onCreate 方法中调用。)
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 否 | 成功回调 |
fail | Function | 否 | 失败回调,返回失败原因 |
complete | Function | 否 | 执行结束后的回调 |
参数名 | 类型 | 说明 |
---|---|---|
regId | String | PushService 返回的注册 id,可用于针对某个用户发送消息 |
push.subscribe({
success: function(data) {
console.log(
`push.subscribe succeeded, result data = ${JSON.stringify(data)}`
)
},
fail: function(data, code) {
console.log(
`push.subscribe failed, result data = ${JSON.stringify(
data
)}, code = ${code}`
)
},
complete: function() {
console.log('push.subscribe completed')
}
})
取消订阅(一般不建议调用,调用后 regId 失效,需要重新订阅获取新的 regId)
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 否 | 成功回调 |
fail | Function | 否 | 失败回调,返回失败原因 |
complete | Function | 否 | 执行结束后的回调 |
push.unsubscribe({
success: function(data) {
console.log(
`push.unsubscribe succeeded, result data = ${JSON.stringify(data)}`
)
},
fail: function(data, code) {
console.log(
`push.unsubscribe failed, result data = ${JSON.stringify(
data
)}, code = ${code}`
)
},
complete: function() {
console.log('push.unsubscribe completed')
}
})
添加 push 事件回调(透传消息的 payload 内容可在此回调中收到)
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | Function | 是 | push 事件回调处理 |
参数名 | 类型 | 说明 |
---|---|---|
messageId | String | 消息 id |
data | String | 消息内容 payload |
push.on({
callback: function(ret) {
console.log(`received pass through message, ret = ${JSON.stringify(ret)}`)
}
})
移除 push 事件回调,push.on
中的callback
不会再收到透传内容
无
push.off()
无限制。 后台运行详细用法参见后台运行 脚本。
厂商 | 支持 | 备注 |
---|---|---|
小米 | YES | 小米消息推送服务 |
中兴 | no | - |
华为 | 1020+ | 华为开发者联盟 |
金立 | 1010+ | 金立快应用开发者中心 |
联想 | no | - |
魅族 | 1010+ | 魅族集成推送服务 |
努比亚 | no | - |
OPPO | YES | OPPO 消息推送服务 |
vivo | YES | vivo 消息推送服务 |
一加 | - | - |
预览版 | no | 预览版不提供推送接口 |