产品动态
公告
HarmonyOS
TIMPushManager 接口概览
API | 描述 |
注册推送服务， (必须在 App 用户同意了隐私政策后，再调用该接口使用推送服务)。 | |
反注册关闭推送服务。 | |
RegistrationID 是推送接收设备的唯一标识 ID。默认情况下，注册推送服务成功时自动生成该 ID，同时也支持您自定义设置。您可根据 RegistrationID 向指定设备推送消息。需要注意的是，卸载并重新安装设备会更改 RegistrationID，因此需要在注册推送服务之前调用 setRegistrationID 接口。 | |
在成功注册推送服务后，调用此接口可获取推送接收设备的唯一标识 ID，即 RegistrationID。 | |
添加 Push 监听器。 | |
移除 Push 监听器。 | |
应用在前台时，开/关通知栏通知（默认开）。 |
接口详情
注册推送服务
接口
registerPush(context: Context,sdkAppId?: number,appKey?: string,businessId?: number): Promise<TIMPushResult>;
参数说明：
参数 | 类型 | 说明 | 获取路径 |
context | Context | 应用上下文 | - |
sdkAppId | number | 推送服务 Push 的 SDKAppID。 |  |
appKey | String | 推送服务 Push 的客户端密钥。 | |
businessId | number | Chat 控制台分配的证书 ID。 |  |
反注册关闭推送服务
接口
unRegisterPush(): Promise<TIMPushResult>;
设置推送 ID 标识 RegistrationID
说明：
1. 如果您调用此接口，请务必在
registerPush 前调用。接口
setRegistrationID(registrationID: string): Promise<TIMPushResult>;
参数说明：
参数 | 类型 | 说明 |
registrationID | String | 自定义的推送 ID 标识。 |
获取推送 ID 标识 RegistrationID
说明：
若您调用过
setRegistrationID 接口设置标识 ID，此接口将返回您设置的标识 ID，否则返回由 Push SDK 生成的随机值。接口
getRegistrationID(): Promise<TIMPushResult>;
添加 Push 监听器
接口
addPushListener(listener: TIMPushListener): void;
参数说明：
参数 | 类型 | 说明 |
listener | 推送事件处理方法。 |
移除 Push 监听器
接口
removePushListener(listener: TIMPushListener): void;
参数说明：
参数 | 类型 | 说明 |
listener | 推送事件处理方法。 |
应用在前台时，开/关通知栏通知
接口
disablePostNotificationInForeground(disable: boolean): void;
参数说明：
参数 | 类型 | 说明 |
disable | boolean | 应用在前台时，开/关通知栏通知，默认关闭： true: 应用在前台时，关闭通知栏通知。 false: 应用在前台时，开启通知栏通知。 |
TIMPushListener 接口概览
API | 描述 |
onRecvPushMessage | 收到 Push 消息。 |
onRevokePushMessage | 收到 Push 消息撤回的通知。 |
onNotificationClicked | 点击通知栏消息回调。 |
接口详情
成员函数说明
onMessageReceived(message: TIMPushMessage): void;
收到 Push 消息，message 消息。
onRevokePushMessage(messageID: string): void;
收到 Push 消息撤回的通知，messageID 消息唯一标识。
onNotificationClicked(ext: string): void;
点击通知栏消息回调。
TIMPushResult 接口概览
字段 | 描述 | 类型 |
code | 错误码 | number |
message | 错误描述 | string |
data | 返回值 | unknown |
文档反馈