更新记录

0.5.1（2024-11-07） 下载此版本

• 优化和 @tencentcloud/chat-uikit-uniapp 融合时的产品体验。
• 优化和 TencentCloud-TUICallKit 插件 融合时的产品体验。
• 新增接口 disablePostNotificationInForeground，此接口可实现应用在前台时，开/关通知栏通知（默认开）。
• 新增接口 createNotificationChannel，支持 FCM/OPPO 自定义铃音。

0.5.0（2024-11-06） 下载此版本

• 优化和 TencentCloud-TUICallKit 插件 融合时的产品体验。
• 新增接口 disablePostNotificationInForeground，此接口可实现应用在前台时，开/关通知栏通知（默认开）。
• 新增接口 createNotificationChannel，支持 FCM/OPPO 自定义铃音。

0.4.0（2024-10-17） 下载此版本

• 支持与 TencentCloud-TUICallKit 插件 融合打包。

平台兼容性

TencentCloud-Push

简介

使用 uts 开发，基于腾讯云推送服务（Push），支持 iOS 和 Android 推送，同时适配各大厂商推送。

腾讯云推送服务（Push）提供一站式 App 推送解决方案，助您轻松提升用户留存和互动活跃度，支持与腾讯云即时通信 IM SDK、实时音视频 TRTC SDK、音视频通话 SDK、直播 SDK等音视频终端产品协同集成，在不同场景联合使用，提升业务整体功能体验。

数据可视化，辅助运营策略

支持推送消息全链路问题排查

六地服务部署，严守数据安全

提供了中国、东南亚（新加坡、印尼雅加达）、东北亚（韩国首尔）、欧洲（德国法兰克福）以及北美（美国硅谷）数据存储中心供选择，每个数据中心均支持全球接入。如果您的应用在境外上线且用户主要在境外，您可以根据消息传输需求及合规要求，选择适合您业务的境外数据中心，保障您的数据安全。

快速跑通

步骤1：创建应用

进入 控制台 ，单击创建应用，填写应用名称，选择数据中心，单击确定，完成应用创建。

步骤2：开通推送服务 Push

进入 推送服务 Push，单击立即购买或免费试用 。（每个应用可免费试用一次，有效期7天）

步骤3：将 uni-app 腾讯云推送服务（Push）插件导入 HbuilderX 中的工程。如图所示：

步骤4：在 App.vue 中引入并注册腾讯云推送服务（Push）

将 SDKAppID 和 appKey 替换为您在IM 控制台 - 推送服务 Push - 接入设置页面 获取的应用的信息。如图所示：

// 集成 TencentCloud-Push
import * as Push from '@/uni_modules/TencentCloud-Push';
const SDKAppID = 0; // 您的 SDKAppID
const appKey = ''; // 客户端密钥
Push.registerPush(SDKAppID, appKey, (data) => {
        console.log('registerPush ok', data);
        Push.getRegistrationID((registrationID) => {
            console.log('getRegistrationID ok', registrationID);
        });
    }, (errCode, errMsg) => {
        console.error('registerPush failed', errCode, errMsg);
    }
);

// 监听在线推送
Push.addPushListener(Push.EVENT.MESSAGE_RECEIVED, (res) => {
    // res 为消息内容
    console.log('message received', res);
});

// 监听在线推送被撤回
Push.addPushListener(Push.EVENT.MESSAGE_REVOKED, (res) => {
    // res 为被撤回的消息 ID
    console.log('message revoked', res);
});

步骤5：测试推送（测试前请务必打开手机通知权限，允许应用通知。）

单击 HBuilderX 的 【运行 > 运行到手机或模拟器 > 制作自定义调试基座】，使用云端证书制作 Android 或 iOS 自定义调试基座。

自定义调试基座打好后，安装到手机运行。

您可以使用 REST API 向全员或者被打标签的用户推送通知来测试效果，详见 全员/标签推送。

离线推送厂商配置

• 您需在 nativeResources 目录下进行推送配置。若项目根目录尚未创建该文件夹，请新建一个名为 nativeResources 的文件夹。
• 离线推送厂商配置完成后，需要打包自定义基座。参考：[快速跑通]>[步骤5：测试推送（测试前请务必打开手机通知权限，允许应用通知。）]

【Android】

1. 新建 nativeResources/android/assets 目录。

2. 在 推送服务 Push > 接入设置 > 一键式快速配置 下载 timpush-configs.json 文件，配置到 nativeResources/android/assets 目录下。

3. For 华为：

   配置 agconnect-services.json （此文件获取详见 厂商配置 > uniapp > 华为 > 步骤4：获取应用信息）到 nativeResources/android/assets 目录下。

4. For Google FCM：

   编辑 uni_modules/TencentCloud-Push/utssdk/app-android/config.json 的 project.plugins，添加 "com.google.gms.google-services"，如下：

   {
     ...
     "project": {
       "plugins": [
         ...
         "com.google.gms.google-services"
       ]
     }
   }

   配置 google-services.json 文件到 nativeResources/android/ 目录。

5. For 荣耀：

   配置 appID 到 uni_modules/TencentCloud-Push/utssdk/app-android/AndroidManifest.xml 文件中的 com.hihonor.push.app_id。

6. For vivo：

   配置 appID 和 appKey 到 uni_modules/TencentCloud-Push/utssdk/app-android/AndroidManifest.xml 文件中的 com.vivo.push.app_id 和 com.vivo.push.api_key。

【iOS】

1. 新建 nativeResources/ios/Resources 目录。

2. 在 nativeResources/ios/Resources 目录下新建 timpush-configs.json 文件。

3. 将在 IM控制台 > 推送服务 Push > 接入设置 获取的证书ID，补充到 timpush-configs.json 文件中。

   {
      "businessID":"xxx" 
   }

获取离线推送扩展信息

在 App.vue 内处理 onShow 回调，当设备收到离线推送，拉起 app 时，业务侧可通过 getNotificationExtInfo 接口获取推送扩展信息。

export default {
    onLaunch: function() {
    },
    onShow: function() {
        console.log('App Show')
        Push.getNotificationExtInfo((extInfo) => {
            console.log('getNotificationExtInfo ok', extInfo);
        })
    },
    onHide: function() {
        console.log('App Hide')
    }
}

接口

registerPush(SDKAppID: number, appKey: string, onSuccess: (data: string) => void, onError?: (errCode: number, errMsg: string) => void);

unRegisterPush(onSuccess: () => void, onError?: (errCode: number, errMsg: string) => void): void;

setRegistrationID(registrationID: string,  onSuccess: () => void): void;

getRegistrationID(onSuccess: (registrationID: string) => void): void;

getNotificationExtInfo(onSuccess: (extInfo: string) => void): void;

addPushListener(eventName: string, listener: (data: any) => void);

removePushListener(eventName: string, listener?: (data: any) => void);

disablePostNotificationInForeground(disable: boolean);

createNotificationChannel(options: any, listener: (data: any) => void);