客户端 API

最近更新时间:2024-10-10 11:15:51

我的收藏

TIMPush - TIMPushManager

public abstract class TIMPushManager:推送插件接口类。

接口概览

注册/反注册推送服务接口

API
描述
注册推送服务,推送信息读取工程中的配置文件 timpush-configs.json (必须在 App 用户同意了隐私政策后,再调用该接口使用推送服务)。
反注册关闭推送服务。
RegistrationID 是推送接收设备的唯一标识 ID。默认情况下,注册推送服务成功时自动生成该 ID,同时也支持您自定义设置。您可根据 RegistrationID 向指定设备推送消息。需要注意的是,卸载并重新安装设备会更改 RegistrationID,因此需要在注册推送服务之前调用 setRegistrationID 接口。
在成功注册推送服务后,可通过调用 getRegistrationID 接口获取推送接收设备的唯一标识 ID,即RegistrationID。您可根据 RegistrationID 向指定设备推送消息。

Push 全局监听接口

API
描述
添加 Push 监听器。
移除 Push 监听器。

自定义配置接口

API
描述
指定设备离线推送使用 FCM 通道,需要在注册推送服务之前调用。
关闭 App 在前台时弹出通知栏。

接口详情

静态 Public 成员函数

static TIMPushManager getInstance():获取 TIMPushManager 管理器实例。

成员函数说明

abstract void registerPush(Context context, int sdkAppId, String appKey, TIMPushCallback callback)
注册离线推送服务:请正确传递 sdkAppId 和 appKey 两个参数,即可注册推送服务。
注意:如果您已经集成 IM 产品,请在 IM 登录成功后调用该接口,将 appKey 参数设置为 null,再接入离线推送能力。
参数说明:
参数
描述
获取路径
sdkAppId
IM 控制台为您分配的应用 ID。




appKey
IM 控制台为您分配的客户端密钥。
注意:
您需要使用 TUICore 组件中的 TUILogin 提供的 login 接口登录,插件会自动感知并注册推送服务。
如果您不想使用 TUILogin 提供的接口,您需要在完成登录操作后,手动调用该接口注册服务。
abstract void unRegisterPush(TIMPushCallback callback)
反注册关闭离线推送服务,IM 账号登出前调用。
注意:
如果您不想使用推送服务,手动调用该接口反注册服务即可。
如果您使用 TUICore 组件中的 TUILogin 提供的 logout 接口登出,插件会自动感知并反注册推送服务。
abstract void setRegistrationID(String registrationID, TIMPushCallback callback)
设置注册推送服务使用的推送 ID 标识, 即 RegistrationID,需要在注册推送服务之前调用。
参数说明:
参数
描述
registrationID
设备的推送唯一标识 ID,卸载重装会改变。
abstract void getRegistrationID(TIMPushCallback callback)
注册推送服务成功后,获取推送 ID 标识,即 RegistrationID。
abstract void addPushListener(TIMPushListener listener)
添加 Push 监听器
abstract void removePushListener(TIMPushListener listener)
移除 Push 监听器
abstract void forceUseFCMPushChannel(boolean enable)
指定设备离线推送使用 FCM 通道,需要在注册推送服务之前调用。
参数说明:
参数
描述
enable
true:使用 FCM 通道。
false:使用本机通道。
abstract void disablePostNotificationInForeground(boolean disable)
关闭 App 在前台时弹出通知栏,默认关闭。
参数说明:
参数
描述
disable
true:关闭。
false:开启。

TIMPush - TIMPushListener

public abstract class TIMPushListener:Push 监听器类

接口概览

API
描述
onRecvPushMessage
收到 Push 消息。
onRevokePushMessage
收到 Push 消息撤回的通知。

接口详情

成员函数说明

void onRecvPushMessage(TIMPushMessage message)
收到 Push 消息,message 消息。
void onRevokePushMessage(String messageID)
收到 Push 消息撤回的通知,messageID 消息唯一标识。