Android

最近更新时间:2024-09-24 14:47:21

我的收藏

TIMPush - TIMPushManager

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

接口概览

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

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

FCM 自定义铃音配置接口

配置打开后,自定义铃音生效,发送方发送消息的离线信息中需要带上该 channelId。
API
描述
配置 FCM 的自定义铃音,需要在注册推送服务之前调用。
自定义替换插件默认读取的注册推送配置文件 timpush-configs.json,需要在注册推送服务之前调用。

接口详情

静态 Public 成员函数

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

成员函数说明

abstract void registerPush(Context context, int sdkAppId, String appKey, TIMPushCallback callback)

注册推送服务,为了方便您尽可能简单地接入推送服务,插件会默认自动读取工程中的配置文件 timpush-configs.json,来获取注册推送服务需要的信息。
参数说明:
参数
描述
获取路径
sdkAppId
IM 控制台为您分配的应用 ID。




appKey
IM 控制台为您分配的客户端密钥。

abstract void unRegisterPush(TIMPushCallback callback)

反注册关闭推送服务。

abstract void setRegistrationID(String registrationID, TIMPushCallback callback)

设置注册推送服务使用的推送 ID 标识, 即 RegistrationID,需要在注册推送服务之前调用。
参数说明:
参数
描述
registrationID
设备的推送标识 ID,卸载重装会改变。

abstract void getRegistrationID(TIMPushCallback callback)

注册推送服务成功后,获取推送 ID 标识,即 RegistrationID。

abstract void setCustomFCMRing(String channelId, String ringName, boolean enable)

配置 FCM 的自定义铃音,需要在注册推送服务之前调用。
注意:
配置打开后,自定义铃音生效,发送方发送消息的离线信息中需要带上该 channelId。
参数说明:
参数
描述
channelId
FCM 通道自定义通知栏的 channel ID,应用内唯一。
ringName
FCM 通道自定义通知栏的推送铃音名称,raw 目录下铃音且不需要后缀名。
enable
设置离线推送提示铃音是否使用自定义铃音。

abstract void setCustomConfigFile(String configs)

自定义替换插件默认读取的注册推送配置文件 timpush-configs.json,需要在注册推送服务之前调用。
说明:
主要用于多环境下动态切换不同配置文件的推送注册,例如:正式环境和测试环境不同配置文件下的推送功能集成和测试。
静态编译期切换方法请参见:buildConfigField("String", "custom_timpush_configs", "\\"自定义文件名称\\"")。
参数说明:
参数
描述
configs
自定义配置文件的名称,路径需保持不变:"工程根目录/app/src/assets/"。

abstract void addPushListener(TIMPushListener listener)

添加 Push 监听器。

abstract void removePushListener(TIMPushListener listener)

移除 Push 监听器。