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

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 (556) hide show
  1. package/index.js +0 -1
  2. package/knowledge/bm25-cache.js +73 -0
  3. package/knowledge/bm25.js +147 -0
  4. package/knowledge/build-index.js +65 -0
  5. package/knowledge/chunker.js +167 -0
  6. package/knowledge/content-loader.js +44 -0
  7. package/knowledge/extractors.js +25 -0
  8. package/knowledge/path-meta.js +175 -0
  9. package/knowledge/search/exact-lookup.js +330 -0
  10. package/knowledge/search/filter-pool.js +86 -0
  11. package/knowledge/search/requires-framework.js +72 -0
  12. package/knowledge/search/search-knowledge.js +226 -0
  13. package/package.json +9 -9
  14. package/resource/_schema/feature-aliases.yaml +10 -0
  15. package/resource/_schema/goal-tags.yaml +72 -0
  16. package/resource/_schema/products.yaml +16 -0
  17. package/resource/_schema/trtc-intents.yaml +27 -0
  18. package/resource/_schema/types.yaml +44 -0
  19. package/resource/index/component-slugs.json +1 -0
  20. package/resource/index/manifest.json +1 -0
  21. package/resource/{doc → integration}/callkit/preset/android/integration.md +32 -28
  22. package/resource/{doc → integration}/callkit/preset/flutter/integration.md +109 -54
  23. package/resource/integration/callkit/preset/ios/integration.md +411 -0
  24. package/resource/integration/callkit/preset/react/integration.md +499 -0
  25. package/resource/integration/callkit/preset/vue/integration.md +768 -0
  26. package/resource/{doc/chatkit → integration/chat/preset}/android/integration.md +11 -11
  27. package/resource/{doc/chatkit → integration/chat/preset}/flutter/integration.md +59 -37
  28. package/resource/integration/chat/preset/ios/integration.md +568 -0
  29. package/resource/{doc/chatkit → integration/chat/preset}/react/integration.md +127 -95
  30. package/resource/integration/chat/preset/uni-app/integration.md +494 -0
  31. package/resource/{doc/chatkit → integration/chat/preset}/vue/integration.md +163 -143
  32. package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +15 -15
  33. package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +25 -13
  34. package/resource/{doc → integration}/livekit/preset/live/vue/live-player-h5-integration.md +15 -9
  35. package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +31 -26
  36. package/resource/integration/roomkit/preset/vue/integration.md +571 -0
  37. package/resource/knowledge/callkit/core-sdk/android/answer-call.md +852 -0
  38. package/resource/knowledge/callkit/core-sdk/android/make-call.md +929 -0
  39. package/resource/knowledge/callkit/core-sdk/android/offline-push.md +364 -0
  40. package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1150 -0
  41. package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1216 -0
  42. package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +412 -0
  43. package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1191 -0
  44. package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1292 -0
  45. package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +537 -0
  46. package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +953 -0
  47. package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +1061 -0
  48. package/resource/knowledge/callkit/faq/android.md +168 -0
  49. package/resource/knowledge/callkit/faq/common.md +180 -0
  50. package/resource/knowledge/callkit/faq/flutter.md +52 -0
  51. package/resource/knowledge/callkit/faq/ios.md +116 -0
  52. package/resource/knowledge/callkit/faq/uniapp-app.md +89 -0
  53. package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +217 -0
  54. package/resource/knowledge/callkit/faq/web.md +363 -0
  55. package/resource/knowledge/callkit/preset/android/api.md +413 -0
  56. package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
  57. package/resource/knowledge/callkit/preset/ios/api.md +256 -0
  58. package/resource/knowledge/callkit/preset/web/api.md +79 -0
  59. package/resource/knowledge/chat/preset/android/features/chat-setting.md +72 -0
  60. package/resource/knowledge/chat/preset/android/features/contact-list.md +41 -0
  61. package/resource/knowledge/chat/preset/android/features/conversation-list.md +123 -0
  62. package/resource/knowledge/chat/preset/android/features/language.md +142 -0
  63. package/resource/knowledge/chat/preset/android/features/message-input.md +57 -0
  64. package/resource/knowledge/chat/preset/android/features/message-list.md +142 -0
  65. package/resource/knowledge/chat/preset/android/features/search.md +64 -0
  66. package/resource/{doc/chatkit → knowledge/chat/preset}/android/features/theme.md +21 -18
  67. package/resource/knowledge/chat/preset/android-view/integration.md +448 -0
  68. package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +62 -0
  69. package/resource/knowledge/chat/preset/flutter/features/contact-list.md +40 -0
  70. package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +129 -0
  71. package/resource/knowledge/chat/preset/flutter/features/language.md +104 -0
  72. package/resource/knowledge/chat/preset/flutter/features/message-input.md +54 -0
  73. package/resource/knowledge/chat/preset/flutter/features/message-list.md +163 -0
  74. package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
  75. package/resource/{doc/chatkit → knowledge/chat/preset}/flutter/features/theme.md +47 -19
  76. package/resource/knowledge/chat/preset/ios/features/chat-setting.md +92 -0
  77. package/resource/knowledge/chat/preset/ios/features/contact-list.md +119 -0
  78. package/resource/knowledge/chat/preset/ios/features/conversation-list.md +134 -0
  79. package/resource/knowledge/chat/preset/ios/features/language.md +105 -0
  80. package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
  81. package/resource/knowledge/chat/preset/ios/features/message-list.md +164 -0
  82. package/resource/knowledge/chat/preset/ios/features/search.md +94 -0
  83. package/resource/{doc/chatkit → knowledge/chat/preset}/ios/features/theme.md +54 -51
  84. package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +157 -94
  85. package/resource/knowledge/chat/preset/react/features/chat-setting.md +123 -0
  86. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +256 -104
  87. package/resource/knowledge/chat/preset/react/features/conversation-actions.md +217 -0
  88. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/conversation-list.md +86 -79
  89. package/resource/knowledge/chat/preset/react/features/conversation-preview.md +99 -0
  90. package/resource/knowledge/chat/preset/react/features/conversation-search.md +58 -0
  91. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +30 -83
  92. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-list.md +22 -25
  93. package/resource/knowledge/chat/preset/react/features/search.md +531 -0
  94. package/resource/knowledge/chat/preset/react/features/theme.md +16 -0
  95. package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
  96. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/chat-setting.md +0 -4
  97. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/contact-list.md +59 -53
  98. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-actions.md +49 -43
  99. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-list.md +61 -49
  100. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-preview.md +43 -40
  101. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +1 -1
  102. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-input.md +128 -105
  103. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-list.md +108 -195
  104. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +74 -68
  105. package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
  106. package/resource/knowledge/chat/urls/error-code.md +16 -0
  107. package/resource/knowledge/chat/urls/product.md +61 -0
  108. package/resource/knowledge/chat/urls/restapi.md +226 -0
  109. package/resource/knowledge/chat/urls/sdk/android.md +84 -0
  110. package/resource/knowledge/chat/urls/sdk/flutter.md +73 -0
  111. package/resource/knowledge/chat/urls/sdk/ios.md +84 -0
  112. package/resource/knowledge/chat/urls/sdk/web.md +88 -0
  113. package/resource/knowledge/chat/urls/webhook.md +73 -0
  114. package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/AudioEffectStore.md +79 -76
  115. package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +174 -0
  116. package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +329 -0
  117. package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/CameraView.md +7 -6
  118. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +434 -0
  119. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +362 -0
  120. package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +466 -0
  121. package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +173 -0
  122. package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/LikeStore.md +12 -10
  123. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +291 -0
  124. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +78 -0
  125. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +439 -0
  126. package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +221 -0
  127. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/AudioEffectStore.md +79 -76
  128. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
  129. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/BaseBeautyStore.md +43 -45
  130. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +312 -0
  131. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +404 -0
  132. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +334 -0
  133. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +420 -0
  134. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
  135. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LikeStore.md +12 -11
  136. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
  137. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LiveCoreView.md +49 -42
  138. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +397 -0
  139. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +183 -0
  140. package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/AudioEffectStore.md +79 -75
  141. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +192 -0
  142. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +146 -0
  143. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +309 -0
  144. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +370 -0
  145. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +339 -0
  146. package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +503 -0
  147. package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +188 -0
  148. package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/LikeStore.md +12 -10
  149. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +289 -0
  150. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +78 -0
  151. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +434 -0
  152. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +187 -0
  153. package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +780 -0
  154. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +59 -51
  155. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +37 -34
  156. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +68 -38
  157. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +18 -15
  158. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +17 -17
  159. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +86 -80
  160. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +53 -49
  161. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +47 -45
  162. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +26 -22
  163. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +16 -13
  164. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +28 -24
  165. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +33 -21
  166. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +29 -25
  167. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +21 -20
  168. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +78 -69
  169. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-host-interaction.md +47 -43
  170. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +48 -45
  171. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +27 -23
  172. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +15 -12
  173. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +39 -36
  174. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +42 -29
  175. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +19 -16
  176. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +20 -19
  177. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +55 -49
  178. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +50 -46
  179. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +48 -46
  180. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +26 -22
  181. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +59 -51
  182. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +41 -38
  183. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +67 -37
  184. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +53 -46
  185. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +86 -80
  186. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +45 -40
  187. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +43 -42
  188. package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +523 -0
  189. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audience-list.md +16 -13
  190. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audio-effect.md +54 -50
  191. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-barrage.md +33 -21
  192. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +34 -28
  193. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-gift.md +73 -64
  194. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +46 -43
  195. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-room-list.md +165 -148
  196. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +19 -16
  197. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +40 -37
  198. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +41 -28
  199. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +54 -47
  200. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +52 -46
  201. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +55 -50
  202. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +47 -45
  203. package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +404 -0
  204. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audience-list.md +40 -57
  205. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audio-effect.md +38 -49
  206. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-barrage.md +53 -53
  207. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-co-guest-interaction.md +106 -116
  208. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-gift.md +49 -59
  209. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-integration.md +52 -45
  210. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-room-list.md +38 -46
  211. package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +915 -0
  212. package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +179 -0
  213. package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +419 -0
  214. package/resource/knowledge/push/config/android/fcm.md +133 -0
  215. package/resource/knowledge/push/config/android/honor.md +111 -0
  216. package/resource/knowledge/push/config/android/huawei.md +106 -0
  217. package/resource/knowledge/push/config/android/meizu.md +121 -0
  218. package/resource/knowledge/push/config/android/oppo.md +108 -0
  219. package/resource/knowledge/push/config/android/vivo.md +101 -0
  220. package/resource/knowledge/push/config/android/xiaomi.md +99 -0
  221. package/resource/knowledge/push/integration/android.md +1028 -0
  222. package/resource/knowledge/push/integration/donut.md +271 -0
  223. package/resource/knowledge/push/integration/flutter.md +363 -0
  224. package/resource/knowledge/push/integration/harmonyos.md +72 -0
  225. package/resource/knowledge/push/integration/ios.md +705 -0
  226. package/resource/knowledge/push/integration/react-native.md +337 -0
  227. package/resource/knowledge/push/integration/uni-app.md +461 -0
  228. package/resource/knowledge/push/integration/unity.md +357 -0
  229. package/resource/knowledge/push/integration/unreal-engine.md +353 -0
  230. package/resource/knowledge/push/overview/prepare.md +30 -0
  231. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/call-user-to-room.md +22 -20
  232. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-participant-state.md +22 -193
  233. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-state.md +33 -32
  234. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/schedule-room.md +30 -29
  235. package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
  236. package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-participant-state.md +22 -21
  237. package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-state.md +29 -28
  238. package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/schedule-room.md +17 -16
  239. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/call-user-to-room.md +22 -20
  240. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-participant-state.md +49 -218
  241. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-state.md +37 -37
  242. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/schedule-room.md +28 -28
  243. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/call-user-to-room.md +122 -7
  244. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +318 -3
  245. package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +1504 -0
  246. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/free-beauty-panel.md +4 -3
  247. package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +709 -0
  248. package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1105 -0
  249. package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +635 -0
  250. package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +529 -0
  251. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/schedule-room.md +256 -13
  252. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/screen-share.md +218 -25
  253. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/virtual-background.md +4 -3
  254. package/resource/{doc/roomkit → knowledge/roomkit/preset}/android/integration.md +50 -64
  255. package/resource/{doc/roomkit → knowledge/roomkit/preset}/flutter/integration.md +34 -31
  256. package/resource/{doc/roomkit → knowledge/roomkit/preset}/ios/integration.md +45 -53
  257. package/resource/knowledge/roomkit/preset/react/integration.md +571 -0
  258. package/resource/{doc → knowledge}/rtcengine/web/how_to_run_web_sdk_demo.md +31 -15
  259. package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +9 -3
  260. package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +1 -1
  261. package/resource/{doc → knowledge}/rtcengine/web/plugin/23-advanced-support-detection.md +1 -1
  262. package/resource/{doc → knowledge}/rtcengine/web/plugin/24-advanced-network-quality.md +6 -6
  263. package/resource/{doc → knowledge}/rtcengine/web/plugin/25-advanced-device-change.md +1 -1
  264. package/resource/{doc → knowledge}/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -4
  265. package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +4 -4
  266. package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
  267. package/resource/{doc → knowledge}/trtc/android/TRTCCloud.md +547 -495
  268. package/resource/{doc → knowledge}/trtc/android/TRTCCloudDef.md +434 -403
  269. package/resource/{doc → knowledge}/trtc/android/TRTCCloudListener.md +394 -348
  270. package/resource/{doc → knowledge}/trtc/android/TRTCStatistics.md +17 -15
  271. package/resource/{doc → knowledge}/trtc/android/TXAudioEffectManager.md +227 -197
  272. package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
  273. package/resource/{doc → knowledge}/trtc/android/TXDeviceManager.md +70 -63
  274. package/resource/{doc → knowledge}/trtc/android/TXLiteAVCode.md +19 -17
  275. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCCloud.md +599 -544
  276. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCStatistics.md +17 -15
  277. package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
  278. package/resource/knowledge/trtc/c++/ITXDeviceManager.md +403 -0
  279. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCCloudCallback.md +439 -387
  280. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCTypeDef.md +417 -387
  281. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TXLiteAVCode.md +19 -17
  282. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloud.md +619 -559
  283. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloudDelegate.md +409 -360
  284. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCStatistics.md +17 -15
  285. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXAudioEffectManager.md +187 -164
  286. package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
  287. package/resource/knowledge/trtc/ios/TXDeviceManager.md +399 -0
  288. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiteAVCode.md +19 -17
  289. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiveSDKTypeDef.md +422 -396
  290. package/server-config.js +0 -1
  291. package/server.js +22 -12
  292. package/streamable-http.js +0 -1
  293. package/tools/call/get_native_call_uikit_integration.js +2 -4
  294. package/tools/call/get_native_callkit_core_integration.js +2 -6
  295. package/tools/call/get_web_call_uikit_integration.js +2 -4
  296. package/tools/chat/get_native_chat_uikit_integration.js +2 -4
  297. package/tools/chat/get_web_chat_uikit_integration.js +2 -4
  298. package/tools/common/get_usersig.js +0 -1
  299. package/tools/common/present_framework_choice.js +9 -4
  300. package/tools/common/record_answer.js +19 -26
  301. package/tools/common/record_feedback.js +17 -31
  302. package/tools/common/search_trtc_knowledge.js +44 -0
  303. package/tools/definitions/get_native_call_uikit_integration_def.js +2 -1
  304. package/tools/definitions/get_native_callkit_core_integration_def.js +2 -1
  305. package/tools/definitions/get_native_chat_uikit_integration_def.js +3 -2
  306. package/tools/definitions/get_native_livekit_core_integration_def.js +2 -1
  307. package/tools/definitions/get_usersig_def.js +0 -1
  308. package/tools/definitions/get_web_call_uikit_integration_def.js +2 -1
  309. package/tools/definitions/get_web_chat_uikit_integration_def.js +2 -1
  310. package/tools/definitions/get_web_live_uikit_integration_def.js +4 -3
  311. package/tools/definitions/get_web_room_core_integration_def.js +46 -0
  312. package/tools/definitions/get_web_room_uikit_integration_def.js +3 -1
  313. package/tools/definitions/integration-boundary.js +5 -0
  314. package/tools/definitions/present_framework_choice_def.js +11 -10
  315. package/tools/definitions/record_answer_def.js +6 -5
  316. package/tools/definitions/record_feedback_def.js +4 -3
  317. package/tools/definitions/search_trtc_knowledge_def.js +69 -0
  318. package/tools/index.js +5 -37
  319. package/tools/live/get_native_livekit_core_integration.js +1 -4
  320. package/tools/live/get_web_live_uikit_integration.js +2 -5
  321. package/tools/room/get_web_room_core_integration.js +47 -0
  322. package/tools/room/get_web_room_uikit_integration.js +2 -4
  323. package/utils/generate-structured-result.js +4 -11
  324. package/utils/generate-usersig.js +0 -1
  325. package/utils/get-device-identifier.js +0 -1
  326. package/utils/get-doc-content.js +14 -9
  327. package/utils/http-get.js +0 -1
  328. package/utils/http-post.js +0 -1
  329. package/utils/report-cls-client.js +22 -21
  330. package/utils/report-es-client.js +1 -2
  331. package/utils/report-runtime-error-cls-client.js +0 -1
  332. package/index.js.map +0 -1
  333. package/resource/doc/callkit/core-sdk/.gitkeep +0 -0
  334. package/resource/doc/callkit/core-sdk/android/answer-call.md +0 -942
  335. package/resource/doc/callkit/core-sdk/android/make-call.md +0 -876
  336. package/resource/doc/callkit/core-sdk/android/offline-push.md +0 -368
  337. package/resource/doc/callkit/core-sdk/flutter/answer-call.md +0 -1132
  338. package/resource/doc/callkit/core-sdk/flutter/make-call.md +0 -1206
  339. package/resource/doc/callkit/core-sdk/flutter/offline-push.md +0 -357
  340. package/resource/doc/callkit/core-sdk/ios/answer-call.md +0 -1009
  341. package/resource/doc/callkit/core-sdk/ios/make-call.md +0 -1154
  342. package/resource/doc/callkit/core-sdk/ios/offline-push.md +0 -470
  343. package/resource/doc/callkit/core-sdk/uni-app/answer-call.md +0 -1146
  344. package/resource/doc/callkit/core-sdk/uni-app/make-call.md +0 -1267
  345. package/resource/doc/callkit/faq/android-faq.md +0 -767
  346. package/resource/doc/callkit/faq/flutter-faq.md +0 -749
  347. package/resource/doc/callkit/faq/ios-faq.md +0 -759
  348. package/resource/doc/callkit/faq/web-faq.md +0 -753
  349. package/resource/doc/callkit/preset/android/api.md +0 -330
  350. package/resource/doc/callkit/preset/flutter/api.md +0 -401
  351. package/resource/doc/callkit/preset/ios/api.md +0 -282
  352. package/resource/doc/callkit/preset/ios/integration.md +0 -188
  353. package/resource/doc/callkit/preset/react/api.md +0 -600
  354. package/resource/doc/callkit/preset/react/integration.md +0 -86
  355. package/resource/doc/callkit/preset/vue/api.md +0 -600
  356. package/resource/doc/callkit/preset/vue/integration.md +0 -83
  357. package/resource/doc/chatkit/android/faq.md +0 -109
  358. package/resource/doc/chatkit/faq/android_sdk/client-api.md +0 -280
  359. package/resource/doc/chatkit/faq/common/product.md +0 -82
  360. package/resource/doc/chatkit/faq/common/server.md +0 -53
  361. package/resource/doc/chatkit/faq/common/server_error_code.md +0 -74
  362. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +0 -183
  363. package/resource/doc/chatkit/faq/flutter_sdk/faq.md +0 -54
  364. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +0 -279
  365. package/resource/doc/chatkit/faq/web_sdk/error_code.md +0 -47
  366. package/resource/doc/chatkit/faq/web_sdk/faq.md +0 -292
  367. package/resource/doc/chatkit/flutter/faq.md +0 -22
  368. package/resource/doc/chatkit/ios/faq.md +0 -109
  369. package/resource/doc/chatkit/react/components/avatar.md +0 -104
  370. package/resource/doc/chatkit/react/components/chat-header.md +0 -148
  371. package/resource/doc/chatkit/react/components/chat-setting.md +0 -117
  372. package/resource/doc/chatkit/react/components/chat.md +0 -38
  373. package/resource/doc/chatkit/react/components/component-list.md +0 -35
  374. package/resource/doc/chatkit/react/components/conversation-actions.md +0 -174
  375. package/resource/doc/chatkit/react/components/conversation-preview.md +0 -116
  376. package/resource/doc/chatkit/react/components/conversation-search.md +0 -57
  377. package/resource/doc/chatkit/react/components/search.md +0 -282
  378. package/resource/doc/chatkit/react/components/tuikit.md +0 -43
  379. package/resource/doc/chatkit/react/faq.md +0 -26
  380. package/resource/doc/chatkit/vue/components/avatar.md +0 -104
  381. package/resource/doc/chatkit/vue/components/chat-header.md +0 -149
  382. package/resource/doc/chatkit/vue/components/chat.md +0 -42
  383. package/resource/doc/chatkit/vue/components/component-list.md +0 -89
  384. package/resource/doc/chatkit/vue/components/tuikit.md +0 -45
  385. package/resource/doc/chatkit/vue/components/userpicker.md +0 -256
  386. package/resource/doc/chatkit/vue/faq.md +0 -35
  387. package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +0 -148
  388. package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +0 -316
  389. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +0 -419
  390. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +0 -325
  391. package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +0 -436
  392. package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +0 -165
  393. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +0 -239
  394. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +0 -74
  395. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +0 -417
  396. package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +0 -207
  397. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +0 -158
  398. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +0 -304
  399. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +0 -394
  400. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +0 -303
  401. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +0 -410
  402. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +0 -160
  403. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +0 -231
  404. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +0 -375
  405. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +0 -170
  406. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +0 -165
  407. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +0 -143
  408. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +0 -298
  409. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +0 -349
  410. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +0 -297
  411. package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +0 -471
  412. package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +0 -179
  413. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +0 -238
  414. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +0 -74
  415. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +0 -412
  416. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +0 -173
  417. package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +0 -365
  418. package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +0 -336
  419. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +0 -780
  420. package/resource/doc/livekit/preset/live/vue/components/barrage.md +0 -291
  421. package/resource/doc/livekit/preset/live/vue/components/co-guest-panel.md +0 -88
  422. package/resource/doc/livekit/preset/live/vue/components/live-audience-list.md +0 -164
  423. package/resource/doc/livekit/preset/live/vue/components/live-scene-panel.md +0 -130
  424. package/resource/doc/livekit/preset/live/vue/components/live-view.md +0 -203
  425. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +0 -211
  426. package/resource/doc/livekit/preset/live/vue/faq.md +0 -1
  427. package/resource/doc/roomkit/faq/common/error-code.md +0 -67
  428. package/resource/doc/roomkit/flutter/features/call-user-to-room.md +0 -228
  429. package/resource/doc/roomkit/vue/faq.md +0 -1
  430. package/resource/doc/roomkit/vue/features/device-state.md +0 -460
  431. package/resource/doc/roomkit/vue/features/room-chat.md +0 -369
  432. package/resource/doc/roomkit/vue/features/room-participant-state.md +0 -385
  433. package/resource/doc/roomkit/vue/features/room-state.md +0 -280
  434. package/resource/doc/roomkit/vue/features/room-view.md +0 -241
  435. package/resource/doc/roomkit/vue/integration.md +0 -315
  436. package/resource/doc/rtcengine/faq/web_sdk/.gitkeep +0 -0
  437. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +0 -472
  438. package/resource/doc/trtc/C++/ITXDeviceManager.md +0 -388
  439. package/resource/doc/trtc/android/TXBeautyManager.md +0 -403
  440. package/resource/doc/trtc/iOS/TXBeautyManager.md +0 -404
  441. package/resource/doc/trtc/iOS/TXDeviceManager.md +0 -382
  442. package/server-config.js.map +0 -1
  443. package/server.js.map +0 -1
  444. package/streamable-http.js.map +0 -1
  445. package/tools/call/get_callkit_api.js +0 -33
  446. package/tools/call/get_callkit_api.js.map +0 -1
  447. package/tools/call/get_native_call_uikit_integration.js.map +0 -1
  448. package/tools/call/get_native_callkit_core_integration.js.map +0 -1
  449. package/tools/call/get_web_call_uikit_integration.js.map +0 -1
  450. package/tools/chat/get_native_chat_uikit_feature_detail.js +0 -35
  451. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +0 -1
  452. package/tools/chat/get_native_chat_uikit_integration.js.map +0 -1
  453. package/tools/chat/get_web_chat_uikit_component_detail.js +0 -35
  454. package/tools/chat/get_web_chat_uikit_component_detail.js.map +0 -1
  455. package/tools/chat/get_web_chat_uikit_integration.js.map +0 -1
  456. package/tools/common/get_faq.js +0 -266
  457. package/tools/common/get_faq.js.map +0 -1
  458. package/tools/common/get_usersig.js.map +0 -1
  459. package/tools/common/present_framework_choice.js.map +0 -1
  460. package/tools/common/record_answer.js.map +0 -1
  461. package/tools/common/record_feedback.js.map +0 -1
  462. package/tools/common/record_skill_session.js +0 -69
  463. package/tools/common/record_skill_session.js.map +0 -1
  464. package/tools/definitions/get_callkit_api_def.js +0 -28
  465. package/tools/definitions/get_callkit_api_def.js.map +0 -1
  466. package/tools/definitions/get_faq_def.js +0 -40
  467. package/tools/definitions/get_faq_def.js.map +0 -1
  468. package/tools/definitions/get_native_call_uikit_integration_def.js.map +0 -1
  469. package/tools/definitions/get_native_callkit_core_integration_def.js.map +0 -1
  470. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +0 -31
  471. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +0 -1
  472. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +0 -1
  473. package/tools/definitions/get_native_livekit_core_features_def.js +0 -33
  474. package/tools/definitions/get_native_livekit_core_features_def.js.map +0 -1
  475. package/tools/definitions/get_native_livekit_core_integration_def.js.map +0 -1
  476. package/tools/definitions/get_native_trtc_sdk_docs_def.js +0 -32
  477. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +0 -1
  478. package/tools/definitions/get_usersig_def.js.map +0 -1
  479. package/tools/definitions/get_web_call_uikit_integration_def.js.map +0 -1
  480. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +0 -31
  481. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +0 -1
  482. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +0 -1
  483. package/tools/definitions/get_web_live_uikit_integration_def.js.map +0 -1
  484. package/tools/definitions/get_web_livekit_api_def.js +0 -27
  485. package/tools/definitions/get_web_livekit_api_def.js.map +0 -1
  486. package/tools/definitions/get_web_livekit_component_detail_def.js +0 -29
  487. package/tools/definitions/get_web_livekit_component_detail_def.js.map +0 -1
  488. package/tools/definitions/get_web_room_uikit_integration_def.js.map +0 -1
  489. package/tools/definitions/get_web_roomkit_feature_detail_def.js +0 -30
  490. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +0 -1
  491. package/tools/definitions/get_web_trtc_sdk_api_def.js +0 -25
  492. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +0 -1
  493. package/tools/definitions/get_web_trtc_sdk_integration_def.js +0 -25
  494. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +0 -1
  495. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +0 -25
  496. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +0 -1
  497. package/tools/definitions/present_framework_choice_def.js.map +0 -1
  498. package/tools/definitions/record_answer_def.js.map +0 -1
  499. package/tools/definitions/record_feedback_def.js.map +0 -1
  500. package/tools/definitions/record_skill_session_def.js +0 -31
  501. package/tools/definitions/record_skill_session_def.js.map +0 -1
  502. package/tools/index.js.map +0 -1
  503. package/tools/live/get_native_livekit_core_features.js +0 -68
  504. package/tools/live/get_native_livekit_core_features.js.map +0 -1
  505. package/tools/live/get_native_livekit_core_integration.js.map +0 -1
  506. package/tools/live/get_web_live_uikit_integration.js.map +0 -1
  507. package/tools/live/get_web_livekit_api.js +0 -33
  508. package/tools/live/get_web_livekit_api.js.map +0 -1
  509. package/tools/live/get_web_livekit_component_detail.js +0 -35
  510. package/tools/live/get_web_livekit_component_detail.js.map +0 -1
  511. package/tools/room/get_web_room_uikit_integration.js.map +0 -1
  512. package/tools/room/get_web_roomkit_feature_detail.js +0 -69
  513. package/tools/room/get_web_roomkit_feature_detail.js.map +0 -1
  514. package/tools/rtcengine/get_web_trtc_sdk_api.js +0 -32
  515. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +0 -1
  516. package/tools/rtcengine/get_web_trtc_sdk_integration.js +0 -32
  517. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +0 -1
  518. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +0 -32
  519. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +0 -1
  520. package/tools/trtc/get_native_trtc_sdk_docs.js +0 -74
  521. package/tools/trtc/get_native_trtc_sdk_docs.js.map +0 -1
  522. package/utils/build-session-directives.js +0 -122
  523. package/utils/build-session-directives.js.map +0 -1
  524. package/utils/generate-structured-result.js.map +0 -1
  525. package/utils/generate-usersig.js.map +0 -1
  526. package/utils/get-device-identifier.js.map +0 -1
  527. package/utils/get-doc-content.js.map +0 -1
  528. package/utils/handle-framework.js +0 -9
  529. package/utils/handle-framework.js.map +0 -1
  530. package/utils/handle-state-name.js +0 -29
  531. package/utils/handle-state-name.js.map +0 -1
  532. package/utils/http-get.js.map +0 -1
  533. package/utils/http-post.js.map +0 -1
  534. package/utils/report-cls-client.js.map +0 -1
  535. package/utils/report-es-client.js.map +0 -1
  536. package/utils/report-runtime-error-cls-client.js.map +0 -1
  537. /package/resource/{doc/callkit/faq/common → knowledge/callkit/faq}/error-code.md +0 -0
  538. /package/resource/{doc/livekit/faq/common → knowledge/livekit/faq}/error-code.md +0 -0
  539. /package/resource/{doc → knowledge}/rtcengine/web/api.md +0 -0
  540. /package/resource/{doc/rtcengine/faq/web/web.md → knowledge/rtcengine/web/faq.md} +0 -0
  541. /package/resource/{doc → knowledge}/rtcengine/web/how_to_integrated_web_sdk.md +0 -0
  542. /package/resource/{doc → knowledge}/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +0 -0
  543. /package/resource/{doc → knowledge}/rtcengine/web/plugin/28-advanced-beauty.md +0 -0
  544. /package/resource/{doc → knowledge}/rtcengine/web/plugin/29-advanced-water-mark.md +0 -0
  545. /package/resource/{doc → knowledge}/rtcengine/web/plugin/30-advanced-cross-room-link.md +0 -0
  546. /package/resource/{doc → knowledge}/rtcengine/web/plugin/34-advanced-proxy.md +0 -0
  547. /package/resource/{doc → knowledge}/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -0
  548. /package/resource/{doc → knowledge}/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -0
  549. /package/resource/{doc → knowledge}/rtcengine/web/plugin/37-advanced-voice-changer.md +0 -0
  550. /package/resource/{doc → knowledge}/rtcengine/web/plugin/38-advanced-basic-beauty.md +0 -0
  551. /package/resource/{doc → knowledge}/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -0
  552. /package/resource/{doc → knowledge}/rtcengine/web/plugin/40-advanced-video-mixer.md +0 -0
  553. /package/resource/{doc → knowledge}/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +0 -0
  554. /package/resource/{doc → knowledge}/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +0 -0
  555. /package/resource/{doc → knowledge}/rtcengine/web/plugin/43-advanced-face-detection.md +0 -0
  556. /package/resource/{doc/rtcengine/faq/common → knowledge/share}/userSig.md +0 -0
@@ -0,0 +1,133 @@
1
+ 本文将介绍如何完成 Google FCM 离线推送服务厂商配置。
2
+
3
+ ## 前提条件
4
+
5
+ 开始前,请确认您已具备以下条件:
6
+
7
+ |**条件**|**说明**|
8
+ |---------|---------|
9
+ |Google 账号|用于登录 Firebase 控制台。|
10
+ |Android App 包名|Firebase Android 应用包名必须与 Android 工程的 `applicationId` 保持一致。包名区分大小写,且 Firebase 应用注册后无法更改。Google FCM 推送服务不要求应用先上架应用市场。|
11
+ |Android 运行环境|目标设备或模拟器需支持 Android 6.0(API 23)及以上,并安装 Google Play 服务。|
12
+ |可访问 Google 服务的网络环境|用于访问 Firebase 控制台、下载配置文件、生成服务账号私钥,并在运行时连接 Google Play 服务和 FCM。|
13
+ |腾讯云账号和即时通信 IM 应用权限|用于在腾讯云控制台添加 Google FCM 厂商证书。|
14
+ |后续 Android 工程接入权限|用于在 `SDK 接入` 阶段集成 TIMPush 和 FCM 推送依赖。|
15
+
16
+ ## Firebase 控制台配置
17
+
18
+ > **提示:**
19
+ >
20
+
21
+ > 本文配置流程可对照 Firebase 官方 [将 Firebase 添加到 Android 项目](https://firebase.google.cn/docs/android/setup) 操作。
22
+ >
23
+
24
+ ### 进入 Firebase 控制台
25
+
26
+ 进入 [Firebase 控制台](https://console.firebase.google.com),登录 Google 账号。
27
+
28
+ ### 创建项目并注册 Android 应用
29
+ 1. 单击**创建项目**,添加一个新的项目。
30
+
31
+ > **说明:**
32
+ >
33
+
34
+ > Firebase 会根据项目名称生成项目 ID。项目创建后,项目 ID 无法更改,请在创建前确认命名和用途。创建项目时,建议启用 Google Analytics,以便后续使用 FCM 消息传送报告能力。
35
+ >
36
+
37
+ 2. 进入 Android 应用注册入口。
38
+
39
+ 3. 输入应用信息,注册 Android 应用。
40
+
41
+ > **注意:**
42
+ >
43
+
44
+ > Android 软件包名称区分大小写,且 Firebase Android 应用注册后无法更改。请确保填写的包名与 Android 工程的 `applicationId` 完全一致。
45
+ >
46
+
47
+ 4. 下载 `google-services.json` 配置文件,完成注册。
48
+
49
+ > **注意:**
50
+ >
51
+
52
+ > 后续 SDK 接入时,需将 `google-services.json` 放置到 Android 工程的**模块(应用级)根目录**,例如 `app/google-services.json`,不要放到项目根目录。
53
+ >
54
+
55
+ ## 生成服务账号私钥
56
+ 1. 单击应用,进入应用管理。
57
+
58
+ 2. 在**项目设置**中单击**服务账号 > 生成新的密钥**,生成并下载服务账号私钥 JSON 文件。
59
+
60
+ > **注意:**
61
+ >
62
+
63
+ > 服务账号私钥用于服务端向 FCM 鉴权,请妥善保存。不要将私钥提交到代码仓库、客户端安装包或公开渠道。
64
+ >
65
+
66
+ ### 确认 FCM API V1 状态
67
+
68
+ 在 Firebase 控制台**项目设置 > Cloud Messaging **中,确认 **Firebase Cloud Messaging API (V1)**已启用。新接入场景请使用 HTTP v1 API 和服务账号私钥进行 FCM 鉴权。
69
+
70
+ > **注意:**
71
+ >
72
+
73
+ > FCM 旧版 Server Key(HTTP/XMPP)已被弃用。TIMPush 的 Google FCM 通道应使用 HTTP v1 API 和服务账号私钥,请勿混用旧版 Server Key 凭据。
74
+ >
75
+
76
+ ## 腾讯云控制台配置
77
+
78
+ ### 添加 Google FCM 厂商证书
79
+
80
+ 登录腾讯云 [即时通信 IM 控制台](https://console.qcloud.com/avc),在**推送服务 Push** > **推送设置** > **厂商配置**中添加 Google FCM 厂商证书,并按控制台要求上传或填写服务账号私钥相关配置。
81
+ | <strong>厂商推送平台</strong> | <strong>腾讯云即时通信 IM 控制台</strong> |
82
+ | --- | --- |
83
+ | | |
84
+
85
+ ### 选择 FCM 消息类型
86
+
87
+ FCM 支持通知消息和数据消息。腾讯云控制台默认选择通知消息,可根据业务场景切换消息类型。
88
+
89
+ |**消息类型**|**处理方式**|**适用建议**|
90
+ |---------|---------|---------|
91
+ |通知消息|应用在后台时,FCM SDK 可自动将通知显示到通知面板。|适用于只需要展示基础离线通知的场景,新接入建议优先使用。|
92
+ |数据消息|由客户端应用代码自行处理,FCM 不会自动展示通知。|适用于需要自定义处理业务数据、路由或展示逻辑的场景,接入后需在目标设备上充分测试。|
93
+ |通知消息 + 数据载荷|后台展示通知,同时携带业务参数。|适用于既要展示通知,又要在用户单击通知后传递业务参数的场景。|
94
+
95
+ 控制台可通过**消息类型**选项进行切换:
96
+
97
+ > **注意:**
98
+ >
99
+
100
+ > FCM 数据消息能力仅支持 TIMPush 7.8 及以上版本的 Pixel 手机,其他厂商设备需自测支持情况。
101
+ >
102
+
103
+ ## 配额和限频对推送效果的影响
104
+
105
+ Google FCM 没有国内厂商的私信、公信、服务通讯等消息分类体系,但会对项目、单设备和可折叠消息进行配额和限频管理。若发送频率过高,可能出现限流、延迟、失败或被判定为滥用。
106
+
107
+ |**限制维度**|**官方规则**|**配置建议**|
108
+ |---------|---------|---------|
109
+ |项目级下行配额|FCM HTTP v1 API 默认按项目、按分钟计量,下行消息默认配额为每项目每分钟 `60 万` 条。超限可能返回 `429 RESOURCE_EXHAUSTED / QUOTA_EXCEEDED`。|服务端发送链路需处理限流、退避和重试,避免短时间流量激增。|
110
+ |单设备发送速率|Android 单设备限制为 `240` 条/分钟、`5000` 条/小时。|同一用户的多条业务提醒建议在业务侧合并或降频。|
111
+ |可折叠消息|每台设备、每个应用可突发发送 `20` 条可折叠消息,之后每 `3` 分钟补充 `1` 条。|同步类、状态刷新类消息不要高频重复发送,避免被延迟。|
112
+ |消息类型|通知消息适合基础离线通知;数据消息支持更灵活的自定义处理,但需要客户端完整实现处理逻辑。|新接入优先使用通知消息;需要自定义处理时再评估数据消息。|
113
+
114
+ 如果业务需要设置 FCM 通知渠道,后续发送离线推送时可在 SDK API 中设置 Android 8.0 及以上系统的通知渠道 ID。具体 API 使用方式请参见 Android SDK 接入文档中的 配置消息分类(可选)"。具体配额以 [Firebase 消息限频](https://firebase.google.com/docs/cloud-messaging/throttling-and-quotas) 为准。
115
+
116
+ ## 配置完成检查
117
+
118
+ 完成本篇配置后,请按顺序检查:
119
+
120
+ |**检查项**|**预期结果**|
121
+ |---------|---------|
122
+ |包名一致性|Firebase Android 应用包名与 Android 工程 `applicationId` 完全一致,且大小写一致。|
123
+ |Android 运行环境|目标设备或模拟器满足 Android 6.0(API 23)及以上,并可使用 Google Play 服务。|
124
+ |Firebase 项目|项目 ID 已确认,项目创建后不再需要修改;如需消息传送报告,已启用 Google Analytics。|
125
+ |配置文件|已下载最新 `google-services.json`,并准备在 SDK 接入阶段放置到模块(应用级)根目录,例如 `app/google-services.json`。|
126
+ |服务账号私钥|已生成并妥善保存服务账号私钥 JSON 文件,未提交到代码仓库或公开渠道。|
127
+ |FCM API V1|已在 Firebase 控制台确认 Firebase Cloud Messaging API (V1) 启用。|
128
+ |腾讯云厂商证书|已在腾讯云控制台添加 Google FCM 证书,并填写或上传正确配置。|
129
+ |消息类型|已根据业务需要选择通知消息或数据消息;使用数据消息时已了解版本和设备限制。|
130
+ |配额和限频|已评估项目级下行配额、单设备发送速率和可折叠消息限制,并在服务端发送链路中处理限流和重试。|
131
+ |旧凭据迁移|未使用已弃用的旧版 Server Key,已使用 HTTP v1 API 和服务账号私钥。|
132
+
133
+ 下一步请前往 Android SDK 接入,集成 TIMPush。
@@ -0,0 +1,111 @@
1
+ 本文将介绍如何完成荣耀离线推送服务厂商配置。
2
+
3
+ ## 前提条件
4
+
5
+ 开始前,请确认您已具备以下条件:
6
+
7
+ |**条件**|**说明**|
8
+ |---------|---------|
9
+ |荣耀开发者账号|用于登录荣耀开发者服务平台并申请开通推送服务。|
10
+ |Android App 包名|荣耀应用包名必须与 Android 工程的 `applicationId` 保持一致,字符长度需为 `4-64`。荣耀推送服务不要求应用先上架应用市场。|
11
+ |打包证书 SHA256 指纹|需要在荣耀平台配置,且必须与实际打包签名证书一致。如有多套打包证书,需要全部填写。|
12
+ |腾讯云账号和即时通信 IM 应用权限|用于在腾讯云控制台添加荣耀厂商证书。|
13
+ |后续 Android 工程接入权限|用于在 `SDK 接入` 阶段集成 TIMPush 和荣耀推送依赖。|
14
+
15
+ ## 荣耀开发者服务平台配置
16
+
17
+ > **提示:**
18
+ >
19
+
20
+ > 本文配置流程可对照荣耀官方 [推送服务上架申请指南](https://developer.honor.com/cn/docs/11002/guides/app-registration) 操作。
21
+ >
22
+
23
+ ### 注册荣耀开发者账号
24
+
25
+ 注册荣耀开发者账号,详情参见 [开发者注册](https://developer.honor.com/cn/doc/guides/100272)。
26
+
27
+ ### 创建或选择应用
28
+ 1. 进入**应用管理**,单击**新建应用**创建应用。
29
+
30
+ 2. 进入**应用详情**,绑定应用包名,并下载 `mcs-services.json` 文件。
31
+
32
+ > **说明:**
33
+ >
34
+ > - 必须添加打包的 [SHA256 证书指纹](https://developer.honor.com/cn/docs/11002/guides/android-generate-appsign),SHA256 证书指纹需与实际打包证书一致。如有多套打包证书,需要全部填写。
35
+ > - `mcs-services.json` 用于后续 Android 工程接入阶段,请保存到 Android 项目中。
36
+ > - 修改项目、应用信息或开发服务设置后,需要重新下载并更新 `mcs-services.json`。
37
+
38
+ ### 开通推送服务
39
+ 1. 进入**管理中心 > 生态服务 > 应用服务 > 推送服务**,进入推送服务列表页面。
40
+
41
+ 2. 单击**申请推送服务**,进入应用申请页面。
42
+
43
+ 3. 选择应用类型为**移动应用**,填写或选择已创建的应用,填写应用包名和 SHA256 证书指纹,阅读并同意《荣耀推送服务使用协议》和《荣耀开发者服务数据处理附录》,然后单击**提交**。
44
+
45
+ > **警告:**
46
+ >
47
+
48
+ > 应用包名字符长度需为 `4-64`。SHA256 证书指纹必须与实际打包证书一致,如有多个证书指纹需要全部填写。包名或证书指纹不一致可能导致后续设备注册失败或离线推送无法触达。
49
+ >
50
+
51
+ ## 获取应用信息
52
+
53
+ 在**推送服务**列表中选择已开通推送服务的应用,查看并记录腾讯云控制台配置荣耀证书所需的应用信息。荣耀官方上架申请指南中明确可查看 `APPID`、`APP SECRET` 等信息;如腾讯云控制台要求填写其他字段,请以控制台表单和荣耀平台实际展示为准。
54
+
55
+ ## 腾讯云控制台配置
56
+
57
+ ### 添加荣耀厂商证书
58
+
59
+ 登录腾讯云 [即时通信 IM 控制台](https://console.qcloud.com/avc),在**推送服务 Push** > **推送设置** > **厂商配置**中添加荣耀厂商证书,并按控制台要求填写厂商参数。其中"应用内指定界面"请使用控制台默认配置。
60
+ | <strong>厂商推送平台</strong> | <strong>腾讯云即时通信 IM 控制台</strong> |
61
+ | --- | --- |
62
+ | | |
63
+
64
+ ### 配置回执和点击统计
65
+
66
+ 如需统计消息触达或点击数据,请在厂商配置阶段设置回执地址为:`https://api.im.qcloud.com/v3/offline_push_report/honor`。
67
+
68
+ ## 合规提示
69
+
70
+ 荣耀推送服务中,荣耀作为最终用户数据处理受委托方,应用方作为最终用户数据处理委托方。发送推送前,请根据业务所在地和用户协议要求获取用户同意,并向最终用户说明推送服务涉及的数据委托处理情况。具体要求请以荣耀官方隐私与数据处理说明为准。
71
+
72
+ ## 消息分类限制对推送效果的影响
73
+
74
+ 荣耀会将推送消息分为服务通讯类和资讯营销类。消息分类会影响推送数量、提醒方式和触达稳定性。IM 聊天、订单变化、账号安全等需要及时触达的消息,建议按荣耀规则申请自分类权益,并使用服务通讯类能力。
75
+
76
+ |**消息类型**|**推送影响**|**适用建议**|
77
+ |---------|---------|---------|
78
+ |服务通讯类|适合及时触达;具体权益以荣耀平台审核结果和最新规则为准。|适用于聊天、交易、订单、账号变更等用户需要及时知道的消息。|
79
+ |资讯营销类|可能受到每日推送数量、展示策略或夜间管控影响。|适用于活动、资讯、营销推广等非即时消息。|
80
+
81
+ > **警告:**
82
+ >
83
+
84
+ > 如果消息分类与实际内容不符,可能导致消息被厂商降级、限频或影响通道权限。营销、广告类消息不建议配置为服务通讯类。
85
+ >
86
+
87
+ 完成荣耀平台和腾讯云控制台配置后,后续发送离线推送时可在 SDK API 或腾讯云控制台默认配置中设置荣耀 `importance`。具体 API 使用方式请参见 Android SDK 接入文档中的 配置消息分类(可选)。
88
+
89
+ > **说明:**
90
+ >
91
+
92
+ > 荣耀推送和系统版本有关。当前荣耀通道仅支持国内 Magic UI 4.0 及以上和境外 Magic UI 4.2 及以上荣耀设备使用,低于上述版本的荣耀设备可以按华为厂商接入推送。
93
+ >
94
+
95
+ ## 配置完成检查
96
+
97
+ 完成本篇配置后,请按顺序检查:
98
+
99
+ |**检查项**|**预期结果**|
100
+ |---------|---------|
101
+ |包名一致性|荣耀应用包名与 Android 工程 `applicationId` 完全一致,且字符长度为 `4-64`。|
102
+ |SHA256 指纹|荣耀平台已添加与实际打包证书一致的 SHA256 证书指纹;如有多套证书,已全部填写。|
103
+ |配置文件|已下载最新 `mcs-services.json`,并准备在 SDK 接入阶段加入 Android 工程。|
104
+ |推送服务状态|荣耀推送服务已申请并开通。|
105
+ |应用参数|已记录腾讯云控制台配置荣耀证书所需的应用信息,并按控制台表单填写。|
106
+ |腾讯云厂商证书|已在腾讯云控制台添加荣耀证书,并填写正确参数。|
107
+ |回执和点击统计|如需统计,已按消息触达统计配置完成回执相关配置。|
108
+ |消息分类配置|如需 IM 消息及时触达,已申请并配置服务通讯类消息分类,并在 SDK API 或腾讯云控制台默认 `importance` 中完成配置。|
109
+ |合规要求|已根据业务要求完成用户同意、隐私告知和数据委托处理说明。|
110
+
111
+ 下一步请前往 Android SDK 接入,集成 TIMPush。
@@ -0,0 +1,106 @@
1
+ 本文将介绍如何完成华为离线推送服务厂商配置。
2
+
3
+ ## 前提条件
4
+
5
+ 开始前,请确认您已具备以下条件:
6
+
7
+ |**条件**|**说明**|
8
+ |---------|---------|
9
+ |华为开发者账号|用于登录华为开发者联盟和 AppGallery Connect。|
10
+ |Android App 包名|华为推送服务不要求应用先上架应用市场,应用包名必须与 Android 工程的 `applicationId` 保持一致。|
11
+ |打包证书及 SHA256 指纹|需提前准备实际打包签名证书,并获取对应 SHA256 指纹;后续将在华为 AppGallery Connect 中配置。|
12
+ |腾讯云账号和即时通信 IM 应用权限|用于在腾讯云控制台添加华为厂商证书。|
13
+ |后续 Android 工程接入权限|用于在 `SDK 接入` 阶段集成 TIMPush 和华为推送依赖。|
14
+
15
+ ## 华为 AppGallery Connect 配置
16
+
17
+ > **提示:**
18
+ >
19
+
20
+ > 本文配置流程可对照华为官方 [推送服务](https://developer.huawei.com/consumer/cn/doc/HMSCore-Guides/service-introduction-0000001050040060) 操作。
21
+ >
22
+
23
+ ### 注册华为开发者账号
24
+
25
+ 进入 [华为开发者联盟](https://developer.huawei.com/consumer/cn/),注册华为开发者账号,详情请参见 [注册账号](https://developer.huawei.com/consumer/cn/doc/start/registration-and-verification-0000001053628148)。
26
+
27
+ ### 创建应用
28
+ 1. 在 [华为管理中心](https://developer.huawei.com/consumer/cn/console) 的**应用服务**中,单击 **AppGallery Connect**,进入应用管理中心。
29
+
30
+ 2. 单击**我的项目**,添加一个新的项目。
31
+
32
+ 3. 在**项目设置**栏单击**推送服务** > **立即开通**。
33
+
34
+ 4. 单击**项目设置 > API 管理**,开启推送服务的权限。
35
+
36
+ ### 添加应用
37
+
38
+ 单击**项目设置 > 常规**,添加应用。
39
+
40
+ > **注意:**
41
+ >
42
+
43
+ > 应用包名与 Android 工程的 `applicationId` 需要保持一致。
44
+ >
45
+
46
+ ## 获取应用信息
47
+
48
+ 单击**项目设置 > 常规**,获取应用信息。常规页面包含项目和应用的 Client ID 和 Client Secret,两者对应的参数不一致,请下拉至页面底部,获取应用的 Client ID 和 Client Secret。
49
+
50
+ > **警告:**
51
+ >
52
+
53
+ > 必须添加打包的 [SHA256 证书指纹](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/android-config-agc-0000001050170137#section193351110105114),SHA256 证书指纹需与自己的打包证书一致,**否则可能导致无法正常接收离线推送消息**。
54
+ >
55
+
56
+ ## 腾讯云控制台配置
57
+
58
+ ### 添加华为厂商证书
59
+
60
+ 登录腾讯云 [即时通信 IM 控制台](https://console.qcloud.com/avc),在**推送服务 Push** > **推送设置** > **厂商配置**中添加华为厂商证书,并按控制台要求填写厂商参数。Client ID 对应 AppID,Client Secret 对应 AppSecret。"应用内指定界面"请使用控制台默认配置。
61
+ | <strong>厂商推送平台</strong> | <strong>腾讯云即时通信 IM 控制台</strong> |
62
+ | --- | --- |
63
+ | | |
64
+
65
+ ### 配置回执和点击统计
66
+
67
+ 如需统计消息触达或点击数据,请配置回执,回调地址填写:`https://api.im.qcloud.com/v3/offline_push_report/huawei`。
68
+
69
+ > **注意:**
70
+ >
71
+
72
+ > 华为推送证书 ID <= 11344 时,使用华为推送 v2 版本接口,不支持触达和点击回执,请重新生成更新证书 ID 。
73
+ >
74
+
75
+ ## 消息分类限制对推送效果的影响
76
+
77
+ 华为会将通知消息分为服务与通讯类和资讯营销类。消息分类会影响单设备每日接收数量、夜间展示和推送策略,IM 聊天消息建议按华为规则申请并使用服务与通讯类能力。具体限制请以华为官方 [消息限制说明](https://developer.huawei.com/consumer/cn/doc/HMSCore-Guides/message-restriction-description-0000001361648361) 和 [消息分类说明](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835) 为准。
78
+
79
+ |**消息类型**|**推送影响**|**适用建议**|
80
+ |---------|---------|---------|
81
+ |服务与通讯类|官方说明中该类消息不设数量限制,适合及时触达。|适用于聊天、交易、订单、账号变更等用户需要及时知道的消息。|
82
+ |资讯营销类|按应用类型设每日推送上限;0:00 - 6:00 期间可能被缓存,待管控解除后再尝试下发。|适用于活动、资讯、推广等非即时消息。|
83
+
84
+ > **警告:**
85
+ >
86
+
87
+ > 如果消息分类与实际内容不符,**可能导致消息被厂商降级、限频或影响通道权限**。营销、广告类消息不建议配置为服务与通讯类。
88
+ >
89
+
90
+ 配置消息分类时,可在华为侧申请自分类权益。完成华为平台和腾讯云控制台配置后,后续发送离线推送时可在 SDK API 或腾讯云控制台默认配置中设置华为 `Category`。具体的 SDK API 使用方式请参见 Android SDK 接入文档中的 配置消息分类(可选)。
91
+
92
+ ## 配置完成检查
93
+
94
+ 完成本篇配置后,请按顺序检查:
95
+
96
+ |**检查项**|**预期结果**|
97
+ |---------|---------|
98
+ |包名一致性|华为应用包名与 Android 工程 `applicationId` 完全一致。|
99
+ |SHA256 指纹|华为平台已添加与实际打包证书一致的 SHA256 证书指纹。|
100
+ |推送服务状态|华为推送服务已开通,推送服务 API 权限已开启。|
101
+ |应用参数|已记录目标 Android 应用的 Client ID 和 Client Secret。|
102
+ |腾讯云厂商证书|已在腾讯云控制台添加华为证书,并按映射填写 AppID 和 AppSecret。|
103
+ |回执和点击统计|如需统计,已按消息触达统计配置完成回执相关配置。|
104
+ |消息分类配置|如需 IM 消息及时触达,已申请并配置服务与通讯类消息分类,并在 API 或腾讯云控制台默认 `Category` 中完成配置。|
105
+
106
+ 下一步请前往 Android SDK 接入,集成 TIMPush。
@@ -0,0 +1,121 @@
1
+ 本文将介绍如何完成魅族离线推送服务厂商配置。
2
+
3
+ ## 前提条件
4
+
5
+ 开始前,请确认您已具备以下条件:
6
+
7
+ |**条件**|**说明**|
8
+ |---------|---------|
9
+ |魅族开发者账号|用于登录魅族开放平台并创建应用。开发者资料提交后,通常会在 3 个工作日内完成审核。|
10
+ |Android App 包名|魅族开放平台中的应用包名必须与 Android 工程的 `applicationId` 保持一致。魅族推送服务不要求应用先上架应用市场。|
11
+ |腾讯云账号和即时通信 IM 应用权限|用于在腾讯云控制台添加魅族厂商证书。|
12
+ |后续 Android 工程接入权限|用于在 `SDK 接入` 阶段集成 TIMPush 和魅族推送依赖。|
13
+
14
+ ## 魅族开放平台配置
15
+
16
+ > **提示:**
17
+ >
18
+
19
+ > 本文配置流程可对照 [魅族开放平台](https://open.flyme.cn/docs) 操作。
20
+ >
21
+
22
+ ### 注册魅族开发者账号
23
+
24
+ 进入 [魅族开放平台](https://open.flyme.cn/),注册魅族开发者账号。
25
+
26
+ ### 创建应用
27
+ 1. 单击**控制台** > **Flyme 推送**。
28
+
29
+ 2. 按页面要求填写应用名称、应用包名和应用图标,然后创建应用。
30
+
31
+ > **警告:**
32
+ >
33
+
34
+ > 应用包名必须与 Android 工程的 `applicationId` 保持一致。包名不一致可能导致后续 SDK 注册失败或推送设备无法正确匹配。
35
+ >
36
+
37
+ ### 获取应用信息
38
+
39
+ 在应用列表中单击**打开应用**,进入**配置管理** > **应用配置**页面,查看并记录应用信息。
40
+
41
+ |**参数**|**用途**|
42
+ |---------|---------|
43
+ |AppId|App 的唯一标识。|
44
+ |AppKey|客户端身份标识,后续客户端 SDK 初始化时使用。|
45
+ |AppSecret|服务端身份标识,腾讯云控制台配置魅族厂商证书时使用。|
46
+
47
+ > **注意:**
48
+ >
49
+
50
+ > 魅族 AppSecret 支持重置。重置后,旧 AppSecret 的服务端身份识别会失效,请同步更新腾讯云控制台和服务端相关配置,避免推送中断。
51
+ >
52
+
53
+ ## 腾讯云控制台配置
54
+
55
+ ### 添加魅族厂商证书
56
+
57
+ 登录腾讯云 [即时通信 IM 控制台](https://console.qcloud.com/avc),在**推送服务 Push** > **推送设置** > **厂商配置**中添加魅族厂商证书,并将获取到的 AppId、AppKey、AppSecret 等参数填写到对应证书配置中。
58
+ | <strong>厂商推送平台</strong> | <strong>IM 控制台配置</strong> |
59
+ | --- | --- |
60
+ | | <strong>说明:</strong>"应用内指定界面"请使用控制台默认配置。 |
61
+
62
+ ### 配置回执和点击统计
63
+
64
+ 如需统计消息触达或点击数据,请在厂商开放平台开启回执:
65
+
66
+ 并设置回执地址为:`https://api.im.qcloud.com/v3/offline_push_report/meizu` :
67
+
68
+ 同步完成回执配置,避免 SDK 接入后再返回控制台补配置。配置方法请参见 [消息触达统计配置 > 魅族](https://cloud.tencent.com/document/product/269/100626#daa658b0-1ac0-44a8-8a47-7ec8822ebe82)。
69
+
70
+ > **注意:**
71
+ >
72
+
73
+ > 打开回执开关后,请务必确保回执地址正确配置。不配置或者配置地址错误,都会影响推送功能。
74
+ >
75
+
76
+ ## 消息分类限制对推送效果的影响
77
+
78
+ 魅族会将推送消息分为私信消息和公信消息。默认通道为公信消息,公信消息会限制每日每设备推送数量;私信消息适用于用户有明确预期、需要及时知道的消息。
79
+
80
+ |**消息类型**|**推送影响**|**适用建议**|
81
+ |---------|---------|---------|
82
+ |私信消息|适合及时触达;具体权益以魅族平台审核结果和最新规则为准。|适用于聊天消息、订单变化、交易提醒等用户有明确预期的消息。|
83
+ |公信消息|可能受到每日每设备推送数量、频控或展示策略限制。|适用于活动、资讯、公告、营销推广等非即时消息。|
84
+
85
+ > **警告:**
86
+ >
87
+
88
+ > 营销、广告、活动类消息不应配置为私信消息。分类不符或滥用可能导致消息被拦截、降级、限流或影响推送权限。
89
+ >
90
+
91
+ 完成魅族平台和腾讯云控制台配置后,后续发送离线推送时可在 SDK API 或腾讯云控制台默认配置中设置魅族消息分类。具体 API 使用方式请参见 Android SDK 接入文档中的 配置消息分类(可选)。
92
+
93
+ ## 平台约束与配额
94
+
95
+ 魅族推送平台存在以下默认约束,业务侧发送频率或任务数量超过限制时,可能导致推送延迟、失败或展示效果不符合预期:
96
+
97
+ |**约束项**|**默认限制**|**影响**|
98
+ |---------|---------|---------|
99
+ |推送速率限制|默认 `10000` 设备/10 秒|短时间集中推送超过限制时,需要联系平台调整或在业务侧降频。|
100
+ |后台创建任务次数|默认 `1000` 次/天|通过 Push 推送后台创建任务或通过 API 推送全部用户、标签用户时受限。|
101
+ |API 创建任务推送次数|默认 `10000` 次/天|通过 API 创建任务推送时受限。|
102
+ |标签数量|单个业务订阅标签不超过 `100` 个|标签设计过细可能超过平台限制。|
103
+ |消息折叠|单设备单业务推送消息 `≥4` 条会被折叠展示|连续发送多条消息时,用户可能只看到折叠后的通知。Flyme 10 以下版本会将多次不点击的消息收纳到右上角消息收纳盒。|
104
+ |设备订阅有效期|单个设备 `30` 天不活跃将取消订阅|长期不活跃用户可能收不到后续推送,需要业务侧结合用户活跃度评估触达效果。|
105
+
106
+ ## 配置完成检查
107
+
108
+ 完成本篇配置后,请按顺序检查:
109
+
110
+ |**检查项**|**预期结果**|
111
+ |---------|---------|
112
+ |开发者账号状态|魅族开发者账号已完成认证,企业开发者基本信息已核对无误。|
113
+ |包名一致性|魅族开放平台应用包名与 Android 工程 `applicationId` 完全一致。|
114
+ |应用参数|已记录腾讯云控制台配置魅族证书所需的 AppId、AppKey 和 AppSecret。|
115
+ |腾讯云厂商证书|已在腾讯云控制台添加魅族证书,并填写正确参数。|
116
+ |回执和点击统计|如需统计,已按消息触达统计配置完成回执相关配置。|
117
+ |消息分类配置|如需 IM 消息及时触达,已确认私信消息分类规则,并在 SDK API 或腾讯云控制台默认配置中完成配置。|
118
+ |平台约束|已评估推送速率、任务次数、消息折叠和 `30` 天不活跃取消订阅对触达效果的影响。|
119
+ |点击后续动作|如使用**打开应用内指定界面**,已保留控制台默认值。|
120
+
121
+ 下一步请前往 Android SDK 接入,集成 TIMPush。
@@ -0,0 +1,108 @@
1
+ 本文将介绍如何完成 OPPO 离线推送服务厂商配置。
2
+
3
+ ## 前提条件
4
+
5
+ 开始前,请确认您已具备以下条件:
6
+
7
+ |**条件**|**说明**|
8
+ |---------|---------|
9
+ |OPPO 企业开发者账号|用于登录 OPPO 开放平台并创建应用。申请消息推送时,建议使用管理员账号操作。|
10
+ |已上架 OPPO 软件商店的 Android 应用|正式通知栏推送要求应用已在 OPPO 软件商店上架。国内政府类、企业内部 IM 类应用如无法上架,可先按 OPPO 官方 [应用不上架申请](https://open.oppomobile.com/documentation/page/info) 流程申请,通过后仍需继续提交 PUSH 服务申请。|
11
+ |Android App 包名|OPPO 开放平台中的应用包名必须与 Android 工程的 `applicationId` 保持一致。|
12
+ |腾讯云账号和即时通信 IM 应用权限|用于在腾讯云控制台添加 OPPO 厂商证书。|
13
+
14
+ ## OPPO 开放平台配置
15
+
16
+ > **提示:**
17
+ >
18
+
19
+ > 本文配置流程可对照 OPPO 官方[申请推送服务](https://open.oppomobile.com/documentation/page/info)操作。
20
+ >
21
+
22
+ ### 注册 OPPO 开发者账号
23
+
24
+ 进入 [OPPO 开放平台](https://open.oppomobile.com/),注册 OPPO 企业开发者账号,详情参见 [OPPO 企业开发者账号注册](https://open.oppomobile.com/new/developmentDoc/info)。
25
+
26
+ ### 创建应用
27
+
28
+ 进入 OPPO 开放平台,单击**产品** > **应用分发** > **OPPO 软件商店** > **发布应用**,进入管理中心,创建应用。
29
+
30
+ ### 开通 PUSH 服务
31
+ 1. 进入 OPPO 开放平台,单击**产品** > **移动服务** > **推送服务**,进入推送主页,单击**申请接入**开通推送服务。
32
+
33
+ 2. 进入**管理中心** > **应用列表** > **申请推送服务**,为未开启服务的应用申请推送权限。
34
+
35
+ > **说明:**
36
+ >
37
+
38
+ > 已开启服务表示应用已申请 PUSH 权限并通过;未开启服务表示应用可申请 PUSH 权限。
39
+ >
40
+
41
+ 3. 在未开启服务的应用中选择目标应用,单击**申请开通**,按页面要求提交 PUSH 权限申请。
42
+
43
+ ### 确认推送权限类型
44
+
45
+ 提交申请后,请确认当前应用获得的是测试权限还是正式通知栏推送权限。测试权限每天仅可推送 1000 条消息,仅限测试使用;应用上架后,需要重新申请通知栏推送权限,以获得正式消息推送数量。PUSH 服务申请提交后,OPPO 平台通常会在 1 个工作日内返回审核结果。
46
+
47
+ ## 腾讯云控制台配置
48
+
49
+ ### 添加 OPPO 厂商证书
50
+
51
+ 登录腾讯云 [即时通信 IM 控制台](https://console.qcloud.com/avc),在**推送服务 Push** > **推送设置** > **厂商配置**中添加 OPPO 厂商证书,并按控制台要求填写厂商参数。
52
+ | <strong>厂商推送平台</strong> | <strong>IM 控制台配置</strong> |
53
+ | --- | --- |
54
+ | | <strong>说明:</strong>"应用内指定界面"请使用控制台默认配置。 |
55
+
56
+ ## 消息分类限制对推送效果的影响
57
+
58
+ OPPO [新消息分类](https://open.oppomobile.com/documentation/page/info) 会影响离线推送的提醒方式、推送量级和触达稳定性。对于 IM 聊天、音视频通话等需要及时触达的消息,建议按 OPPO 规则申请 [通讯与服务(原私信)不限量权益](https://open.oppomobile.com/documentation/page/info),并在发送离线推送时配置正确的消息分类。
59
+
60
+ |**场景**|**建议配置**|**对离线推送的影响**|
61
+ |---------|---------|---------|
62
+ |IM 聊天、音视频通话|申请通讯与服务不限量权益,并使用 `category=IM`。|适合即时触达。未申请或未配置时,消息可能走受限通道,影响大量离线消息触达。|
63
+ |订单、账号、设备等个人强相关提醒|按 OPPO 规则选择通讯与服务类 `category`。|可获得更符合场景的提醒方式;分类不匹配可能影响审核或提醒效果。|
64
+ |活动、广告、内容推荐等营销消息|使用内容与营销类分类。|不应走通讯与服务通道,否则可能被 OPPO 判定为违规,导致提醒降级或通道权限受限。|
65
+
66
+ > **警告:**
67
+ >
68
+
69
+ > OPPO 通讯与服务通道非默认开启,需按 OPPO 官方流程申请。营销、广告、活动类消息不应走通讯与服务通道,否则可能被 OPPO 判定为违规,导致提醒降级或通道权限受限。
70
+ >
71
+
72
+ ### notify_level 与强提醒
73
+
74
+ OPPO `notify_level` 用于控制通知提醒等级:
75
+ - `1` 表示仅通知栏,
76
+
77
+ - `2` 表示通知栏、锁屏、铃声、振动,
78
+
79
+ - `16` 表示通知栏、锁屏、铃声、振动、横幅。
80
+
81
+ 配置 `notify_level` 时必须同时配置 `category`。
82
+
83
+ > **注意:**
84
+ >
85
+
86
+ > 内容与营销类消息的 `notify_level` 只能为 `1`。通讯与服务类消息默认 `2`,如需使用 `16`,需先向 OPPO 申请强提醒能力。未申请强提醒能力时,不要直接配置 `16`。
87
+ >
88
+
89
+ ### 后续 SDK/API 接入提示
90
+
91
+ 完成 OPPO 平台和腾讯云控制台配置后,后续发送离线推送时还需要按实际接入方式传入对应参数:新规则使用 `category`、私信模板参数和可选的 `notify_level`;旧规则仅适用于已开通 OPPO 私信通道权限的存量应用,需使用已创建并登记的私信通道 `ChannelID`。具体 API 使用方式请参见 Android SDK 接入文档中的 配置消息分类(可选)。
92
+
93
+ ## 配置完成检查
94
+
95
+ 完成本篇配置后,请按顺序检查:
96
+
97
+ |**检查项**|**预期结果**|
98
+ |---------|---------|
99
+ |推送权限类型|正式推送使用的应用已在 OPPO 软件商店上架,或已完成 OPPO 不上架申请;测试权限仅用于测试场景,且每日仅可推送 1000 条。|
100
+ |包名一致性|OPPO 开放平台应用包名与 Android 工程 `applicationId` 完全一致。|
101
+ |PUSH 服务状态|目标应用已申请并开通 PUSH 服务,审核状态已通过。|
102
+ |腾讯云厂商证书|已在腾讯云控制台添加 OPPO 证书,并填写正确参数。|
103
+ |消息分类配置|IM 类消息已申请通讯与服务不限量权益,并在 API 或控制台默认配置中使用正确的 `category`,例如 `IM`。|
104
+ |提醒等级配置|如需横幅等强提醒,已向 OPPO 申请强提醒能力,并确认 `notify_level` 配置符合 OPPO 规则。|
105
+ |通道 ID 配置|如使用 OPPO 旧规则或存量私信通道方式,客户端 `channelID` 与 OPPO 推送运营后台登记的通道 ID 保持一致。|
106
+ |合规使用|营销、广告、活动类消息未走通讯与服务通道,避免触发 OPPO 通道处罚。|
107
+
108
+ 下一步请前往 Android SDK 接入,集成 TIMPush。