推送

接口声明

{"name": "service.push"}

导入模块

import push from '@service.push'const push = require('@service.push')

接口定义

push.getProvider()1000+

获取服务提供商。

参数:

返回值:

字符串,服务提供商的代号,如厂商的英文品牌名称,假如无此服务则返回空字符串

示例:

console.log(push.getProvider())

push.subscribe(OBJECT)

订阅push,后续可以收到push消息(一般可在应用初始化的地方进行调用。比如在app的onCreate方法中调用。)

参数:

参数名 类型 必填 说明
success Function 成功回调
fail Function 失败回调,返回失败原因
complete Function 执行结束后的回调
success返回值:
参数名 类型 说明
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')
  }
})

push.unsubscribe(OBJECT)

取消订阅(一般不建议调用,调用后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.on(OBJECT)

添加push事件回调(透传消息的payload内容可在此回调中收到)

参数:

参数名 类型 必填 说明
callback Function push事件回调处理
callback返回值:
参数名 类型 说明
messageId String 消息id
data String 消息内容payload

示例:

push.on({
  callback: function (ret) {
    console.log(`received pass through message, ret = ${JSON.stringify(ret)}`)
  }
})

push.off(OBJECT)

移除push事件回调,push.on中的callback不会再收到透传内容

参数:

示例:

push.off()

条匹配 "" 的结果

    没有搜索到与 "" 相关的内容