@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.1

package/resource/knowledge/push/integration/harmonyos.md

@@ -0,0 +1,72 @@
+## 操作步骤
+
+### 步骤1：集成 TIMPush
+
+完成 [厂商配置](https://cloud.tencent.com/document/product/269/108856) 后，集成 SDK：
+``` java
+// 版本号 “VERSION” 请前往  中获取配置。
+// oh-package.json5 中配置集成包
+dependencies: {
+    "@tencentcloud/timpush": "^VERSION",
+    "@tencentcloud/imsdk": "^VERSION",
+}
+```
+
+### 步骤2：注册推送
+
+调用接口推送注册成功后，就可以收到离线推送通知了。
+
+> **说明：**
+>
+
+> 注册接口必填参数 SDKAppID 和客户端密钥 AppKey 的获取路径是 [IM 控制台 > 推送服务 Push > 概览](https://console.cloud.tencent.com/im/push-plugin-push-identifier)，如下图所示：
+>
+
+``` java
+import { TIMPushListener, TIMPushManager, TIMPushMessage } from '@tencentcloud/timpush';
+
+TIMPushManager.getInstance()
+  .registerPush(context, 您的 sdkAppId, "客户端密钥", IM 控制台证书 ID)
+  .then((result) => {
+    console.log("registerPush success：", result.message);
+  })
+  .catch((error: Error) => {
+    console.log("registerPush failed", error.code, error.message);
+  })
+```
+
+### 步骤3：消息触达统计配置
+
+如果您需要统计触达数据，请按照如下完成配置：
+
+回执地址：`https://api.im.qcloud.com/v3/offline_push_report/harmony`
+
+### 步骤4：发送推送消息
+
+您可以在 [控制台 > 接入测试](https://console.cloud.tencent.com/im/push-plugin-push-check) 指定 `RegistrationID/userID` 进行离线推送测试。REST API 接口详细说明可参见：[REST API 接口 > 发起全员/标签推送](https://cloud.tencent.com/document/product/269/100634)。
+
+### 步骤5：解析离线推送消息
+
+收到推送消息后点击通知栏，组件会回调该点击事件和透传离线消息。
+
+> **注意：**
+>
+> 1. 注册回调时机必须放在应用 [UIAbility](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/uiability-lifecycle) 的 onCreate() 函数中。
+> 2. 控制台配置点击后续动作按如下配置，选择**打开应用内指定界面**，请勿修改默认值。
+
+``` java
+let pushListener: TIMPushListener = {
+  onNotificationClicked: (data) => {
+    console.log("onNotificationClicked", data);
+  }
+}
+
+TIMPushManager.getInstance().addPushListener(pushListener);
+```
+
+恭喜您已经完成了推送插件的接入，需要提醒您：推送插件**试用或购买到期后，将自动停止提供推送服务（包括普通消息离线推送、全员/标签推送等服务）**。为避免影响您业务正常使用，请提前[购买](https://buy.cloud.tencent.com/avc)/[续费](https://console.cloud.tencent.com/account/renewal)。
+
+> **说明：**
+>
+> - 接入完成收不到推送，请先自助使用 [排查工具](https://cloud.tencent.com/document/product/269/100629) 查看下具体原因。推送指标数据查看，请使用 [数据统计](https://cloud.tencent.com/document/product/269/100628) 查询。
+> - 全员/标签推送功能请参见：[REST API 接口 - 发起全员/标签推送](https://cloud.tencent.com/document/product/269/100634)。