@tencentcloud/sdk-mcp 1.6.7 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (331) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/README.md +54 -35
  3. package/knowledge/build-index.js +32 -5
  4. package/knowledge/chunker.js +82 -14
  5. package/knowledge/chunking-policy.js +100 -0
  6. package/knowledge/content-loader.js +3 -1
  7. package/knowledge/frontmatter-meta.js +167 -0
  8. package/knowledge/path-meta.js +28 -6
  9. package/knowledge/search/exact-lookup.js +26 -123
  10. package/knowledge/search/filter-pool.js +17 -26
  11. package/knowledge/search/framework-fallback.js +22 -0
  12. package/knowledge/search/intent-router.js +13 -0
  13. package/knowledge/search/query-normalizer.js +129 -0
  14. package/knowledge/search/search-core.js +391 -0
  15. package/knowledge/search/search-knowledge.js +351 -323
  16. package/knowledge/search/search-message.js +87 -0
  17. package/knowledge/search/search-pass.js +428 -0
  18. package/knowledge/search/search-types.js +1 -0
  19. package/knowledge/search/url-row-scorer.js +258 -0
  20. package/package.json +1 -1
  21. package/resource/_schema/feature-aliases.yaml +1 -0
  22. package/resource/_schema/query-normalization.yaml +9 -0
  23. package/resource/index/manifest.json +1 -1
  24. package/resource/integration/callkit/preset/android/integration.md +0 -14
  25. package/resource/integration/callkit/preset/flutter/integration.md +0 -9
  26. package/resource/integration/callkit/preset/ios/integration.md +2 -14
  27. package/resource/integration/callkit/preset/react/integration.md +0 -21
  28. package/resource/integration/callkit/preset/vue/integration.md +0 -27
  29. package/resource/integration/chat/preset/android/integration.md +3 -10
  30. package/resource/integration/chat/preset/flutter/integration.md +12 -13
  31. package/resource/integration/chat/preset/ios/integration.md +9 -16
  32. package/resource/integration/chat/preset/react/integration.md +1 -9
  33. package/resource/integration/chat/preset/uni-app/integration.md +0 -9
  34. package/resource/integration/chat/preset/vue/integration.md +3 -13
  35. package/resource/integration/livekit/preset/live/android/live-host-integration.md +0 -4
  36. package/resource/integration/livekit/preset/live/android/prepare-integration.md +8 -21
  37. package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +0 -1
  38. package/resource/integration/livekit/preset/live/ios/live-host-integration.md +0 -5
  39. package/resource/integration/livekit/preset/live/ios/live-list-integration.md +0 -4
  40. package/resource/integration/livekit/preset/live/ios/prepare-integration.md +0 -9
  41. package/resource/integration/livekit/preset/live/vue/live-list-integration.md +1 -5
  42. package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +38 -147
  43. package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +1 -6
  44. package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +432 -286
  45. package/resource/integration/roomkit/preset/vue/integration.md +11 -24
  46. package/resource/knowledge/callkit/best-practice/callkit-miniprogram/uniapp-shrink.md +64 -0
  47. package/resource/knowledge/callkit/best-practice/common/call-autoplay-blocked.md +81 -0
  48. package/resource/knowledge/callkit/best-practice/common/call-message-in-chat.md +84 -0
  49. package/resource/knowledge/callkit/best-practice/common/call-vs-calls.md +114 -0
  50. package/resource/knowledge/callkit/best-practice/common/callengine-call-flow.md +128 -0
  51. package/resource/knowledge/callkit/best-practice/common/callengine-log-level.md +72 -0
  52. package/resource/knowledge/callkit/best-practice/common/callkit-get-engine-instance.md +87 -0
  53. package/resource/knowledge/callkit/best-practice/common/callkit-get-roomid.md +83 -0
  54. package/resource/knowledge/callkit/best-practice/common/callkit-limitations.md +37 -0
  55. package/resource/knowledge/callkit/best-practice/common/callkit-user-register-and-kicked.md +103 -0
  56. package/resource/knowledge/callkit/core-sdk/android/answer-call.md +1 -20
  57. package/resource/knowledge/callkit/core-sdk/android/make-call.md +0 -12
  58. package/resource/knowledge/callkit/core-sdk/android/offline-push.md +1 -12
  59. package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +0 -19
  60. package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +0 -13
  61. package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +1 -17
  62. package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +0 -13
  63. package/resource/knowledge/callkit/core-sdk/ios/make-call.md +0 -13
  64. package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +0 -12
  65. package/resource/knowledge/callkit/core-sdk/miniprogram/call-engine.md +0 -1
  66. package/resource/knowledge/callkit/core-sdk/miniprogram/call-event.md +0 -2
  67. package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +0 -15
  68. package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +0 -15
  69. package/resource/knowledge/callkit/core-sdk/web/call-engine.md +0 -1
  70. package/resource/knowledge/callkit/core-sdk/web/call-event.md +0 -1
  71. package/resource/knowledge/callkit/core-sdk/web/callengine-api-overview.md +0 -1
  72. package/resource/knowledge/callkit/faq/android.md +5 -15
  73. package/resource/knowledge/callkit/faq/common.md +0 -1
  74. package/resource/knowledge/callkit/faq/ios.md +1 -4
  75. package/resource/knowledge/callkit/faq/uniapp-app.md +0 -2
  76. package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +0 -5
  77. package/resource/knowledge/callkit/faq/web.md +1 -5
  78. package/resource/knowledge/callkit/preset/android/api.md +0 -6
  79. package/resource/knowledge/callkit/preset/ios/api.md +0 -4
  80. package/resource/knowledge/callkit/preset/miniprogram/api.md +0 -2
  81. package/resource/knowledge/callkit/preset/react/api.md +3 -154
  82. package/resource/knowledge/callkit/preset/vue/api.md +3 -42
  83. package/resource/knowledge/chat/best-practice/common/avchatroom-message-loss-diagnosis.md +71 -0
  84. package/resource/knowledge/chat/best-practice/common/group-conversation-cleanup-on-system-notice.md +67 -0
  85. package/resource/knowledge/chat/best-practice/common/image-message-url-lifecycle.md +63 -0
  86. package/resource/knowledge/chat/best-practice/common/login-repeat-2025-diagnosis.md +65 -0
  87. package/resource/knowledge/chat/best-practice/common/message-read-report-and-receipt.md +72 -0
  88. package/resource/knowledge/chat/best-practice/common/message-receive-event.md +70 -0
  89. package/resource/knowledge/chat/best-practice/common/message-risk-error-and-render.md +69 -0
  90. package/resource/knowledge/chat/best-practice/common/message-unread-count.md +71 -0
  91. package/resource/knowledge/chat/best-practice/miniprogram/audio-message-send.md +118 -0
  92. package/resource/knowledge/chat/best-practice/miniprogram/login-timeout-2801-diagnosis.md +67 -0
  93. package/resource/knowledge/chat/best-practice/miniprogram/media-upload-fail-diagnosis.md +68 -0
  94. package/resource/knowledge/chat/best-practice/web/audio-message-send.md +123 -0
  95. package/resource/knowledge/chat/preset/android/features/chat-setting.md +1 -4
  96. package/resource/knowledge/chat/preset/android/features/contact-list.md +0 -5
  97. package/resource/knowledge/chat/preset/android/features/conversation-list.md +1 -9
  98. package/resource/knowledge/chat/preset/android/features/language.md +1 -11
  99. package/resource/knowledge/chat/preset/android/features/message-input.md +1 -8
  100. package/resource/knowledge/chat/preset/android/features/message-list.md +1 -10
  101. package/resource/knowledge/chat/preset/android/features/search.md +0 -7
  102. package/resource/knowledge/chat/preset/android/features/theme.md +0 -6
  103. package/resource/knowledge/chat/preset/android-view/integration.md +3 -5
  104. package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +1 -4
  105. package/resource/knowledge/chat/preset/flutter/features/contact-list.md +1 -6
  106. package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +1 -9
  107. package/resource/knowledge/chat/preset/flutter/features/language.md +0 -3
  108. package/resource/knowledge/chat/preset/flutter/features/message-input.md +1 -8
  109. package/resource/knowledge/chat/preset/flutter/features/message-list.md +1 -10
  110. package/resource/knowledge/chat/preset/flutter/features/search.md +0 -7
  111. package/resource/knowledge/chat/preset/flutter/features/theme.md +0 -6
  112. package/resource/knowledge/chat/preset/ios/features/chat-setting.md +1 -4
  113. package/resource/knowledge/chat/preset/ios/features/contact-list.md +1 -8
  114. package/resource/knowledge/chat/preset/ios/features/conversation-list.md +1 -9
  115. package/resource/knowledge/chat/preset/ios/features/language.md +0 -11
  116. package/resource/knowledge/chat/preset/ios/features/message-input.md +1 -8
  117. package/resource/knowledge/chat/preset/ios/features/message-list.md +1 -10
  118. package/resource/knowledge/chat/preset/ios/features/search.md +0 -5
  119. package/resource/knowledge/chat/preset/ios/features/theme.md +0 -6
  120. package/resource/knowledge/chat/preset/ios-uikit/integration.md +5 -17
  121. package/resource/knowledge/chat/preset/react/features/chat-setting.md +0 -2
  122. package/resource/knowledge/chat/preset/react/features/contact-list.md +0 -23
  123. package/resource/knowledge/chat/preset/react/features/conversation-actions.md +2 -11
  124. package/resource/knowledge/chat/preset/react/features/conversation-list.md +2 -23
  125. package/resource/knowledge/chat/preset/react/features/conversation-preview.md +0 -5
  126. package/resource/knowledge/chat/preset/react/features/search.md +0 -1
  127. package/resource/knowledge/chat/preset/vue/features/chat-header.md +1 -3
  128. package/resource/knowledge/chat/preset/vue/features/chat-setting.md +3 -5
  129. package/resource/knowledge/chat/preset/vue/features/contact-list.md +3 -9
  130. package/resource/knowledge/chat/preset/vue/features/conversation-actions.md +0 -3
  131. package/resource/knowledge/chat/preset/vue/features/conversation-list.md +2 -13
  132. package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +2 -5
  133. package/resource/knowledge/chat/preset/vue/features/conversation-search.md +1 -0
  134. package/resource/knowledge/chat/preset/vue/features/message-input.md +2 -4
  135. package/resource/knowledge/chat/preset/vue/features/message-list.md +2 -4
  136. package/resource/knowledge/chat/preset/vue/features/search.md +4 -1
  137. package/resource/knowledge/chat/preset/vue/features/theme.md +4 -6
  138. package/resource/knowledge/chat/urls/sdk/web.md +1 -1
  139. package/resource/knowledge/livekit/best-practice/android/voice-room-anchor-start.md +124 -0
  140. package/resource/knowledge/livekit/best-practice/common/admin-take-seat.md +73 -0
  141. package/resource/knowledge/livekit/best-practice/common/audience-leave-live.md +81 -0
  142. package/resource/knowledge/livekit/best-practice/common/voice-room-no-audio-troubleshoot.md +100 -0
  143. package/resource/knowledge/livekit/best-practice/common/voice-room-seat-list-change.md +65 -0
  144. package/resource/knowledge/livekit/best-practice/flutter/voice-room-anchor-start.md +126 -0
  145. package/resource/knowledge/livekit/best-practice/ios/voice-room-anchor-start.md +130 -0
  146. package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +0 -7
  147. package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +0 -3
  148. package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +0 -3
  149. package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +0 -1
  150. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +0 -5
  151. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +0 -3
  152. package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +0 -2
  153. package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +0 -2
  154. package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +0 -2
  155. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +0 -2
  156. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +0 -1
  157. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +0 -2
  158. package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +1 -3
  159. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +0 -7
  160. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +0 -3
  161. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +0 -1
  162. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +0 -3
  163. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +0 -5
  164. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +0 -3
  165. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +0 -2
  166. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +0 -2
  167. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +0 -2
  168. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +0 -2
  169. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +0 -1
  170. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +0 -2
  171. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +1 -3
  172. package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +0 -7
  173. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +0 -3
  174. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +0 -1
  175. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +0 -3
  176. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +0 -5
  177. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +0 -3
  178. package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +0 -2
  179. package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +0 -2
  180. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +0 -2
  181. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +0 -2
  182. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +0 -1
  183. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +0 -2
  184. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +1 -3
  185. package/resource/knowledge/livekit/core-sdk/features/android/audience-list.md +2 -2
  186. package/resource/knowledge/livekit/core-sdk/features/android/audio-effect.md +1 -3
  187. package/resource/knowledge/livekit/core-sdk/features/android/barrage.md +2 -2
  188. package/resource/knowledge/livekit/core-sdk/features/android/base-beauty.md +0 -2
  189. package/resource/knowledge/livekit/core-sdk/features/android/gift.md +2 -7
  190. package/resource/knowledge/livekit/core-sdk/features/android/live-list.md +2 -2
  191. package/resource/knowledge/livekit/core-sdk/features/flutter/audience-list.md +2 -2
  192. package/resource/knowledge/livekit/core-sdk/features/flutter/audio-effect.md +0 -4
  193. package/resource/knowledge/livekit/core-sdk/features/flutter/barrage.md +2 -2
  194. package/resource/knowledge/livekit/core-sdk/features/flutter/base-beauty.md +0 -2
  195. package/resource/knowledge/livekit/core-sdk/features/flutter/gift.md +3 -7
  196. package/resource/knowledge/livekit/core-sdk/features/flutter/live-list.md +3 -2
  197. package/resource/knowledge/livekit/core-sdk/features/ios/audience-list.md +2 -2
  198. package/resource/knowledge/livekit/core-sdk/features/ios/audio-effect.md +1 -3
  199. package/resource/knowledge/livekit/core-sdk/features/ios/barrage.md +2 -2
  200. package/resource/knowledge/livekit/core-sdk/features/ios/base-beauty.md +0 -2
  201. package/resource/knowledge/livekit/core-sdk/features/ios/gift.md +2 -7
  202. package/resource/knowledge/livekit/core-sdk/features/ios/live-list.md +2 -2
  203. package/resource/knowledge/livekit/core-sdk/features/uni-app/audience-list.md +2 -2
  204. package/resource/knowledge/livekit/core-sdk/features/uni-app/audio-effect.md +1 -2
  205. package/resource/knowledge/livekit/core-sdk/features/uni-app/barrage.md +2 -2
  206. package/resource/knowledge/livekit/core-sdk/features/uni-app/base-beauty.md +0 -2
  207. package/resource/knowledge/livekit/core-sdk/features/uni-app/gift.md +4 -8
  208. package/resource/knowledge/livekit/core-sdk/features/uni-app/live-list.md +2 -2
  209. package/resource/knowledge/livekit/core-sdk/live/android/co-guest-interaction.md +0 -3
  210. package/resource/knowledge/livekit/core-sdk/live/android/host-interaction.md +0 -2
  211. package/resource/knowledge/livekit/core-sdk/live/android/integration.md +0 -7
  212. package/resource/knowledge/livekit/core-sdk/live/flutter/co-guest-interaction.md +0 -2
  213. package/resource/knowledge/livekit/core-sdk/live/flutter/host-interaction.md +0 -2
  214. package/resource/knowledge/livekit/core-sdk/live/flutter/integration.md +1 -7
  215. package/resource/knowledge/livekit/core-sdk/live/ios/co-guest-interaction.md +0 -3
  216. package/resource/knowledge/livekit/core-sdk/live/ios/host-interaction.md +0 -2
  217. package/resource/knowledge/livekit/core-sdk/live/ios/integration.md +0 -7
  218. package/resource/knowledge/livekit/core-sdk/live/uni-app/co-guest-interaction.md +0 -2
  219. package/resource/knowledge/livekit/core-sdk/live/uni-app/host-interaction.md +0 -2
  220. package/resource/knowledge/livekit/core-sdk/live/uni-app/integration.md +0 -5
  221. package/resource/knowledge/livekit/core-sdk/voice/android/co-guest-interaction.md +1 -3
  222. package/resource/knowledge/livekit/core-sdk/voice/android/host-interaction.md +4 -13
  223. package/resource/knowledge/livekit/core-sdk/voice/android/integration.md +5 -5
  224. package/resource/knowledge/livekit/core-sdk/voice/flutter/co-guest-interaction.md +0 -3
  225. package/resource/knowledge/livekit/core-sdk/voice/flutter/integration.md +18 -21
  226. package/resource/knowledge/livekit/core-sdk/voice/ios/co-guest-interaction.md +0 -2
  227. package/resource/knowledge/livekit/core-sdk/voice/ios/host-interaction.md +2 -11
  228. package/resource/knowledge/livekit/core-sdk/voice/ios/integration.md +8 -8
  229. package/resource/knowledge/livekit/core-sdk/voice/uni-app/co-guest-interaction.md +0 -2
  230. package/resource/knowledge/livekit/core-sdk/voice/uni-app/integration.md +1 -4
  231. package/resource/knowledge/livekit/faq/error-code.md +1 -1
  232. package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +0 -5
  233. package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +1 -1
  234. package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +0 -3
  235. package/resource/knowledge/push/api-reference/donut.md +1 -6
  236. package/resource/knowledge/push/api-reference/harmonyos.md +0 -2
  237. package/resource/knowledge/push/api-reference/react-native.md +0 -3
  238. package/resource/knowledge/push/api-reference/uni-app.md +3 -5
  239. package/resource/knowledge/push/api-reference/unity.md +0 -1
  240. package/resource/knowledge/push/api-reference/unreal-engine.md +0 -1
  241. package/resource/knowledge/push/config/android/fcm.md +0 -6
  242. package/resource/knowledge/push/config/android/honor.md +1 -7
  243. package/resource/knowledge/push/config/android/huawei.md +1 -9
  244. package/resource/knowledge/push/config/android/meizu.md +1 -7
  245. package/resource/knowledge/push/config/android/oppo.md +1 -3
  246. package/resource/knowledge/push/config/android/vivo.md +1 -12
  247. package/resource/knowledge/push/config/android/xiaomi.md +0 -5
  248. package/resource/knowledge/push/config/donut.md +0 -12
  249. package/resource/knowledge/push/config/harmonyos.md +18 -7
  250. package/resource/knowledge/push/config/ios.md +26 -33
  251. package/resource/knowledge/push/config/react-native.md +0 -30
  252. package/resource/knowledge/push/config/unity.md +0 -30
  253. package/resource/knowledge/push/config/unreal-engine.md +0 -30
  254. package/resource/knowledge/push/integration/android.md +148 -57
  255. package/resource/knowledge/push/integration/donut.md +5 -21
  256. package/resource/knowledge/push/integration/flutter.md +4 -6
  257. package/resource/knowledge/push/integration/harmonyos.md +17 -16
  258. package/resource/knowledge/push/integration/ios.md +30 -18
  259. package/resource/knowledge/push/integration/react-native.md +10 -60
  260. package/resource/knowledge/push/integration/uni-app.md +3 -25
  261. package/resource/knowledge/push/integration/unity.md +8 -77
  262. package/resource/knowledge/push/integration/unreal-engine.md +37 -96
  263. package/resource/knowledge/roomkit/best-practice/common/room-ghost-member.md +75 -0
  264. package/resource/knowledge/roomkit/best-practice/common/room-limit-and-multi.md +88 -0
  265. package/resource/knowledge/roomkit/best-practice/common/room-screen-share-preview.md +87 -0
  266. package/resource/knowledge/roomkit/best-practice/common/room-status-after-all-leave.md +73 -0
  267. package/resource/knowledge/roomkit/best-practice/vue/room-uikit-vs-atomicx.md +115 -0
  268. package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +0 -2
  269. package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +0 -2
  270. package/resource/knowledge/roomkit/core-sdk/android/room-state.md +3 -5
  271. package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +4 -6
  272. package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +0 -2
  273. package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +0 -2
  274. package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md +2 -4
  275. package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md +4 -6
  276. package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md +0 -2
  277. package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +0 -2
  278. package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +3 -5
  279. package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md +4 -6
  280. package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +0 -5
  281. package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +0 -3
  282. package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +0 -5
  283. package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +0 -3
  284. package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +1 -7
  285. package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +1 -2
  286. package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +0 -1
  287. package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +0 -3
  288. package/resource/knowledge/roomkit/preset/android/integration.md +202 -6
  289. package/resource/knowledge/roomkit/preset/flutter/integration.md +1 -16
  290. package/resource/knowledge/roomkit/preset/ios/integration.md +201 -7
  291. package/resource/knowledge/roomkit/preset/react/integration.md +205 -4
  292. package/resource/knowledge/rtcengine/web/api.md +0 -2
  293. package/resource/knowledge/rtcengine/web/plugin/22-advanced-audio-mixer.md +2 -2
  294. package/resource/knowledge/rtcengine/web/plugin/23-advanced-support-detection.md +3 -3
  295. package/resource/knowledge/rtcengine/web/plugin/28-advanced-beauty.md +1 -1
  296. package/resource/knowledge/rtcengine/web/plugin/30-advanced-cross-room-link.md +2 -0
  297. package/resource/knowledge/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -4
  298. package/resource/knowledge/rtcengine/web/plugin/39-advanced-video-decoder.md +2 -0
  299. package/resource/knowledge/share/userSig.md +2 -2
  300. package/resource/knowledge/trtc/android/TRTCCloud.md +16 -16
  301. package/resource/knowledge/trtc/android/TRTCCloudDef.md +5 -5
  302. package/resource/knowledge/trtc/android/TRTCCloudListener.md +3 -3
  303. package/resource/knowledge/trtc/android/TXAudioEffectManager.md +2 -2
  304. package/resource/knowledge/trtc/android/TXDeviceManager.md +1 -1
  305. package/resource/knowledge/trtc/c++/ITRTCCloud.md +14 -14
  306. package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +2 -2
  307. package/resource/knowledge/trtc/c++/ITXDeviceManager.md +4 -4
  308. package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +3 -3
  309. package/resource/knowledge/trtc/c++/TRTCTypeDef.md +5 -5
  310. package/resource/knowledge/trtc/ios/TRTCCloud.md +14 -14
  311. package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +3 -3
  312. package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +2 -2
  313. package/resource/knowledge/trtc/ios/TXDeviceManager.md +4 -4
  314. package/resource/knowledge/trtc/ios/TXLiveSDKTypeDef.md +5 -5
  315. package/server.js +8 -3
  316. package/tools/common/finalize_answer.js +9 -1
  317. package/tools/common/search_trtc_knowledge.js +3 -1
  318. package/tools/definitions/finalize_answer_def.js +2 -2
  319. package/tools/definitions/integration-boundary.js +2 -1
  320. package/tools/definitions/search_trtc_knowledge_def.js +2 -1
  321. package/utils/report-cls-client.js +3 -3
  322. package/utils/report-es-client.js +1 -1
  323. package/cursor-setting.png +0 -0
  324. package/mcp-server-prompt.png +0 -0
  325. package/resource/knowledge/callkit/best-practice/web/callengine-invitation.md +0 -80
  326. package/resource/knowledge/callkit/best-practice/web/callengine-log-control.md +0 -20
  327. package/resource/knowledge/callkit/best-practice/web/callkit-call-vs-calls.md +0 -116
  328. package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +0 -475
  329. package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +0 -587
  330. package/resource/knowledge/callkit/preset/web/api.md +0 -79
  331. package/resource/knowledge/chat/best-practice/web/image-message-url-handling.md +0 -16
@@ -1,8 +1,22 @@
1
+ ## 前提条件
2
+
3
+ 请确认已 开通 Push 服务 并完成 厂商配置,获取到了下列信息:
4
+
5
+ |资源|获取位置|用途|
6
+ |---------|---------|---------|
7
+ |`SDKAppID`|腾讯云控制台 > 即时通信 IM > **推送服务 Push** > **概览**|调用 `registerPush`。创建 Push 应用后,腾讯云控制台会自动创建相同 `SDKAppID` 的 Chat 应用。|
8
+ |Push Key|腾讯云控制台 > 即时通信 IM > **推送服务 Push** > **概览** > **客户端密钥**|独立 Push 场景下,作为 `registerPush` 的 `appKey` 参数。|
9
+ |Chat Key|腾讯云控制台 > 即时通信 IM > **消息服务 Chat** > **概览** > **密钥**|Chat 登录使用。不要把 Chat Key 当作 `registerPush` 的 `appKey` 传入。|
10
+ |Push 服务开通状态|腾讯云控制台 > 即时通信 IM > **推送服务 Push** > **概览**|创建 Push 应用不等于已开通 Push 服务,请确认 Push 服务已开通。|
11
+ |TIMPush iOS `VERSION`|更新日志|`VERSION` 是 Podfile 中 TIMPush 依赖的版本号占位符,例如 `8.9.7537`、`8.8.7357`、`8.7.7201` 等,请以实际接入版本为准。|
12
+
13
+ 本文示例中的 `VERSION`、`SDKAppID`、`AppKey`、`businessID`、App Group ID 均为占位符,请勿在代码仓库中提交真实密钥。
14
+
1
15
  ## 操作步骤
2
16
 
3
17
  ### 步骤1:集成 TIMPush
4
18
 
5
- 完成 [厂商配置](https://cloud.tencent.com/document/product/269/108856) 后,集成 SDK:
19
+ 集成 SDK:
6
20
  ``` java
7
21
  // 版本号 “VERSION” 请前往 中获取配置。
8
22
  // oh-package.json5 中配置集成包
@@ -15,13 +29,6 @@ dependencies: {
15
29
  ### 步骤2:注册推送
16
30
 
17
31
  调用接口推送注册成功后,就可以收到离线推送通知了。
18
-
19
- > **说明:**
20
- >
21
- > 注册接口必填参数 SDKAppID 和客户端密钥 AppKey 的获取路径是 [IM 控制台 > 推送服务 Push > 概览](https://console.cloud.tencent.com/im/push-plugin-push-identifier),如下图所示:
22
- >
23
- >
24
-
25
32
  ``` java
26
33
  import { TIMPushListener, TIMPushManager, TIMPushMessage } from '@tencentcloud/timpush';
27
34
 
@@ -43,14 +50,13 @@ TIMPushManager.getInstance()
43
50
 
44
51
  ### 步骤4:发送推送消息
45
52
 
46
- 您可以在 [控制台 > 接入测试](https://console.cloud.tencent.com/im/push-plugin-push-check) 指定 `RegistrationID/userID` 进行离线推送测试。REST API 接口详细说明可参见:[REST API 接口 > 发起全员/标签推送](https://cloud.tencent.com/document/product/269/100634)。
53
+ 您可以在 [接入测试](https://console.cloud.tencent.com/im/push-plugin-push-check) 指定 `RegistrationID/userID` 进行离线推送测试。REST API 接口详细说明可参见:[全员/标签推送](https://cloud.tencent.com/document/product/269/100634)。
47
54
 
48
55
  ### 步骤5:解析离线推送消息
49
56
 
50
57
  收到推送消息后点击通知栏,组件会回调该点击事件和透传离线消息。
51
58
 
52
59
  > **注意:**
53
- >
54
60
  > 1. 注册回调时机必须放在应用 [UIAbility](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/uiability-lifecycle) 的 onCreate() 函数中。
55
61
  > 2. 控制台配置点击后续动作按如下配置,选择**打开应用内指定界面**,请勿修改默认值。
56
62
  >
@@ -65,9 +71,4 @@ let pushListener: TIMPushListener = {
65
71
  TIMPushManager.getInstance().addPushListener(pushListener);
66
72
  ```
67
73
 
68
- 恭喜您已经完成了推送插件的接入,需要提醒您:推送插件**试用或购买到期后,将自动停止提供推送服务(包括普通消息离线推送、全员/标签推送等服务)**。为避免影响您业务正常使用,请提前 [购买](https://buy.cloud.tencent.com/avc)/[续费](https://console.cloud.tencent.com/account/renewal)。
69
-
70
- > **说明:**
71
- >
72
- > - 接入完成收不到推送,请先自助使用 [排查工具](https://cloud.tencent.com/document/product/269/100629) 查看下具体原因。推送指标数据查看,请使用 [数据统计](https://cloud.tencent.com/document/product/269/100628) 查询。
73
- > - 全员/标签推送功能请参见:[REST API 接口 - 发起全员/标签推送](https://cloud.tencent.com/document/product/269/100634)。
74
+ 恭喜您已经完成了推送插件的接入。如果接入完成收不到推送,请使用 [排查工具](https://cloud.tencent.com/document/product/269/100629) 查看具体原因。
@@ -18,10 +18,9 @@
18
18
 
19
19
  ## AI 集成
20
20
 
21
- 通过 npm 安装 [@tencent-rtc/trtc-push-skill](https://www.npmjs.com/package/@tencent-rtc/trtc-push-skill/v/1.0.1#%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87) 到本地 AI IDE 中,辅助完成 TIMPush 离线推送集成。安装后,你可以直接向 AI 输入“集成 iOS 离线推送”“帮我集成 iOS TIMPush”等需求,AI 将根据项目类型引导你完成环境检测、厂商通道配置、凭据填写、代码接入和验证等步骤。
21
+ 通过 npx 安装 [@tencent-rtc/trtc-push-skill](https://www.npmjs.com/package/@tencent-rtc/trtc-push-skill/v/1.0.1#%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87) 到本地 AI IDE 中,辅助完成 TIMPush 离线推送集成。安装后,你可以直接向 AI 输入“集成 iOS 离线推送”“帮我集成 iOS TIMPush”等需求,AI 将根据项目类型引导你完成环境检测、厂商通道配置、凭据填写、代码接入和验证等步骤。
22
22
 
23
23
  > **注意:**
24
- >
25
24
  > 使用 Push Skill AI 集成不是全自动流程,依然需要开发者在厂商配置控制台、腾讯云控制台等配置 Push 相关信息。具体的配置方法请参考下文相关章节。
26
25
  >
27
26
 
@@ -60,7 +59,6 @@ pod install
60
59
  如果无法安装 TIMPush 最新版本,可先执行 `pod repo update` 更新本地 CocoaPods 仓库列表后再 `pod install`。仓库更新可能耗时较长且影响依赖解析结果,建议在确认版本后执行。
61
60
 
62
61
  > **注意:**
63
- >
64
62
  > 无论 Swift 还是 Objective-C 项目,都请集成 TXIMSDK_Plus_iOS_XCFramework。
65
63
  >
66
64
 
@@ -131,8 +129,10 @@ import TIMPush
131
129
 
132
130
  ### registerPush
133
131
 
134
- registerPush 用于注册当前设备的推送 token。注册成功后,后台才能根据 `registrationID` 或 `userID` 向该设备下发离线推送。其中 `appKey` 的取值会影响注册方式:
135
- - `appKey = Push Key`:注册 TIMPush 独立推送能力。Push Key 为腾讯云控制台 > 即时通信 IM > 推送服务 Push > 概览中的客户端密钥。
132
+ registerPush 用于向 TIMPush 注册当前设备的推送 token。推送 token 是厂商通道返回的设备凭证,通常由 SDK 自动处理。注册成功后,TIMPush 会为当前设备建立一个推送目标标识 `registrationID`;服务端、控制台接入测试和排查工具可以使用该标识向这台设备下发离线推送。若 App 同时接入 IM 并完成登录,也可以使用 `userID` 向该用户已建立推送关系的设备下发离线推送。
133
+
134
+ `appKey` 的取值会影响注册方式和可用的推送标识:
135
+ - `appKey = Push Key`:注册 TIMPush 独立推送能力。Push Key 为腾讯云控制台 > 即时通信 IM > **推送服务 Push** > **概览**中的客户端密钥。
136
136
 
137
137
  - `appKey = nil`:复用 IM 登录态注册推送,必须在 IM `login` 成功后调用。
138
138
 
@@ -207,8 +207,13 @@ func loginIMAndRegisterPush() {
207
207
  let userID = "<#YOUR_USER_ID#>"
208
208
  let userSig = "<#YOUR_USER_SIG#>"
209
209
 
210
+ let initSuccess = V2TIMManager.sharedInstance().initSDK(sdkAppID, config: V2TIMSDKConfig())
211
+ if !initSuccess {
212
+ print(">>>>> IM SDK init failed")
213
+ return
214
+ }
215
+
210
216
  V2TIMManager.sharedInstance().login(userID: userID, userSig: userSig) {
211
- // Swift 桥接下 appKey 类型为非可选 String,IM 登录场景传空字符串等同于 OC 接口传 nil。
212
217
  TIMPushManager.registerPush(sdkAppID, appKey: "", succ: { deviceToken in
213
218
  print(">>>>> TIMPush register success")
214
219
  }, fail: { code, desc in
@@ -231,6 +236,13 @@ func loginIMAndRegisterPush() {
231
236
  NSString *userID = @"<#YOUR_USER_ID#>";
232
237
  NSString *userSig = @"<#YOUR_USER_SIG#>";
233
238
 
239
+ V2TIMSDKConfig *config = [[V2TIMSDKConfig alloc] init];
240
+ BOOL initSuccess = [[V2TIMManager sharedInstance] initSDK:sdkAppID config:config];
241
+ if (!initSuccess) {
242
+ NSLog(@">>>>> IM SDK init failed");
243
+ return;
244
+ }
245
+
234
246
  [[V2TIMManager sharedInstance] login:userID userSig:userSig succ:^{
235
247
  [TIMPushManager registerPush:sdkAppID
236
248
  appKey:nil
@@ -242,9 +254,14 @@ func loginIMAndRegisterPush() {
242
254
  } fail:^(int code, NSString *msg) {
243
255
  NSLog(@">>>>> IM login failed, code:%d, msg:%@", code, msg);
244
256
  }];
245
- }Objective-C
257
+ }
246
258
  ```
247
259
 
260
+ > **警告:**
261
+ >
262
+ > 如果你的业务仅使用即时通信 IM 聊天能力,请勿在 IM 登录前先调用 `registerPush`。否则 SDK 可能会按独立推送场景注册 Push 类型账号,并产生对应的 Push DAU。Push DAU 超出套餐额度后,可能会产生额外费用。
263
+ >
264
+
248
265
  **验证**:
249
266
 
250
267
  1. `registerPush` 的 `onSuccess` 回调被触发。
@@ -258,7 +275,6 @@ func loginIMAndRegisterPush() {
258
275
  如需自定义推送标识(如使用业务侧用户 ID),可在 `registerPush` **前**调用 setRegistrationID。
259
276
 
260
277
  > **注意:**
261
- >
262
278
  > 混用场景下,自定义 `registrationID` 必须与 IM 登录使用的 `userID` 完全一致,否则会产生账号互踢导致推送丢失。
263
279
  >
264
280
 
@@ -303,12 +319,10 @@ func loginIMAndRegisterPush() {
303
319
 
304
320
  ### 开启 `mutable-content`
305
321
 
306
- `mutable-content` 是 APNs payload 字段,由发送方在推送内容中设置。只有 payload 中开启 `mutable-content`,iOS 10 及以上系统才会在送达前调用 Notification Service Extension,触达统计才能生效。
307
-
308
- 请确保通过以下任一方式开启 `mutable-content`:
309
- - **腾讯云控制台推送**:在控制台推送测试或发送页面,勾选 `mutable-content` 相关选项。
322
+ `mutable-content` 是 APNs payload 字段,由发送方在推送内容中设置。只有 payload 中开启 `mutable-content`,iOS 10 及以上系统才会在送达前调用 Notification Service Extension,触达统计才能生效。请确保通过以下任一方式开启 `mutable-content`:
323
+ - **腾讯云控制台推送**:在控制台页面,勾选 `mutable-content` 。页面路径:控制台 > 推送服务 Push > 推送设置 > 厂商配置 > iOS > 添加/编辑证书 > 开启 mutable-content。示例图如下:
310
324
 
311
- - **服务端 REST API**:在 APNs payload 中设置 `"mutable-content": 1`。
325
+ - **服务端 REST API**:在 [ApnsInfo](https://cloud.tencent.com/document/product/269/128209#c4a6ae39-6bdc-439a-b769-0f4e92f6d539) 中设置 `"MutableContent": 1`。
312
326
 
313
327
  - **Chat SDK 发送**:以 Chat SDK 离线推送配置文档为准。
314
328
 
@@ -409,7 +423,6 @@ import ImSDK_Plus
409
423
  let pushInfo = V2TIMOfflinePushInfo()
410
424
  pushInfo.title = "推送标题"
411
425
  pushInfo.desc = "推送内容"
412
- pushInfo.ext = "{\"action\":\"open_chat\",\"conversationID\":\"c2c_userA\"}"
413
426
 
414
427
  let message = V2TIMManager.sharedInstance().createTextMessage("Hello TIMPush")
415
428
 
@@ -437,7 +450,6 @@ V2TIMManager.sharedInstance().sendMessage(
437
450
  V2TIMOfflinePushInfo *pushInfo = [[V2TIMOfflinePushInfo alloc] init];
438
451
  pushInfo.title = @"推送标题";
439
452
  pushInfo.desc = @"推送内容";
440
- pushInfo.ext = @"{\"action\":\"open_chat\",\"conversationID\":\"c2c_userA\"}";
441
453
 
442
454
  V2TIMMessage *message = [[V2TIMManager sharedInstance] createTextMessage:@"Hello TIMPush"];
443
455
 
@@ -457,7 +469,7 @@ V2TIMMessage *message = [[V2TIMManager sharedInstance] createTextMessage:@"Hello
457
469
 
458
470
  `sendMessage` 属于 IMSDK 消息发送能力。仅集成 TIMPush 的用户不需要为了验证离线推送而额外接入完整 Chat 初始化、登录和消息发送流程。
459
471
 
460
- **验证**:App 置于后台后发送测试消息,设备能收到离线推送通知。如果手机通知栏开启权限,通知栏会弹出离线推送消息弹框。如果收不到,请参见下文「收不到推送排障流程」逐步排查。
472
+ **验证**:App 置于后台后发送测试消息,设备能收到离线推送通知。如果手机通知栏开启权限,通知栏会弹出离线推送消息弹框。如果收不到。
461
473
 
462
474
  ## 处理通知点击跳转
463
475
 
@@ -648,7 +660,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate, TIMPushListener {
648
660
  @end
649
661
  ```
650
662
 
651
- **验证**:点击通知后 `onNotificationClicked` 被调用,且 `ext` 内容与发送时设置的一致。如果回调未触发,请检查:控制台点击动作是否选择了「打开应用内指定页面」、监听器是否在 `didFinishLaunchingWithOptions` 中注册、发送消息时是否设置了 `ext`。
663
+ **验证**:点击通知后 `onNotificationClicked` 被调用,且 `ext` 内容与发送时设置的一致。如果回调未触发,请检查:控制台点击动作是否选择了**打开应用内指定页面**、监听器是否在 `didFinishLaunchingWithOptions` 中注册、发送消息时是否设置了 `ext`。
652
664
 
653
665
  ## 收不到推送排障流程
654
666
 
@@ -673,7 +685,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate, TIMPushListener {
673
685
  ### 步骤3:确认控制台排查工具能查到 token
674
686
 
675
687
  在腾讯云控制台 **即时通信 IM > 推送服务 Push** 的排查工具中输入 `registrationID` 或 `userID`:
676
- - **能查到设备且 token 正常**:进入第四步。
688
+ - **能查到设备且 token 正常**:进入步骤4。
677
689
 
678
690
  - **查不到设备 / 显示「没有上传成功 token」**:常见原因是 Chat 场景未在 Chat 登录成功后调用 `registerPush`,或调用顺序错误。请重新核对调用时机。
679
691
 
@@ -1,10 +1,14 @@
1
1
  ### 效果展示
2
- | 小米 11 Pro | iPhone 13 | 三星 Galaxy A23 海外版(Google FCM 推送) |
3
- | --- | --- | --- |
2
+
3
+ ## 前提条件
4
+
5
+ 开始接入前,请先完成对应原生平台的推送前提配置:请参见 [iOS 前提条件](https://cloud.tencent.com/document/product/269/100627#.E5.89.8D.E6.8F.90.E6.9D.A1.E4.BB.B6) 和 [Android 前提条件](https://cloud.tencent.com/document/product/269/100626#.E5.89.8D.E6.8F.90.E6.9D.A1.E4.BB.B6)。
6
+
7
+ ## 操作步骤
4
8
 
5
9
  ### 步骤1:新建项目(可选)
6
10
 
7
- 完成 [厂商配置](https://cloud.tencent.com/document/product/269/104004) 后,创建一个 React Native 项目,已有项目可忽略此步骤。
11
+ 完成各原生平台厂商配置后,创建一个 React Native 项目,已有项目可忽略此步骤。
8
12
  ``` bash
9
13
  npx @react-native-community/cli@latest init MyReactNativeApp --version 0.75.0
10
14
  ```
@@ -28,7 +32,6 @@ yarn add @tencentcloud/react-native-push
28
32
  复制下面的代码到 `App.tsx`,将 `SDKAppID` 和 `appKey` 替换为您在 [IM 控制台 > 推送服务 Push > 概览](https://console.cloud.tencent.com/im/push-plugin-push-identifier) 获取的应用的信息。
29
33
 
30
34
  > **说明:**
31
- >
32
35
  > `registerPush` 注册推送服务成功后,您可通过 `getRegistrationID` 获取推送 ID 标识, 即 RegistrationID。您可以向指定的 RegistrationID 推送消息。
33
36
  >
34
37
 
@@ -77,20 +80,16 @@ if (Push) {
77
80
  ### 步骤4:配置厂商推送
78
81
 
79
82
  【Android】
80
- 1. 请您完成控制台厂商推送信息填写后,从控制台下载 `timpush-configs.json` 文件,并添加到项目的 `MyReactNativeApp/android/app/src/main/assets` 目录下,如果该目录不存在,请手动创建。如图所示:
81
83
 
82
84
  2. 华为、荣耀、vivo、FCM。
83
85
 
84
86
  【FCM】
85
87
 
86
- 您需要支持 FCM 推送时,须配置 `google-services.json` 文件到 `MyReactNativeApp/android/app` 目录下,如图所示:
87
-
88
88
  (**请注意:不是 "**`MyReactNativeApp/android/app/src/main/assets" 目录`)。
89
89
 
90
90
  【华为】
91
91
 
92
92
  【荣耀】
93
- 1. 您需要支持荣耀推送时,须配置 `AppID` 到 `MyReactNativeApp/android/app/build.gradle` 文件中。如图所示:
94
93
 
95
94
  ``` bash
96
95
  ......
@@ -105,15 +104,10 @@ android {
105
104
  }
106
105
  ```
107
106
 
108
- |获取荣耀的 appID|配置荣耀的 appID|
109
- |---------|---------|
110
- |||
111
-
112
107
  2. 从[荣耀开发者管理中心](https://developer.honor.com/cn/)下载 `mcs-services.json` 文件,并配置到 `MyReactNativeApp/android/app` 目录下(**请注意!不是** `MyReactNativeApp/android/app/src/main/assets 目录`)。
113
108
 
114
109
  【vivo】
115
110
 
116
- 您需要支持 vivo 推送时,须配置 `appID` 和 `appKey` 到 `MyReactNativeApp/android/app/build.gradle` 文件中。如图所示:
117
111
  ``` bash
118
112
  ......
119
113
  android {
@@ -128,12 +122,7 @@ android {
128
122
  }
129
123
  ```
130
124
 
131
- |获取 vivo 的 appID && appKey|配置 vivo 的 appID && appKey|
132
- |---------|---------|
133
- |||
134
-
135
125
  【iOS】
136
- 1. 请将您在厂商配置步骤中, 获取到的 iOS APNs 推送证书,上传至 IM 控制台。IM 控制台会为您分配一个证书 ID,如图所示:
137
126
 
138
127
  2. 在 `MyReactNativeApp/ios/MyReactNativeApp` 目录下,新建 `Resources` 文件夹,并新建 `timpush-configs.json` 文件。编辑 `timpush-configs.json`,填入控制台获取的证书 ID,如下所示:
139
128
 
@@ -143,14 +132,11 @@ android {
143
132
  }
144
133
  ```
145
134
 
146
- 3. Xcode 打开 MyReactNativeApp 项目,右键单击项目 > **Add Files to "MyReactNativeApp"**,将 `timpush-configs.json` 文件添加到工程。如图所示:
147
-
148
135
  ### 步骤5:**配置 Native Modules 和相关依赖**
149
136
 
150
137
  【Android】
151
138
 
152
139
  > **说明:**
153
- >
154
140
  > 请确保 `timpush-configs.json` 文件内的包名和 `MyReactNativeApp/android/app/build.gradle` 文件内的 `applicationId` 值一致,不一致则会导致离线推送不可用。
155
141
  >
156
142
 
@@ -274,7 +260,7 @@ pod install
274
260
  # 如果无法安装最新版本,执行以下命令更新本地的 CocoaPods 仓库列表
275
261
  pod repo update
276
262
  ```
277
- 3. 在 App 中启用推送通知功能。打开 Xcode 项目,在 **Project > Target > Capabilities** 页面选择并添加 **Push Notifications**。
263
+ 3. 在 App 中启用推送通知功能。参考 iOS 配置消息触达统计。
278
264
 
279
265
  ### 步骤6:运行
280
266
 
@@ -292,42 +278,6 @@ npm run ios
292
278
 
293
279
  ### 步骤7:消息推送触达统计
294
280
 
295
- 如果您需要统计触达数据,请按照如下完成配置:
296
-
297
- 【华为】
298
-
299
- 回执地址:`https://api.im.qcloud.com/v3/offline_push_report/huawei`
300
-
301
- > **说明:**
302
- >
303
- > 华为推送证书 ID <= 11344时,使用华为推送 v2 版本接口,不支持触达和点击回执,请重新生成更新证书 ID。
304
- >
305
-
306
- 【荣耀】
307
-
308
- 回执地址:`https://api.im.qcloud.com/v3/offline_push_report/honor`
309
-
310
- 【vivo】
311
-
312
- |回调地址配置|回执 ID 配置到 IM 控制台|
313
- |---------|---------|
314
- |<br>回执地址:`https://api.im.qcloud.com/v3/offline_push_report/vivo`||
315
-
316
- 【魅族】
317
-
318
- |打开回执开关|配置回执地址|
319
- |---------|---------|
320
- |||
321
-
322
- 回执地址:`https://api.im.qcloud.com/v3/offline_push_report/meizu`
323
-
324
- > **说明:**
325
- >
326
- > 打开回执开关后,请务必确保回执地址正确配置。不配置或者配置地址错误,都会影响推送功能。
327
- >
328
-
329
- 【iOS】
330
-
331
- iOS 端推送触达统计配置,详细请参见 [**统计推送抵达率**](https://cloud.tencent.com/document/product/269/100627#2412d9f3-8e82-4df6-baf9-2855aaaa0a2c)。
281
+ 如果你需要统计设备触达数据,请按照 华为/荣耀/vivo/魅族/iOS 步骤完成配置。其余支持厂商不需要配置,FCM 暂不支持推送统计功能。
332
282
 
333
- 其余支持厂商不需要配置,FCM 暂不支持推送统计功能。
283
+ 如果接入完成收不到推送,请使用 [排查工具](https://cloud.tencent.com/document/product/269/100629) 查看具体原因。
@@ -12,10 +12,9 @@
12
12
 
13
13
  ## AI 集成
14
14
 
15
- 通过 npm 安装 [@tencent-rtc/trtc-push-skill](https://www.npmjs.com/package/@tencent-rtc/trtc-push-skill/v/1.0.1#%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87) 到本地 AI IDE 中,辅助完成 TIMPush 离线推送集成。安装后,你可以直接向 AI 输入“集成 uniapp 离线推送”“帮我集成 uniapp TIMPush”等需求,AI 将根据项目类型引导你完成环境检测、厂商通道配置、凭据填写、代码接入和验证等步骤。
15
+ 通过 npx 安装 [@tencent-rtc/trtc-push-skill](https://www.npmjs.com/package/@tencent-rtc/trtc-push-skill/v/1.0.1#%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87) 到本地 AI IDE 中,辅助完成 TIMPush 离线推送集成。安装后,你可以直接向 AI 输入“集成 uniapp 离线推送”“帮我集成 uniapp TIMPush”等需求,AI 将根据项目类型引导你完成环境检测、厂商通道配置、凭据填写、代码接入和验证等步骤。
16
16
 
17
17
  > **注意:**
18
- >
19
18
  > 使用 Push Skill AI 集成不是全自动流程,依然需要开发者在厂商配置控制台、腾讯云控制台等配置 Push 相关信息。具体的配置方法请参考下文相关章节。
20
19
  >
21
20
 
@@ -28,12 +27,9 @@
28
27
 
29
28
  2. 选择需要集成的工程并单击**确定**。
30
29
 
31
- 3. 集成后效果如下图所示:
32
-
33
30
  ### 配置离线推送文件
34
31
 
35
32
  > **说明:**
36
- >
37
33
  > - 推送配置文件统一放在与 `uni_modules` 平级的 `nativeResources` 目录下,若该目录不存在请手动新建。
38
34
  > - 建议将 HBuilderX 与 TencentCloud-Push 插件升级到最新版本,以规避旧版本(如 HBuilderX 4.36 之前)在 vivo/荣耀 等厂商通道上的兼容性问题。
39
35
 
@@ -42,8 +38,6 @@
42
38
  【Android】
43
39
  1. 新建 `nativeResources/android/assets` 目录。
44
40
 
45
- 2. 配置 `timpush-configs.json`(在 [推送服务 Push > 推送设置 > 厂商配置](https://console.cloud.tencent.com/im/push-plugin-push-setting) 下载),到 `nativeResources/android/assets/` 目录下。如图所示:
46
-
47
41
  3. 按目标厂商配置华为、荣耀、vivo、FCM。
48
42
 
49
43
  【FCM】
@@ -63,19 +57,13 @@
63
57
  }
64
58
  ```
65
59
 
66
- 2. 配置 `google-services.json` 文件到 `nativeResources/android/`目录下(注意!请勿配置到 `nativeResources/android/assets` 目录下)。如图所示:
67
-
68
60
  【华为】
69
61
 
70
62
  > **注意:**
71
- >
72
63
  > **请勿配置**到 `nativeResources/android/assets` 目录下。
73
64
  >
74
65
 
75
- 如图所示:
76
-
77
66
  【荣耀】
78
- 1. 编辑 `uni_modules/TencentCloud-Push/utssdk/app-android/config.json` 的 `dependencies`,添加 `"com.tencent.timpush:honor:xxxx"`。如图所示:
79
67
 
80
68
  ``` bash
81
69
  {
@@ -87,8 +75,6 @@
87
75
  }
88
76
  ```
89
77
 
90
- 2. 配置 `mcs-services.json` 文件到 `nativeResources/android`(在荣耀开发者服务平台下载,详见 荣耀厂商配置)目录下。如图所示:
91
-
92
78
  3. 配置 `appID` 到 `nativeResources/android/manifestPlaceholders.json` 中的 `"HONOR_APPID"`。
93
79
 
94
80
  ``` bash
@@ -98,7 +84,6 @@
98
84
  ```
99
85
 
100
86
  【vivo】
101
- 1. 编辑 `uni_modules/TencentCloud-Push/utssdk/app-android/config.json` 的 `dependencies`,添加 `"com.tencent.timpush:vivo:xxxx"`。如图所示:
102
87
 
103
88
  ``` bash
104
89
  {
@@ -155,14 +140,11 @@
155
140
  |`userID`|与 Chat 登录打通的业务用户标识。希望后台直接向 Chat 登录 `userID` 推送(即接收 Chat 离线消息)时使用。|在 `registerPush` 前调用 `setRegistrationID(userID)` 绑定,绑定后 `registrationID` 即等于该 `userID`。|
156
141
 
157
142
  > **注意:**
158
- >
159
143
  > - 仅使用 TIMPush(独立推送):直接调用 `registerPush`,后台使用 `getRegistrationID` 返回的 `registrationID` 推送即可。
160
144
  > - 与 Chat 打通:在 `registerPush` 前调用 `setRegistrationID(userID)`,且 `userID` 必须与 Chat 登录使用的 `userID` 完全一致,否则会产生账号互踢导致推送丢失。
161
145
 
162
146
  ### 引入并注册推送服务
163
147
 
164
- 将 `SDKAppID` 和 `appKey` 替换为您在 [IM 控制台 > 推送服务 Push > 概览](https://console.cloud.tencent.com/im/push-plugin-push-identifier) 获取的应用信息。如图所示:
165
-
166
148
  ``` javascript
167
149
  // 集成 TencentCloud-Push
168
150
  import { setRegistrationID, registerPush, getRegistrationID, EVENT, addPushListener } from '@/uni_modules/TencentCloud-Push';
@@ -223,14 +205,12 @@ setRegistrationID(userID, () => {
223
205
  ```
224
206
 
225
207
  > **注意:**
226
- >
227
208
  > 混用场景下,自定义 `registrationID` 必须与 IM 登录使用的 `userID` 完全一致,否则会产生账号互踢导致推送丢失。
228
209
  >
229
210
 
230
211
  ## 生成自定义调试基座(Android、iOS)
231
212
 
232
213
  > **说明:**
233
- >
234
214
  > Harmony 不需要自定义基座。
235
215
  >
236
216
 
@@ -249,7 +229,7 @@ setRegistrationID(userID, () => {
249
229
 
250
230
  在测试推送前,请务必打开通知和状态栏。进入 [推送服务 Push > 接入测试](https://console.cloud.tencent.com/im/push-plugin-push-check) 发送您的第一条推送。
251
231
 
252
- **验证**:App 置于后台后发送测试消息,设备能收到离线推送通知。如果收不到,请参见下文「收不到推送排障流程」逐步排查。
232
+ **验证**:App 置于后台后发送测试消息,设备能收到离线推送通知。如果收不到。
253
233
 
254
234
  ## 处理通知点击跳转
255
235
 
@@ -325,7 +305,7 @@ addPushListener(EVENT.NOTIFICATION_CLICKED, (res) => {
325
305
 
326
306
  ## 推送结果回调
327
307
 
328
- 开启推送服务后,推送结果可以通过配置基础回调的方式,将结果转发给 App 后台,详见:
308
+ 开启推送服务后,推送结果可以通过配置基础回调的方式,将结果转发给 App 后台,
329
309
  - [普通推送结果回调](https://cloud.tencent.com/document/product/269/102567)
330
310
 
331
311
  - [全员推送结果回调](https://cloud.tencent.com/document/product/269/102568)
@@ -346,7 +326,6 @@ addPushListener(EVENT.NOTIFICATION_CLICKED, (res) => {
346
326
  厂商离线通道通常有消息分类机制。消息分类会影响推送及时性、单设备每日接收数量、夜间展示、声音、横幅以及厂商通道权限。
347
327
 
348
328
  > **注意:**
349
- >
350
329
  > 只有 IM 聊天、订单、交易、账号变更等用户预期强、需要及时触达的消息,才建议申请或使用高优先级分类。营销、广告、活动、资讯类消息不应滥用高优分类,否则可能被厂商降级、限频或冻结权限。
351
330
  >
352
331
 
@@ -365,7 +344,6 @@ addPushListener(EVENT.NOTIFICATION_CLICKED, (res) => {
365
344
  ## 厂商推送限制
366
345
 
367
346
  > **注意:**
368
- >
369
347
  > 只有 IM 聊天、订单、交易、账号变更等用户预期强、需要及时触达的消息,才建议申请或使用高优先级分类。营销、广告、活动、资讯类消息不应滥用高优分类,否则可能被厂商降级、限频或冻结权限。
370
348
  >
371
349
 
@@ -1,8 +1,12 @@
1
+ ## 前提条件
2
+
3
+ 开始接入前,请先完成对应原生平台的推送前提配置:请参见 [iOS 前提条件](https://cloud.tencent.com/document/product/269/100627#.E5.89.8D.E6.8F.90.E6.9D.A1.E4.BB.B6) 和 [Android 前提条件](https://cloud.tencent.com/document/product/269/100626#.E5.89.8D.E6.8F.90.E6.9D.A1.E4.BB.B6)。
4
+
1
5
  ## 操作步骤
2
6
 
3
7
  ### 步骤1:集成消息推送插件
4
8
 
5
- 完成 [厂商配置](https://cloud.tencent.com/document/product/269/123768) 后集成推送插件,需调整 `Packages/manifest.json` 文件,添加相关依赖:
9
+ 完成各原生平台厂商配置后集成推送插件,需调整 `Packages/manifest.json` 文件,添加相关依赖:
6
10
  ``` json
7
11
  {
8
12
  "dependencies": {
@@ -16,10 +20,6 @@
16
20
 
17
21
  【iOS】
18
22
 
19
- 请将您在 厂商配置 步骤中,获取到的 iOS APNs 推送证书, 上传至 [IM 控制台](https://console.cloud.tencent.com/im/push-plugin-push-identifier)。
20
-
21
- IM 控制台会为您分配一个证书 ID,见下图:
22
-
23
23
  您需要在 `Assets/Plugins/iOS` 目录下创建文件 `UnityIMPush.mm`(若目录不存在,需要手动创建),并且在文件中实现 `businessID` 协议方法返回证书 ID 即可,可以参考如下实现:
24
24
  ``` objectivec
25
25
  #import "TPush/TPush.h"
@@ -54,7 +54,7 @@ IM 控制台会为您分配一个证书 ID,见下图:
54
54
 
55
55
  【Android】
56
56
 
57
- 完成 [IM 控制台](https://console.cloud.tencent.com/im/push-plugin-push-identifier) 厂商推送信息填写后,下载并添加配置文件到工程。将下载的 `timpush-configs.json` 文件添加到项目的 `Assets/Plugins/Android` 目录下,如果该目录不存在,请手动创建。
57
+ 完成厂商配置后,下载并添加配置文件到工程。将下载的 `timpush-configs.json` 文件添加到项目的 `Assets/Plugins/Android` 目录下,如果该目录不存在,请手动创建。
58
58
 
59
59
  ### 步骤3: 客户端厂商配置
60
60
 
@@ -246,7 +246,6 @@ apply plugin: 'com.hihonor.mcs.asplugin'
246
246
  如果您需要自定义解析收到的远程推送,您可按照如下方法实现:
247
247
 
248
248
  > **注意:**
249
- >
250
249
  > 1. 注册回调时机必须放在程序入口函数中。
251
250
  > 2. 控制台中**点击后续动作**的配置请按如下方式处理,选择**打开应用内指定界面,**请勿修改使用默认值。
252
251
  >
@@ -268,7 +267,6 @@ PushManager.AddPushListener(listener);
268
267
  调用 `PushManager.RegisterPush` 方法成功后,就可以收到离线推送通知了。
269
268
 
270
269
  > **注意:**
271
- >
272
270
  > 如果您已经集成 IM 产品并在 IM 登录成功后调用该接口,请将 appKey 参数设置为 null,否则会将 IM 账号下线。
273
271
  >
274
272
 
@@ -282,73 +280,6 @@ PushManager.RegisterPush(sdkAppId: 您的sdkAppId, appKey: "客户端密钥", ne
282
280
 
283
281
  ### 步骤6: 消息推送触达统计
284
282
 
285
- 如果您需要统计触达数据,请按照如下完成配置:
286
-
287
- 【华为】
288
-
289
- 回执地址:`https://api.im.qcloud.com/v3/offline_push_report/huawei`
290
-
291
- > **注意:**
292
- >
293
- > 华为推送证书 ID <= 11344时,使用华为推送 v2 版本接口,不支持触达和点击回执,请重新生成更新证书 ID。
294
- >
295
-
296
- 【荣耀】
297
-
298
- 回执地址:`https://api.im.qcloud.com/v3/offline_push_report/honor`
299
-
300
- 【vivo】
301
-
302
- |回调地址配置|回执 ID 配置到 IM 控制台|
303
- |---------|---------|
304
- |<br>回执地址:`https://api.im.qcloud.com/v3/offline_push_report/vivo`||
305
-
306
- 【魅族】
307
-
308
- |打开回执开关|配置回执地址|
309
- |---------|---------|
310
- |||
311
-
312
- 回执地址:`https://api.im.qcloud.com/v3/offline_push_report/meizu`
313
-
314
- > **注意:**
315
- >
316
- > 打开回执开关后,请务必确保回执地址正确配置。不配置或者配置地址错误,都会影响推送功能。
317
- >
318
-
319
- 【iOS】
320
-
321
- iOS 端推送触达统计配置,请参见:
322
- - 如果您需要统计推送的抵达和点击数据,您需要在 AppDelegate.m 文件中实现 `- applicationGroupID` 方法,这里可参考推送参数配置部分,返回 App Group ID (生成方式可参见 厂商配置-生成 App GroupID)。
323
-
324
- - 在 [Notification Service Extension](https://github.com/TencentCloud/TIMSDK/blob/master/iOS/Demo/pushservice/NotificationService.m) 的 `-didReceiveNotificationRequest:withContentHandler:` 方法中调用推送抵达率统计函数:
325
-
326
- ``` java
327
- @implementation NotificationService
328
-
329
- - (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
330
- //appGroup 标识当前主 APP 和 Extension 之间共享的 APP Group,需要在主 APP 的 Capability 中配置 App Groups 能力。
331
- //格式为group + [主bundleID]+ key
332
- //如group.com.tencent.im.pushkey
333
- NSString * appGroupID = kTIMPushAppGroupKey;
334
- __weak typeof(self) weakSelf = self;
335
- [TIMPushManager handleNotificationServiceRequest:request appGroupID:appGroupID callback:^(UNNotificationContent *content) {
336
- weakSelf.bestAttemptContent = [content mutableCopy];
337
- // Modify the notification content here...
338
- // self.bestAttemptContent.title = [NSString stringWithFormat:@"%@ [modified]", self.bestAttemptContent.title];
339
- weakSelf.contentHandler(weakSelf.bestAttemptContent);
340
- }];
341
- }
342
-
343
- @end
344
- ```
345
-
346
- > **注意:**
347
- >
348
- > 1. 上报推送触达数据,需要开启 mutable-content 开关来支持 iOS 10 的 Extension 功能。
349
- >
350
- > 2. 数据详情可在推送数据页面查看,推送数据页面仅限 [购买推送插件](https://console.cloud.tencent.com/im/plugin/TIMPush) 后使用。
351
-
352
- 其余支持厂商不需要配置,FCM 暂不支持推送统计功能。
283
+ 如果你需要统计设备触达数据,请按照 华为/荣耀/vivo/魅族/iOS 完成配置。其余支持厂商不需要配置,FCM 暂不支持推送统计功能。
353
284
 
354
- 恭喜您已经完成了推送插件的接入,需要提醒您:推送插件**试用或购买到期后,将自动停止提供推送服务(包括普通消息离线推送、全员/标签推送等服务)**。为避免影响您业务正常使用,请提前[购买](https://buy.cloud.tencent.com/avc)/[续费](https://console.cloud.tencent.com/account/renewal)。
285
+ 接入完成收不到推送,请使用 [排查工具](https://cloud.tencent.com/document/product/269/100629) 查看具体原因。