tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
即时通信 IM
    文档
    Download PDF

    Android

    最后更新时间：2024-06-13 10:39:26
    下载PDF

      TIMPushManager

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

      接口概览

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

      初始化并成功登录 IM 后，可以注册推送服务。
      API
      描述
      注册推送服务，推送信息读取工程中的配置文件 timpush-configs.json。
      注册推送服务，推送信息来自接口参数 json。
      反注册关闭离线推送服务，IM 账号登出前调用。
      关闭插件在登录后自动注册推送服务，需要在注册推送服务之前调用。

      FCM 自定义铃音配置接口

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

      推送通道特殊配置接口

      API
      描述
      指定设备离线推送使用的厂商通道类型，需要在注册推送服务之前调用。
      获取设备离线推送正在使用的厂商通道类型。
      各个厂商接入配置完成后，可使用该接口在对应厂商设备上测试可 push 状态。

      接口详情

      静态 Public 成员函数

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

      成员函数说明

      abstract void registerPush(Context context, TIMPushCallback callback)

      注册离线推送服务，IM 账号登录成功时调用。（为了方便您尽可能简单地接入推送服务，插件会默认自动读取工程中的配置文件 timpush-configs.json，来获取注册推送服务需要的信息）
      注意：
      您需要使用 TUICore 组件中的 TUILogin 提供的 login 接口登录，插件会自动感知并注册推送服务。
      如果您不想使用 TUILogin 提供的接口，您需要在完成登录操作后，手动调用该接口注册服务。

      abstract void registerPush(String json, Context context, TIMPushCallback callback)

      注册离线推送服务，IM 账号登录成功时调用。（注册推送服务需要的信息来自接口参数 json）
      参数 json：
        { 
            // huawei
            "huaweiPushBussinessId": "", 
            // 在腾讯云控制台上传第三方推送证书后分配的证书ID
            "huaweiBadgeClassName": "", // 角标参数，默认为应用的 launcher 界面的类名
            // xiaomi
            "xiaomiPushBussinessId": "",// 在腾讯云控制台上传第三方推送证书后分配的证书ID 
            "xiaomiPushAppId": "",// 小米开放平台分配的应用APPID "xiaomiPushAppKey": "",// 小米开放平台分配的应用APPKEY
        
            // meizu
            "meizuPushBussinessId": "", // 在腾讯云控制台上传第三方推送证书后分配的证书ID 
            "meizuPushAppId": "",// 魅族开放平台分配的应用APPID "meizuPushAppKey": "",// 魅族开放平台分配的应用APPKEY
        
            // vivo
            "vivoPushBussinessId": "", // 在腾讯云控制台上传第三方推送证书后分配的证书ID
        
            // google 
            "fcmPushBussinessId": "", // 在腾讯云控制台上传第三方推送证书后分配的证书ID
        
            // oppo
            "oppoPushBussinessId": "", // 在腾讯云控制台上传第三方推送证书后分配的证书ID 
            "oppoPushAppKey": "",// oppo开放平台分配的应用 AppKey 
            "oppoPushAppSecret": "",// oppo开放平台分配的应用 AppSecret
        
            // honor 
            "honorPushBussinessId": "", // 在腾讯云控制台上传第三方推送证书后分配的证书ID 
        }

      abstract void unRegisterPush(TIMPushCallback callback)

      反注册关闭离线推送服务，IM 账号登出前调用。
      注意：
      如果您不想使用推送服务，手动调用该接口反注册服务即可。
      如果您使用 TUICore 组件中的 TUILogin 提供的 logout 接口登出，插件会自动感知并反注册推送服务。

      abstract void disableAutoRegisterPush()

      关闭插件自动注册推送服务，需要在登录之前调用。
      注意：
      如果您使用 TUICore 组件中的 TUILogin 提供的 login 接口登录，插件默认自动注册推送服务，调用该接口可关闭自动注册。

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

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

      abstract void setCustomTIMPushConfigs(String configs)

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

      abstract void setPushChannel(int channelId)

      指定设备离线推送使用的厂商通道类型，需要在注册推送服务之前调用。
      说明：
      该接口可以指定使用厂商推送通道类型，例如在国外的小米设备指定使用 FCM 通道推送 setPushChannel(2002)。
      一般不指定通道类型，组件会自动识别设备厂商类别来注册使用对应的厂商通道。
      参数说明：
      参数
      描述
      channelId
      厂商
      设备类型
      XiaoMi
      2000
      HuaWei
      2001
      FCM
      2002
      Meizu
      2003
      Oppo
      2004
      Vivo
      2005
      Honor
      2006

      static TIMPushManager getPushChannel()

      获取设备离线推送正在使用的厂商通道类型。

      abstract void checkPushStatus(int brandId, TIMPushCallback<String> callback)

      各个厂商接入配置完成后，可使用该接口在对应厂商设备上测试是否可接收推送。
      参数说明：
      参数
      描述
      callback
      true 表示配置成功可推送。
      
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款