快應用 推送

2020-08-08 15:41 更新

接口聲明

{"name": "service.push"}

導入模塊

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

接口定義

push.getProvider()1000+

獲取服務提供商。

參數(shù):

返回值:

字符串,服務提供商的代號,如廠商的英文品牌名稱,假如無此服務則返回空字符串

示例:

console.log(push.getProvider())

push.subscribe(OBJECT)

訂閱push,后續(xù)可以收到push消息(一般可在應用初始化的地方進行調(diào)用。比如在app的onCreate方法中調(diào)用。)

參數(shù):

參數(shù)名 類型 必填 說明
success Function 成功回調(diào)
fail Function 失敗回調(diào),返回失敗原因
complete Function 執(zhí)行結束后的回調(diào)
success返回值:
參數(shù)名 類型 說明
regId String PushService返回的注冊id,可用于針對某個用戶發(fā)送消息

示例:

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)

取消訂閱(一般不建議調(diào)用,調(diào)用后regId失效,需要重新訂閱獲取新的regId)

參數(shù):

參數(shù)名 類型 必填 說明
success Function 成功回調(diào)
fail Function 失敗回調(diào),返回失敗原因
complete Function 執(zhí)行結束后的回調(diào)

示例:

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事件回調(diào)(透傳消息的payload內(nèi)容可在此回調(diào)中收到)

參數(shù):

參數(shù)名 類型 必填 說明
callback Function push事件回調(diào)處理
callback返回值:
參數(shù)名 類型 說明
messageId String 消息id
data String 消息內(nèi)容payload

示例:

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

push.off(OBJECT)

移除 push 事件回調(diào),push.on中的callback不會再收到透傳內(nèi)容

  • 注意: OPPO 快應用暫不支持此特性

參數(shù):

示例:

push.off()

后臺運行限制

無限制。 后臺運行詳細用法參見 后臺運行腳本

支持明細

廠商支持備注
小米YES小米消息推送服務
中興no-
華為1020+華為開發(fā)者聯(lián)盟
金立1010+金立快應用開發(fā)者中心
聯(lián)想no-
魅族1010+魅族集成推送服務
努比亞no-
OPPOYESOPPO 消息推送服務
vivono-
一加--
預覽版no預覽版不提供推送接口


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號