@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,92 @@
1
+ ## 组件概述
2
+
3
+ ChatSetting 是基于 SwiftUI 构建的聊天设置组件集合,主要包含单聊设置(C2CChatSetting)和群聊设置(GroupChatSetting)两个核心组件。这些组件为用户提供了完整的聊天会话管理功能,包括用户信息管理、权限设置、群组管理等核心能力。
4
+ | <strong>单聊设置界面</strong> | <strong>群聊设置界面</strong> |
5
+ | --- | --- |
6
+ | | |
7
+
8
+ ## 组件集成
9
+
10
+ ChatSetting 组件属于 TUIKit SwiftUI 的一部分,集成 TUIKit SwiftUI 即可获取并使用 ChatSetting 组件。集成方法请参考文档 TUIKit SwiftUI 里的集成步骤。
11
+
12
+ ## 组件构成
13
+
14
+ ChatSetting 包含两个主要组件:C2CChatSetting(单聊设置)和 GroupChatSetting(群聊设置),每个组件都提供了丰富的配置选项。
15
+
16
+ ### 单聊设置(C2CChatSetting)
17
+
18
+ #### 初始化参数
19
+
20
+ |参数名|类型|描述|
21
+ |---------|---------|---------|
22
+ |`userID`|`String`|聊天对象的用户 ID。|
23
+ |`onSendMessageClick`|`(() -> Void)?`|发送消息按钮点击回调,可选参数。|
24
+ |`onContactDelete`|`(() -> Void)? `|删除联系人点击回调,可选参数。|
25
+
26
+ #### 初始化接口
27
+
28
+ |方法名|参数|描述|
29
+ |---------|---------|---------|
30
+ |`init`|`userID: String, onSendMessageClick: (() -> Void)?, onContactDelete: (() -> Void)?`|初始化单聊设置组件。|
31
+
32
+ ### 群聊设置(GroupChatSetting)
33
+
34
+ #### 初始化参数
35
+
36
+ |参数名|类型|描述|
37
+ |---------|---------|---------|
38
+ |`groupID`|`String`|群组 ID,用于标识群聊。|
39
+ |`onSendMessageClick`|`(() -> Void)?`|发送消息按钮点击回调,可选参数。|
40
+ |`onGroupDelete`|`(() -> Void)?`|解散群组、退出群聊的点击回调,可选参数。|
41
+
42
+ #### 初始化接口
43
+
44
+ |方法名|参数|描述|
45
+ |---------|---------|---------|
46
+ |`init`|`groupID: String, onSendMessageClick: (() -> Void)?, onGroupDelete: (() -> Void)?`|初始化群聊设置组件。|
47
+
48
+ ## 基础用法
49
+
50
+ 初始化 C2CChatSetting 即可直接展示单聊设置页面,示例代码如下:
51
+ ``` swift
52
+ import AtomicX
53
+ import SwiftUI
54
+
55
+ struct C2CSettingView: View {
56
+ let userID: String
57
+
58
+ var body: some View {
59
+ C2CChatSetting(
60
+ userID: userID,
61
+ onSendMessageClick: {
62
+ // 处理发送消息点击事件
63
+ },
64
+ onContactDelete: {
65
+ // 处理删除好友点击事件
66
+ }
67
+ )
68
+ }
69
+ }
70
+ ```
71
+
72
+ 初始化 GroupChatSetting 即可直接展示群聊设置页面,示例代码如下:
73
+ ``` swift
74
+ import AtomicX
75
+ import SwiftUI
76
+
77
+ struct GroupSettingView: View {
78
+ let groupID: String
79
+
80
+ var body: some View {
81
+ GroupChatSetting(
82
+ groupID: groupID,
83
+ onSendMessageClick: {
84
+ // 处理发送消息点击事件
85
+ },
86
+ onGroupDelete: {
87
+ // 处理删除、解散、退出群聊点击事件
88
+ }
89
+ )
90
+ }
91
+ }
92
+ ```
@@ -0,0 +1,119 @@
1
+ ## 组件概述
2
+
3
+ ContactList 是基于 SwiftUI 构建的联系人列表组件,为用户提供完整的联系人管理功能。该组件支持好友列表展示、好友申请处理、群组列表管理、黑名单管理等功能,并提供了丰富的交互回调接口。
4
+ | <strong>联系人列表</strong> | <strong>群组列表</strong> | <strong>好友申请列表</strong> |
5
+ | --- | --- | --- |
6
+ | | | |
7
+
8
+ ## 组件集成
9
+
10
+ `ContactList` 组件属于 TUIKit SwiftUI 的一部分,集成 TUIKit SwiftUI 即可获取并使用 `ContactList` 组件。集成方法请参考文档 TUIKit SwiftUI 里的集成步骤。
11
+
12
+ ## 组件构成
13
+
14
+ `ContactList` 是联系人列表里的主组件,对应着整个联系人列表页框架,提供了一个对外的初始化 init 方法:
15
+ | <strong>方法名</strong> | <strong>参数</strong> | <strong>描述</strong> |
16
+ | --- | --- | --- |
17
+ | <code>init</code> | <code>contactStore: ContactListStore</code> | 联系人数据存储,默认请使用 <code>ContactListStore.create()</code> 创建。 |
18
+ | <code>onContactClick: ((AZOrderedListItem) -> Void)?</code> | 点击联系人的回调,可选参数。 | |
19
+ | <code>onGroupClick: ((AZOrderedListItem) -> Void)?</code> | 点击群组的回调,可选参数。 | |
20
+
21
+ `ContactList` 上半部分预留了各个子视图的入口 cell,例如好友申请、群聊申请、群组列表和黑名单列表。下半部分内嵌了联系人列表,如下图所示:
22
+
23
+ `ContactList` 已内置子页面导航逻辑,点击好友申请、群组申请、群组列表、黑名单等入口时,会自动以全屏弹窗(fullScreenCover)的方式打开对应的子页面,无需您手动处理导航跳转。
24
+
25
+ 如果您需要单独使用子页面(例如好友申请列表、群组列表等),各子页面提供了独立的 init 方法,详情如下:
26
+ | <strong>子页面</strong> | <strong>方法名</strong> | <strong>参数</strong> | <strong>描述</strong> |
27
+ | --- | --- | --- | --- |
28
+ | 好友申请页(FriendApplicationListView) | init | <code>contactStore: ContactListStore</code> | 联系人数据存储,从 ContactList 传过来。 |
29
+ | <code>onDismiss: (() -> Void)?</code> | 关闭页面的回调,可选参数。 | | |
30
+ | 群组申请页(GroupApplicationListView) | init | <code>contactStore: ContactListStore</code> | 联系人数据存储,从 ContactList 传过来。 |
31
+ | <code>onDismiss: (() -> Void)?</code> | 关闭页面的回调,可选参数。 | | |
32
+ | 群组列表页<br>(GroupListView) | init | <code>contactStore: ContactListStore</code> | 联系人数据存储,从 ContactList 传过来。 |
33
+ | <code>onGroupClick: ((AZOrderedListItem) -> Void)?</code> | 点击群组列表页里的群组的回调,可选参数。 | | |
34
+ | <code>onDismiss: (() -> Void)?</code> | 关闭页面的回调,可选参数。 | | |
35
+ | 黑名单列表页<br>(BlackListView) | init | <code>contactStore: ContactListStore</code> | 联系人数据存储,从 ContactList 传过来。 |
36
+ | <code>onDismiss: (() -> Void)?</code> | 关闭页面的回调,可选参数。 | | |
37
+
38
+ ## 基础用法
39
+
40
+ ### 快速集成
41
+
42
+ `ContactList` 已内置子页面导航,您只需简单初始化即可获得完整的联系人管理功能:
43
+ ``` swift
44
+ import AtomicX
45
+ import SwiftUI
46
+
47
+ struct ContactsPage: View {
48
+ private let contactStore = ContactListStore.create()
49
+
50
+ var body: some View {
51
+ ContactList(
52
+ contactStore: contactStore,
53
+ onContactClick: { contact in
54
+ // 处理联系人点击
55
+ print("点击联系人: \(contact.title)")
56
+ },
57
+ onGroupClick: { group in
58
+ // 处理群组点击(从群组列表页点击群组时触发)
59
+ print("点击群组: \(group.title)")
60
+ }
61
+ )
62
+ }
63
+ }
64
+ ```
65
+
66
+ 点击好友申请、群组申请、群组列表、黑名单等入口时,组件会自动以全屏弹窗的方式打开对应子页面,无需额外处理导航逻辑。跳转示意图如下:
67
+
68
+ ### 集成要点说明
69
+
70
+ #### 内置导航
71
+
72
+ ContactList 内置了子页面导航逻辑,使用 fullScreenCover 方式呈现子页面:
73
+ - 好友申请页(FriendApplicationListView)
74
+
75
+ - 群组申请页(GroupApplicationListView)
76
+
77
+ - 群组列表页(GroupListView)
78
+
79
+ - 黑名单列表页(BlackListView)
80
+
81
+ 您无需手动管理导航状态或配置 NavigationLink。
82
+
83
+ #### 回调处理
84
+
85
+ ContactList 提供两个可选回调:
86
+ ``` swift
87
+ ContactList(
88
+ contactStore: contactStore,
89
+ onContactClick: { contact in
90
+ // 点击联系人列表中的联系人时触发
91
+ },
92
+ onGroupClick: { group in
93
+ // 点击群组列表中的群组时触发
94
+ }
95
+ )
96
+ ```
97
+
98
+ #### 数据共享
99
+
100
+ 使用 ContactListStore.create() 创建数据存储实例,组件内部会自动将该实例传递给所有子页面,确保数据一致性:
101
+ ``` swift
102
+ private let contactStore = ContactListStore.create()
103
+ ```
104
+
105
+ #### 单独使用子页面
106
+
107
+ 如果您需要在其他场景单独使用子页面,可以直接初始化对应的视图:
108
+ ``` swift
109
+ // 单独使用群组列表页
110
+ GroupListView(
111
+ contactStore: contactStore,
112
+ onGroupClick: { group in
113
+ print("点击群组: \(group.title)")
114
+ },
115
+ onDismiss: {
116
+ // 关闭页面
117
+ }
118
+ )
119
+ ```
@@ -0,0 +1,134 @@
1
+ ## 组件概述
2
+
3
+ ConversationList 是一个基于 SwiftUI 构建的会话列表组件,主要用于展示和管理用户的聊天会话。该组件提供了完整的会话列表功能,包括会话展示、交互操作等核心能力。
4
+ | <strong>会话列表</strong> | <strong>会话操作</strong> |
5
+ | --- | --- |
6
+ | | |
7
+
8
+ ## 组件集成
9
+
10
+ ConversationList 是属于 TUIKit SwiftUI 的一个组件,集成 TUIKit SwiftUI 即可获取并使用 ConversationList,集成方法请参考文档 TUIKit SwiftUI 里的集成步骤。
11
+
12
+ ## 组件构成
13
+
14
+ ConversationList 组件对外仅暴露了会话列表的初始化方法,其他逻辑均封装在 ConversationList 中。
15
+
16
+ #### 对外方法
17
+ | 方法名 | 参数 | 描述 |
18
+ | --- | --- | --- |
19
+ | <code>init</code> | <code>onConversationClick: @escaping (ConversationInfo) -> Void</code> | 初始化组件,设置会话点击回调,必填。 |
20
+ | <code>config: ConversationActionConfigProtocol = ChatConversationActionConfig()</code> | 初始化组件,设置会话操作菜单项,选填。 | |
21
+ | <code>customActions: [ConversationCustomAction] = []</code> | 初始化组件,设置自定义会话操作选项,选填。 | |
22
+
23
+ ## 基础用法
24
+
25
+ ConversationList 组件可直接初始化使用,需要实现 onConversationClick 回调。
26
+
27
+ |参数名|类型|描述|
28
+ |---------|---------|---------|
29
+ |`onConversationClick`|`(ConversationInfo) -> Void`|会话点击回调,当用户点击某个会话 cell 时触发。|
30
+
31
+ 示例代码如下:
32
+ ``` swift
33
+ import AtomicX
34
+ import SwiftUI
35
+
36
+ struct ContentView: View {
37
+ var body: some View {
38
+ ConversationList(
39
+ onConversationClick: { conversation in
40
+ // 这里建议导航到聊天页面
41
+ }
42
+ )
43
+ }
44
+ }
45
+ ```
46
+
47
+ ## 自定义组件
48
+
49
+ 您可以自定义会话列表的操作项。方法如下。
50
+
51
+ #### 方式 1. 局部隐藏会话操作项
52
+
53
+ 初始化 ConversationList 时传入自定义 config,设置是否展示某些菜单项:
54
+ ``` swift
55
+ struct CustomConversationView: View {
56
+ var body: some View {
57
+ ConversationList(
58
+ onConversationClick: { conversation in
59
+ // 点击会话 cell 跳转
60
+ },
61
+ // 不展示 ClearHistory
62
+ config: ChatConversationActionConfig(isSupportDelete: true, isSupportPin: true, isSupportClearHistory: false)
63
+ )
64
+ }
65
+ }
66
+ ```
67
+
68
+ **目前支持的菜单项开关操作**
69
+
70
+ |操作类型|描述|
71
+ |---------|---------|
72
+ |`isSupportDelete`|是否支持删除会话。|
73
+ |`isSupportPin`|是否支持置顶会话。|
74
+ |`isSupportClearHistory`|是否支持清空历史消息。|
75
+
76
+ #### 方式 2. 局部增加会话操作项
77
+
78
+ 初始化 ConversationList 时传入 `customActions`,ConversationList 内部会在默认的 action 底部添加您增加的自定义选项:
79
+
80
+ |参数名|类型|描述|
81
+ |---------|---------|---------|
82
+ |`customActions`|`[ConversationCustomAction]`|自定义会话操作,当用户点击会话操作菜单时展示。|
83
+
84
+ 示例代码如下:
85
+ ``` java
86
+ struct CustomConversationView: View {
87
+ var body: some View {
88
+ ConversationList(
89
+ onConversationClick: { conversation in
90
+ onShowMessage?(NavigationInfo(conversation: conversation))
91
+ },
92
+ // Custom actions
93
+ customActions: [
94
+ ConversationCustomAction(title: "Share") { conversation in
95
+ print("Share conversation: \(conversation.title ?? "")")
96
+ },
97
+ ]
98
+ )
99
+ .conversationActions([.delete, .pin, .clearHistory])
100
+ .environmentObject(themeState)
101
+ }
102
+ }
103
+
104
+ ```
105
+
106
+ #### 方式 3. 全局配置方式
107
+
108
+ 通过 `AppBuilderConfig` 进行全局配置:
109
+ ``` swift
110
+ // 在应用启动时配置,不包含则不支持
111
+ AppBuilderConfig.shared.conversationActionList = [
112
+ .delete, // 支持删除
113
+ .pin, // 支持置顶
114
+ .clearHistory // 清空会话消息
115
+ ]
116
+
117
+ // 接下来再初始化 ConversationList,所有的 ConversationList 都会遵守上面 conversationActionList 的配置
118
+ ConversationList(
119
+ onConversationClick: { conversation in
120
+ // 这里可以导航到聊天页面
121
+ }
122
+ )
123
+ ```
124
+
125
+ > **注意:**
126
+ >
127
+
128
+ > 局部配置的优先级大于全局配置。
129
+ >
130
+
131
+ 自定义效果如下图所示:
132
+ | 会话操作(默认选项) | 会话操作(隐藏<strong>删除</strong>选项) | 会话操作(新增<strong>隐藏会话</strong>选项) |
133
+ | --- | --- | --- |
134
+ | | | |
@@ -0,0 +1,105 @@
1
+ ## 功能描述
2
+
3
+ iOS 端 `TUIKit`默认自带 **简体中文、英语 **和** 阿拉伯语** 语言包,作为界面展示语言。
4
+
5
+ 根据此文档指引,您可以使用默认语言包,也可自定义语言翻译表述和增加其他语言包。
6
+
7
+ > **说明:**
8
+ >
9
+
10
+ > TUIKit 从 7.5.4852 版本开始,新增 RTL 语言(文字方向从右到左的语言,例如阿拉伯语、希伯来语等)支持,同时内置语言新增了阿拉伯语。
11
+ >
12
+
13
+ |简体中文|英文|阿拉伯语|
14
+ |---------|---------|---------|
15
+ ||||
16
+
17
+ ## 使用自带语言
18
+
19
+ 如果您的 App 需要的语言仅包括 **简体中文、英语 **和** 阿拉伯语** ,请参考本部分。
20
+
21
+ ### 跟随系统语言
22
+
23
+ 直接使用 `TUIKit` 即可,无需额外步骤。组件内部语言会跟随系统语言。
24
+
25
+ ### 指定显示的语言
26
+
27
+ 如果您需要指定`TUIKit`界面语言,请在`[TUIGlobalization setPreferredLanguage:@""]`中传入需要的语言,指定语言后,组件内部不再跟随系统语言。
28
+ 语言可选项,取值为:
29
+ ``` Java
30
+ @"zh-Hans" ,//简体中文
31
+ @"en", // 英文
32
+ @"ar", // 阿拉伯语
33
+ ```
34
+
35
+ > **说明**
36
+ >
37
+
38
+ > 语言代码清单见 附录。
39
+ >
40
+
41
+ ## 使用更多语言/自定义翻译表述
42
+
43
+ 如果您的 App 需要支持更多语言,或更改部分词条的翻译,请参考本部分。
44
+
45
+ 本章节以添加韩语语言包为例,讲解新增语言包和自定义翻译的流程。
46
+
47
+ ### 新增语言资源文件
48
+
49
+ 我们自带的所有语言包,以String文件模板的形式,存储于您项目里Pods中`TUICore`组件的`TUIKitLocalizable/Localizable/` 路径。
50
+
51
+ 请新建目录并命名为`{语言编码}.lproj`,在此目录下新增 `Localizable.strings`文件,其中,`${语言编码}` 需要替换为 ISO 639-1 语言代码。(可以直接复制您熟悉的语言文件,如zh-Hans.lproj,并直接修改目录名称)
52
+ 如果您需要兼容支持多个新语言,复制多份,并准确指定每一份的语言编码即可。
53
+
54
+ 以韩语为例,新增`ko.lproj/Localizable.strings`的语言资源文件:
55
+
56
+ ### 个性化自定义翻译
57
+
58
+ 上一步已经创建好了韩语资源文件 `ko.lproj/Localizable.strings`,不同语言资源文件中语言的 `key` 是相同的,具体内容可以自定义翻译。
59
+
60
+ ### 跟随系统语言
61
+
62
+ 如果是简体中文、繁体中文、英文、韩语、俄语、乌克兰语,添加完lproj资源包后直接使用TUIKit即可,无需额外步骤。
63
+
64
+ 如果是其他语种,则需要在 `TUIGlobalization.m`中的`+ (NSString *)tk_localizableLanguageKey`
65
+
66
+ 新增的语言词条包命名需要 符合标准,组件内部会跟随系统语言自适应。
67
+
68
+ > **说明**
69
+ >
70
+
71
+ > 语言代码清单见 ISO 639-1 语言代码。
72
+ >
73
+
74
+ ### 指定显示的语言
75
+
76
+ 如果您需要指定`TUIKit`界面语言,请在`[TUIGlobalization setPreferredLanguage:@""]`中传入需要的语言,指定语言后,组件内部不再跟随系统语言。
77
+ 语言可选项,取值为 ISO 639-1 语言代码
78
+ 以韩语为例,传入`[TUIGlobalization setPreferredLanguage:@"ko"];`
79
+
80
+ 效果如图所示:
81
+
82
+ ## 附录:语言代码表
83
+
84
+ |语言|代码|语言|代码|
85
+ |---------|---------|---------|---------|
86
+ |阿拉伯语|ar|保加利亚语|bg|
87
+ |克罗地亚语|hr|捷克语|cs|
88
+ |丹麦语|da|德语|de|
89
+ |希腊语|el|英语|en|
90
+ |爱沙尼亚语|et|西班牙语|es|
91
+ |芬兰语|fi|法语|fr|
92
+ |爱尔兰语|ga|印地语|hi|
93
+ |匈牙利语|hu|希伯来语|he|
94
+ |意大利语|it|日语|ja|
95
+ |朝鲜语/韩语|ko|拉脱维亚语|lv|
96
+ |立陶宛语|lt|荷兰语|nl|
97
+ |挪威语|no|波兰语|pl|
98
+ |葡萄牙语|pt|瑞典语|sv|
99
+ |罗马尼亚语|ro|俄语|ru|
100
+ |塞尔维亚语|sr|斯洛伐克语|sk|
101
+ |斯洛文尼亚语|sl|泰语|th|
102
+ |土耳其语|tr|乌克兰语|uk|
103
+ |中文(简体)|zh-Hans|中文(繁体)|zh-Hant|
104
+
105
+ 完整版 [请见此处](https://quickref.me/iso-639-1)。
@@ -0,0 +1,69 @@
1
+ ## 组件概述
2
+
3
+ MessageInput 是基于 SwiftUI 构建的消息输入组件,为用户提供完整的消息编辑和发送功能。该组件支持多种消息类型的输入和发送,包括文本消息、图片、视频、文件、语音等,同时提供表情选择等增强功能,支持多种样式配置和自定义选项。
4
+ | <strong>消息输入界面</strong> | <strong>表情选择器</strong> |
5
+ | --- | --- |
6
+ | | |
7
+
8
+ ## 组件集成
9
+
10
+ MessageInput 组件属于 TUIKit SwiftUI 的一部分,集成 TUIKit SwiftUI 即可获取并使用 MessageInput 组件。集成方法请参考文档 TUIKit SwiftUI 里的集成步骤。
11
+
12
+ ## 组件构成
13
+
14
+ MessageInput 组件包含消息输入核心组件和样式配置协议,提供了消息输入功能,并支持自定义。
15
+
16
+ #### 初始化参数
17
+
18
+ |参数名|类型|描述|
19
+ |---------|---------|---------|
20
+ |`conversationID`|`String`|会话 ID,用于标识当前聊天会话。|
21
+ |`config`|`MessageInputConfigProtocol`|输入样式配置,控制各功能按钮的显示。|
22
+
23
+ #### 公开接口
24
+
25
+ |方法名|参数|描述|
26
+ |---------|---------|---------|
27
+ |`init`|`conversationID: String, config: MessageInputConfigProtocol`|初始化消息输入组件。|
28
+
29
+ ## 基础用法
30
+
31
+ MessageInput 组件可直接初始化使用,需要提供会话 ID。
32
+ ``` swift
33
+ import AtomicX
34
+ import SwiftUI
35
+
36
+ struct ChatView: View {
37
+ var body: some View {
38
+ VStack {
39
+ Spacer()
40
+
41
+ MessageInput(
42
+ conversationID: "conversation_123"
43
+ )
44
+ }
45
+ }
46
+ }
47
+ ```
48
+
49
+ ## 自定义组件
50
+
51
+ 您可以自定义决定是否显示输入栏上的功能入口:
52
+ ``` swift
53
+ // 自定义显示哪些功能按钮
54
+ MessageInput(
55
+ text: $inputText,
56
+ conversationID: conversationID,
57
+ config: ChatMessageInputConfig(
58
+ isShowAudioRecorder: false, // 隐藏语音录制
59
+ isShowPhotoTaker: true, // 显示拍照功能
60
+ isShowMore: true, // 显示更多功能
61
+ isShowSendButton: true // 显示发送按钮
62
+ )
63
+ )
64
+ ```
65
+
66
+ 自定义效果如下图所示:
67
+ | 默认输入框 | 隐藏输入框上的语音录制功能 | 隐藏输入框上的全部功能 |
68
+ | --- | --- | --- |
69
+ | | | |
@@ -0,0 +1,164 @@
1
+ ## 组件概述
2
+
3
+ MessageList 是一个基于 SwiftUI 构建的消息列表组件,主要用于展示和管理聊天消息。该组件提供了完整的消息类型展示功能:
4
+ - 消息类型支持:文本、图片、视频、语音、文件、系统消息、表情消息等。
5
+
6
+ - 消息操作:支持长按菜单操作,例如复制、删除、撤回、以及自定义操作。
7
+
8
+ - 高度可定制:支持多种样式配置(例如气泡颜色、圆角、字体)和自定义操作项。
9
+
10
+ | <strong>聊天消息列表</strong> | <strong>消息长按菜单</strong> |
11
+ | --- | --- |
12
+ | | |
13
+
14
+ ## 组件集成
15
+
16
+ MessageList 是属于 TUIKit SwiftUI 的一个组件,集成 TUIKit SwiftUI 即可获取并使用 MessageList,集成方法请参考文档 TUIKit SwiftUI 里的集成步骤。
17
+
18
+ ## 组件构成
19
+
20
+ MessageList 组件对外仅暴露了消息列表的初始化方法,其他逻辑均封装在 MessageList 中。
21
+
22
+ #### 对外方法
23
+ | 方法名 | 参数 | 描述 |
24
+ | --- | --- | --- |
25
+ | <code>init</code> | <code>conversationID: String</code> | 初始化组件,设置会话 ID。 |
26
+ | <code>config: MessageListConfigProtocol & MessageActionConfigProtocol = ChatMessageListConfig()</code> | 初始化组件,设置消息列表样式。 | |
27
+ | <code>locateMessage: MessageInfo? = nil</code> | 初始化组件,设置定位消息。通常用于从消息搜索结果页跳转消息页同时定位到目标消息。 | |
28
+ | <code>onUserClick: ((String) -> Void)? = nil</code> | 初始化组件,设置点击用户头像跳转响应事件。 | |
29
+ | <code>customActions: [MessageCustomAction] = []</code> | 初始化组件,设置自定义消息菜单选项。 | |
30
+
31
+ ## 基础用法
32
+
33
+ MessageList 组件可直接初始化使用,需要提供会话 ID。除此之外,我们还建议您在初始化方法中实现 onUserClick。
34
+ ``` swift
35
+ import AtomicX
36
+ import SwiftUI
37
+
38
+ struct ContentView: View {
39
+ var body: some View {
40
+ MessageList(
41
+ conversationID: "conversation_123",
42
+ onUserClick: { userID in
43
+ // 点击用户头像响应事件
44
+ }
45
+ )
46
+ }
47
+ }
48
+ ```
49
+
50
+ ## 自定义组件
51
+
52
+ 您可以自定义消息列表的样式和操作项。方法如下。
53
+
54
+ #### 自定义样式
55
+
56
+ 您可以实现 `MessageListConfigProtocol` 协议来创建完全自定义的样式:
57
+ ``` swift
58
+ struct MyCustomConfig: MessageListConfigProtocol & MessageActionConfigProtocol
59
+ {
60
+ let alignment: Int = 0
61
+ let isShowTimeMessage: Bool = true
62
+ let isShowLeftAvatar: Bool = true
63
+ let isShowLeftNickname: Bool = true
64
+ let isShowRightAvatar: Bool = true
65
+ let isShowRightNickname: Bool = true
66
+ let isSupportCopy: Bool = false
67
+ // ... 其他属性
68
+ }
69
+
70
+ // 使用自定义样式
71
+ MessageList(
72
+ conversationID: "conversation_123",
73
+ config: MyCustomConfig()
74
+ )
75
+ ```
76
+
77
+ `MessageListConfigProtocol` 协议属性说明:
78
+ | 属性名 | 类型 | 描述 | 备注 |
79
+ | --- | --- | --- | --- |
80
+ | <code>alignment</code> | <code>Int</code> | 消息对齐方式 | - 1: 左对齐<br>- 2: 右对齐<br>- 3: 左右对齐 |
81
+ | <code>isShowTimeMessage</code> | <code>Bool</code> | 是否显示时间消息 | 控制是否显示消息时间戳。 |
82
+ | <code>isShowLeftAvatar</code> | <code>Bool</code> | 是否显示左侧头像 | 控制接收消息时是否显示发送者头像。 |
83
+ | <code>isShowLeftNickname</code> | <code>Bool</code> | 是否显示左侧昵称 | 控制接收消息时是否显示发送者昵称。 |
84
+ | <code>isShowRightAvatar</code> | <code>Bool</code> | 是否显示右侧头像 | 控制发送消息时是否显示自己头像。 |
85
+ | <code>isShowRightNickname</code> | <code>Bool</code> | 是否显示右侧昵称 | 控制发送消息时是否显示自己昵称。 |
86
+ | <code>isShowTimeInBubble</code> | <code>Bool</code> | 是否在气泡内显示时间 | 控制时间戳是否显示在消息气泡内部。 |
87
+ | <code>cellSpacing</code> | <code>CGFloat</code> | 消息间距 | 控制相邻消息之间的间距。 |
88
+ | <code>isShowSystemMessage</code> | <code>Bool</code> | 是否显示系统消息 | 控制是否显示系统通知类消息。 |
89
+ | <code>isShowUnsupportMessage</code> | <code>Bool</code> | 是否显示不支持的消息 | 控制是否显示不支持类型的消息。 |
90
+ | <code>horizontalPadding</code> | <code>CGFloat</code> | 水平内边距 | 控制消息列表的左右内边距。 |
91
+ | <code>avatarSpacing</code> | <code>CGFloat</code> | 头像间距 | 控制头像与消息内容之间的间距。 |
92
+
93
+ `MessageActionConfigProtocol`协议属性说明:
94
+
95
+ |属性名|类型|描述|
96
+ |---------|---------|---------|
97
+ |`isSupportCopy`|`Bool`|消息操作菜单是否支持复制。|
98
+ |`isSupportDelete`|`Bool`|消息操作菜单是否支持删除。|
99
+ |`isSupportRecall`|`Bool`|消息操作菜单是否支持撤回。|
100
+
101
+ ### **自定义操作项**
102
+
103
+ 您可以采用多种方式自定义长按消息菜单项。
104
+
105
+ #### 方式 1. 局部显示操作项
106
+
107
+ 初始化 MessageList 时,通过设置 config 中的 `isSupportCopy`、`isSupportDelete`、`isSupportRecall`显示操作项:
108
+ ``` swift
109
+ struct CustomMessageView: View {
110
+ var body: some View {
111
+ MessageList(
112
+ conversationID: "conversation_123",
113
+ config: ChatMessageListConfig(isSupportCopy:false)
114
+ )
115
+ }
116
+ }
117
+ ```
118
+
119
+ #### 方式 2. 局部增加操作项
120
+
121
+ 初始化 MessageList 时传入 `customActions`,MessageList 内部会在默认的 action 底部添加您增加的自定义选项:
122
+ ``` swift
123
+ struct CustomMessageView: View {
124
+ var body: some View {
125
+ MessageList(
126
+ conversationID: "conversation_123",
127
+ // 新增自定义操作
128
+ customActions: [
129
+ MessageCustomAction(title: "Share", iconName: "forward_icon_figma", systemIconFallback: "square.and.arrow.up") { _ in
130
+ print("share Message")
131
+ }
132
+ ]
133
+ )
134
+ }
135
+ }
136
+ ```
137
+
138
+ #### **方式 3. 全局配置操作项**
139
+
140
+ 通过 `AppBuilderConfig` 进行全局配置:
141
+ ``` swift
142
+ // 在应用启动时配置
143
+ AppBuilderConfig.shared.messageActionList = [
144
+ .copy, // 支持复制
145
+ .delete, // 支持删除
146
+ .recall // 支持撤回
147
+ ]
148
+
149
+ // 接下来再初始化 MessageList,所有的 MessageList 都会遵守上面的配置
150
+ MessageList(
151
+ conversationID: "conversation_123"
152
+ )
153
+ ```
154
+
155
+ > **注意:**
156
+ >
157
+
158
+ > 局部配置的优先级大于全局配置。
159
+ >
160
+
161
+ 自定义效果如下图所示:
162
+ | 消息列表操作(默认选项) | 消息列表操作(隐藏<strong>复制</strong>选项) | 消息列表操作(新增<strong>分享</strong>选项) |
163
+ | --- | --- | --- |
164
+ | | | |