Android
TIMPushManager
public abstract class TIMPushManager:推送插件接口类。
接口概览
注册/反注册推送服务接口
初始化并成功登录 IM 后,可以注册推送服务。
API | 描述 |
注册推送服务,推送信息读取工程中的配置文件 timpush-configs.json。 | |
反注册关闭离线推送服务,IM 账号登出前调用。 | |
关闭插件在登录后自动注册推送服务,需要在注册推送服务之前调用。 |
FCM 自定义铃音配置接口
配置打开后,自定义铃音生效,发送方发送消息的离线信息中需要带上该 channelId。
API | 描述 |
配置 FCM 的自定义铃音,需要在注册推送服务之前调用。 | |
自定义替换插件默认读取的注册推送配置文件 timpush-configs.json,需要在注册推送服务之前调用 |
接口详情
静态 Public 成员函数
static TIMPushManager getInstance():获取 TIMPushManager 管理器实例。
成员函数说明
abstract void registerPush(Context context, TIMPushCallback callback)
注册离线推送服务,IM 账号登录成功时调用。(为了方便您尽可能简单地接入推送服务,插件会默认自动读取工程中的配置文件 timpush-configs.json,来获取注册推送服务需要的信息)
注意:
您需要使用 TUICore 组件中的 TUILogin 提供的 login 接口登录,插件会自动感知并注册推送服务。
如果您不想使用 TUILogin 提供的接口,您需要在完成登录操作后,手动调用该接口注册服务。
abstract void unRegisterPush(TIMPushCallback callback)
反注册关闭离线推送服务,IM 账号登出前调用。
abstract void disableAutoRegisterPush()
关闭插件自动注册推送服务,需要在登录之前调用。
注意:
abstract void setCustomFCMRing(String channelId, String ringName, boolean enable)
配置 FCM 的自定义铃音,需要在注册推送服务之前调用。
注意:
配置打开后,自定义铃音生效,发送方发送消息的离线信息中需要带上该 channelId。
参数说明:
API | 描述 |
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/" |