目录

pushCommon(推送服务公共信息)

本模块定义推送服务相关公共接口与枚举,为账号绑定、消息接收、通知内容替换等核心能力提供支撑。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.Push.PushService

起始版本: 4.0.0(10)

导入模块

import { pushCommon } from '@kit.PushKit';

AppProfileType

绑定账号类型,为枚举值。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.Push.PushService

起始版本: 4.0.0(10)

名称 值 说明
PROFILE_TYPE_OS_DISTRIBUTED_ACCOUNT 1 华为账号。
PROFILE_TYPE_APPLICATION_ACCOUNT 2 应用账号。

PushPayload

PushPayload是推送服务向应用传递数据的核心接口,开发者可以通过receiveMessage()接收通知、语音播报等类型消息的数据。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.Push.PushService

起始版本: 4.0.0(10)

名称 类型 只读 可选 说明
type string 否 否

传递给Ability的消息类型,取值范围:

'IM':语音播报消息

'VoIP':应用内通话消息

'BACKGROUND':后台消息

'EMERGENCY':紧急事件消息(该类型的消息仅对系统应用开放,暂不对外开放申请,开发者无需处理)

'ALERT':通知消息

data string 否 否 传递给Ability的数据。详见data取值样例(格式化后)。

[h2]data取值样例

RemoteNotificationInfo

应用进程不在前台时,开发者可以通过onReceiveMessage()接收语音播报消息的数据,数据由该接口进行传递,继承自PushPayload。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.Push.PushService

起始版本: 4.1.0(11)

名称 类型 只读 可选 说明
id number 否 否 通知id。
type string 否 否 继承自PushPayload,表示传递给RemoteNotificationExtensionAbility的消息类型。
data string 否 否 继承自PushPayload,表示传递给RemoteNotificationExtensionAbility的数据。

RemoteNotificationContent

开发者接收并处理RemoteNotificationInfo后,通过该接口返回替换后的通知标题、通知内容等属性。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.Push.PushService

起始版本: 4.1.0(11)

名称 类型 只读 可选 说明
title string 否 是

扩展通知标题,将作为发布通知时NotificationRequest对象的title。

说明:

title从5.0.0(12)起变更为非必填字段。

text string 否 是

扩展通知内容,将作为发布通知时NotificationRequest对象的text。

说明:

text从5.0.0(12)起变更为非必填字段。

overlayIcon image.PixelMap 否 是

扩展通知的叠加图标,将作为发布通知时NotificationRequest对象的overlayIcon。

说明:

图片长*宽建议小于128*128像素,若超过49152像素,则图片不展示。

badgeNumber number 否 是 增加的角标数量,取值范围为全体整数,当badgeNumber取值小于或等于0时,将忽略本次角标设定。在应用的桌面图标上呈现。该参数将作为发布通知时NotificationRequest对象的badgeNumber。
setBadgeNumber number 否 是

设置的角标数量,取值范围为全体整数,当设置的角标数量小于或等于0时,清除角标。与badgeNumber同时返回时,优先于badgeNumber,将作为发布通知时NotificationRequest对象的setBadgeNumber。

说明:

起始版本:5.0.0(12)。

wantAgent RemoteWantAgent 否 是 点击事件时可以替换的数据,将作为发布通知时NotificationRequest对象的wantAgent。

RemoteWantAgent

点击事件时可以替换的数据。返回RemoteNotificationContent时,开发者可以通过该接口实现替换后的通知点击行为,例如启动 Ability。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.Push.PushService

起始版本: 4.1.0(11)

名称 类型 只读 可选 说明
abilityName string 否 否 自定义页面名称。
parameters Record<string, Object> 否 是 传递给应用的数据。

VoIPInfo

应用内通话消息数据,继承自PushPayload。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.Push.PushService

起始版本: 4.1.0(11)

名称 类型 只读 可选 说明
callId string 否 否 当次呼叫的唯一标识。
type string 否 否 继承自PushPayload。
data string 否 否 继承自PushPayload。