推送

接口声明

{ "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 返回值：

示例：

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）

参数：

示例：

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 返回值：

示例：

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

push.off(OBJECT)

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

参数：

无

示例：

push.off()

后台运行限制

无限制。 后台运行详细用法参见后台运行 脚本。

支持明细