@tencent-rtc/mcp 1.3.9 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (431) hide show
  1. package/package.json +2 -2
  2. package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/android-faq.md} +10 -22
  3. package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/flutter-faq.md} +10 -22
  4. package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/ios-faq.md} +10 -22
  5. package/resource/doc/callkit/preset/android/api.md +296 -0
  6. package/resource/doc/{tuicallkit → callkit/preset}/android/integration.md +53 -365
  7. package/resource/doc/callkit/preset/flutter/api.md +410 -0
  8. package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +35 -97
  9. package/resource/doc/callkit/preset/ios/api.md +80 -0
  10. package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +37 -118
  11. package/resource/doc/callkit/preset/react/api.md +501 -0
  12. package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +5 -20
  13. package/resource/doc/callkit/preset/vue/api.md +501 -0
  14. package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +4 -19
  15. package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -38
  16. package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
  17. package/resource/doc/{chatuikit → chatkit}/android/integration.md +28 -121
  18. package/resource/doc/chatkit/faq/android_sdk/client-api.md +281 -0
  19. package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +0 -1
  20. package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -1
  21. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +199 -0
  22. package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
  23. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +235 -0
  24. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +3 -3
  25. package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
  26. package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +18 -87
  27. package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -38
  28. package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
  29. package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +47 -165
  30. package/resource/doc/{chatuikit → chatkit}/react/components/avatar.md +0 -33
  31. package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +8 -49
  32. package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +6 -35
  33. package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +0 -6
  34. package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -11
  35. package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +96 -502
  36. package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
  37. package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
  38. package/resource/doc/chatkit/react/components/conversation-preview.md +118 -0
  39. package/resource/doc/chatkit/react/components/conversation-search.md +60 -0
  40. package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -337
  41. package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +20 -212
  42. package/resource/doc/chatkit/react/components/search.md +243 -0
  43. package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +1 -47
  44. package/resource/doc/{chatuikit → chatkit}/react/integration.md +21 -81
  45. package/resource/doc/{chatuikit → chatkit}/vue/components/avatar.md +0 -33
  46. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -48
  47. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +3 -5
  48. package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +0 -5
  49. package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -15
  50. package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
  51. package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
  52. package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -492
  53. package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
  54. package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
  55. package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +2 -223
  56. package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -252
  57. package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
  58. package/resource/doc/{chatuikit → chatkit}/vue/components/tuikit.md +7 -21
  59. package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +3 -62
  60. package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
  61. package/resource/doc/{chatuikit → chatkit}/vue/integration.md +22 -23
  62. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +18 -89
  63. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
  64. package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +28 -141
  65. package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +20 -112
  66. package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +59 -193
  67. package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
  68. package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +94 -344
  69. package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +107 -515
  70. package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +33 -173
  71. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +14 -93
  72. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -179
  73. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +19 -107
  74. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -166
  75. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -163
  76. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +69 -443
  77. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
  78. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +107 -492
  79. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +23 -165
  80. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +35 -111
  81. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +35 -193
  82. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +31 -144
  83. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +24 -116
  84. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +37 -171
  85. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +79 -459
  86. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +69 -320
  87. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +85 -502
  88. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +32 -169
  89. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md +18 -89
  90. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audio-effect.md +34 -192
  91. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-barrage.md +28 -141
  92. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-co-guest-interaction.md +50 -259
  93. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-gift.md +75 -455
  94. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-host-interaction.md +51 -265
  95. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-integration.md +61 -427
  96. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-list.md +33 -173
  97. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-co-guest-interaction.md +44 -203
  98. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-integration.md +56 -416
  99. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audience-list.md +35 -111
  100. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audio-effect.md +35 -193
  101. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-barrage.md +31 -144
  102. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-co-guest-interaction.md +43 -252
  103. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-gift.md +79 -459
  104. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-host-interaction.md +46 -264
  105. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-integration.md +61 -445
  106. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-room-list.md +32 -169
  107. package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -2
  108. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
  109. package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
  110. package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +10 -49
  111. package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +26 -144
  112. package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +12 -75
  113. package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +36 -227
  114. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +215 -0
  115. package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
  116. package/resource/doc/livekit/preset/live/vue/live-list-integration.md +241 -0
  117. package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +299 -0
  118. package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +300 -0
  119. package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +743 -0
  120. package/resource/doc/roomkit/vue/faq.md +1 -0
  121. package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
  122. package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
  123. package/resource/doc/roomkit/vue/features/device-state.md +24 -44
  124. package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
  125. package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
  126. package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
  127. package/resource/doc/roomkit/vue/features/room-state.md +25 -34
  128. package/resource/doc/roomkit/vue/features/room-view.md +30 -125
  129. package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
  130. package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
  131. package/resource/doc/roomkit/vue/features/virtual-background.md +13 -29
  132. package/resource/doc/roomkit/vue/integration.md +21 -76
  133. package/resource/doc/rtcengine/faq/common/error_code.md +1 -0
  134. package/resource/doc/rtcengine/faq/web/web.md +14 -24
  135. package/resource/doc/rtcengine/web/api.md +1 -3
  136. package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +3 -10
  137. package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +1 -5
  138. package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +1 -2
  139. package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -4
  140. package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +3 -5
  141. package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +1 -7
  142. package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +0 -2
  143. package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -8
  144. package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +11 -11
  145. package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +12 -88
  146. package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -5
  147. package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +30 -37
  148. package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +13 -90
  149. package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -2
  150. package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +1 -2
  151. package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +19 -19
  152. package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
  153. package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -5
  154. package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
  155. package/resource/doc/trtc/C++/ITRTCCloud.md +686 -2835
  156. package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
  157. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +202 -1022
  158. package/resource/doc/trtc/C++/ITXDeviceManager.md +126 -767
  159. package/resource/doc/trtc/C++/TRTCCloudCallback.md +579 -2147
  160. package/resource/doc/trtc/C++/TRTCTypeDef.md +703 -3378
  161. package/resource/doc/trtc/C++/TXLiteAVCode.md +116 -908
  162. package/resource/doc/trtc/android/TRTCCloud.md +606 -2573
  163. package/resource/doc/trtc/android/TRTCCloudDef.md +752 -3640
  164. package/resource/doc/trtc/android/TRTCCloudListener.md +581 -2008
  165. package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
  166. package/resource/doc/trtc/android/TXAudioEffectManager.md +202 -1022
  167. package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
  168. package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
  169. package/resource/doc/trtc/android/TXLiteAVCode.md +114 -892
  170. package/resource/doc/trtc/iOS/TRTCCloud.md +694 -2904
  171. package/resource/doc/trtc/iOS/TRTCCloudDef.md +726 -3498
  172. package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +543 -2028
  173. package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
  174. package/resource/doc/trtc/iOS/TXAudioEffectManager.md +174 -877
  175. package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
  176. package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
  177. package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
  178. package/server.js +1 -5
  179. package/server.js.map +1 -1
  180. package/tools/call/get_callkit_api.js +32 -0
  181. package/tools/call/get_callkit_api.js.map +1 -0
  182. package/tools/call/get_native_call_uikit_integration.js +34 -0
  183. package/tools/call/get_native_call_uikit_integration.js.map +1 -0
  184. package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
  185. package/tools/call/get_web_call_uikit_integration.js.map +1 -0
  186. package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
  187. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
  188. package/tools/chat/get_native_chat_uikit_integration.js +45 -0
  189. package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
  190. package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
  191. package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
  192. package/tools/chat/get_web_chat_uikit_integration.js +45 -0
  193. package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
  194. package/tools/common/get_faq.js +265 -0
  195. package/tools/common/get_faq.js.map +1 -0
  196. package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
  197. package/tools/common/get_usersig.js.map +1 -0
  198. package/tools/common/present_framework_choice.js +63 -0
  199. package/tools/common/present_framework_choice.js.map +1 -0
  200. package/tools/definitions/get_callkit_api_def.js +29 -0
  201. package/tools/definitions/get_callkit_api_def.js.map +1 -0
  202. package/tools/definitions/get_faq_def.js +17 -18
  203. package/tools/definitions/get_faq_def.js.map +1 -1
  204. package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
  205. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  206. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
  207. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
  208. package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
  209. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  210. package/tools/definitions/get_native_livekit_core_features_def.js +34 -0
  211. package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
  212. package/tools/definitions/get_native_livekit_core_integration_def.js +34 -0
  213. package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
  214. package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
  215. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
  216. package/tools/definitions/get_usersig_def.js +17 -22
  217. package/tools/definitions/get_usersig_def.js.map +1 -1
  218. package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
  219. package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
  220. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
  221. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
  222. package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
  223. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  224. package/tools/definitions/get_web_live_uikit_integration_def.js +15 -18
  225. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
  226. package/tools/definitions/get_web_livekit_api_def.js +30 -0
  227. package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
  228. package/tools/definitions/get_web_livekit_component_detail_def.js +32 -0
  229. package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
  230. package/tools/definitions/get_web_room_uikit_integration_def.js +15 -46
  231. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  232. package/tools/definitions/get_web_roomkit_feature_detail_def.js +31 -0
  233. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
  234. package/tools/definitions/get_web_trtc_sdk_api_def.js +27 -0
  235. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
  236. package/tools/definitions/get_web_trtc_sdk_integration_def.js +27 -0
  237. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
  238. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +27 -0
  239. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
  240. package/tools/definitions/present_framework_choice_def.js +24 -12
  241. package/tools/definitions/present_framework_choice_def.js.map +1 -1
  242. package/tools/index.js +47 -61
  243. package/tools/index.js.map +1 -1
  244. package/tools/live/get_native_livekit_core_features.js +65 -0
  245. package/tools/live/get_native_livekit_core_features.js.map +1 -0
  246. package/tools/live/get_native_livekit_core_integration.js +59 -0
  247. package/tools/live/get_native_livekit_core_integration.js.map +1 -0
  248. package/tools/live/get_web_live_uikit_integration.js +48 -0
  249. package/tools/live/get_web_live_uikit_integration.js.map +1 -0
  250. package/tools/live/get_web_livekit_api.js +32 -0
  251. package/tools/live/get_web_livekit_api.js.map +1 -0
  252. package/tools/live/get_web_livekit_component_detail.js +34 -0
  253. package/tools/live/get_web_livekit_component_detail.js.map +1 -0
  254. package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
  255. package/tools/room/get_web_room_uikit_integration.js.map +1 -0
  256. package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
  257. package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
  258. package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
  259. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
  260. package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
  261. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
  262. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
  263. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
  264. package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
  265. package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
  266. package/utils/generate-structured-result.js +61 -17
  267. package/utils/generate-structured-result.js.map +1 -1
  268. package/utils/report-cls-client.js +12 -1
  269. package/utils/report-cls-client.js.map +1 -1
  270. package/utils/report-es-client.js +2 -2
  271. package/resource/doc/chatuikit/android/workflow.md +0 -713
  272. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1371
  273. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -932
  274. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1119
  275. package/resource/doc/chatuikit/flutter/workflow.md +0 -941
  276. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -1017
  277. package/resource/doc/chatuikit/react/components/search.md +0 -745
  278. package/resource/doc/chatuikit/react/create-group.md +0 -23
  279. package/resource/doc/chatuikit/react/init.md +0 -26
  280. package/resource/doc/chatuikit/react/workflow.md +0 -258
  281. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  282. package/resource/doc/chatuikit/vue/create-group.md +0 -25
  283. package/resource/doc/chatuikit/vue/init.md +0 -40
  284. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  285. package/resource/doc/livekit/live/android/workflow.md +0 -320
  286. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  287. package/resource/doc/livekit/live/ios/workflow.md +0 -454
  288. package/resource/doc/livekit/live/vue/components/barrage.md +0 -616
  289. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -446
  290. package/resource/doc/livekit/live/vue/faq.md +0 -0
  291. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -200
  292. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -269
  293. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -269
  294. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -595
  295. package/resource/doc/livekit/live/vue/states/live-state.md +0 -3591
  296. package/resource/doc/livekit/live/vue/workflow.md +0 -218
  297. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -312
  298. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -430
  299. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -679
  300. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -671
  301. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -271
  302. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  303. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  304. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  305. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  306. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -865
  307. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -657
  308. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -437
  309. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -335
  310. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  311. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -327
  312. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -507
  313. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  314. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -659
  315. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  316. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -814
  317. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1000
  318. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  319. package/resource/doc/roomkit/vue/workflow.md +0 -733
  320. package/resource/doc/tuicallkit/android/workflow.md +0 -441
  321. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -784
  322. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -610
  323. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -938
  324. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -897
  325. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -469
  326. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -781
  327. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -398
  328. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  329. package/resource/doc/tuicallkit/react/api.md +0 -1404
  330. package/resource/doc/tuicallkit/vue/api.md +0 -1406
  331. package/resource/doc/tuicallkit/vue/faq.md +0 -36
  332. package/tools/call/get-native-call-integration.js +0 -43
  333. package/tools/call/get-native-call-integration.js.map +0 -1
  334. package/tools/call/get-web-call-api.js +0 -27
  335. package/tools/call/get-web-call-api.js.map +0 -1
  336. package/tools/call/get-web-call-integration.js.map +0 -1
  337. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  338. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  339. package/tools/chat/get-native-chat-integration.js +0 -45
  340. package/tools/chat/get-native-chat-integration.js.map +0 -1
  341. package/tools/chat/get-web-chat-component-detail.js +0 -31
  342. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  343. package/tools/chat/get-web-chat-integration.js +0 -45
  344. package/tools/chat/get-web-chat-integration.js.map +0 -1
  345. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  346. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  347. package/tools/chat/get-web-create-group-doc.js +0 -28
  348. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  349. package/tools/common/get-faq.js +0 -91
  350. package/tools/common/get-faq.js.map +0 -1
  351. package/tools/common/get-usersig.js.map +0 -1
  352. package/tools/common/present-framework-choice.js +0 -16
  353. package/tools/common/present-framework-choice.js.map +0 -1
  354. package/tools/common/present-scenario-choice.js +0 -16
  355. package/tools/common/present-scenario-choice.js.map +0 -1
  356. package/tools/common/record-prompt.js +0 -55
  357. package/tools/common/record-prompt.js.map +0 -1
  358. package/tools/common/record-result.js +0 -60
  359. package/tools/common/record-result.js.map +0 -1
  360. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  361. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  362. package/tools/definitions/get_native_live_api_def.js +0 -23
  363. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  364. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -87
  365. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  366. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
  367. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  368. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
  369. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  370. package/tools/definitions/get_trtc_native_api_def.js +0 -16
  371. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  372. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  373. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  374. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  375. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  376. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  377. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  378. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  379. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  380. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  381. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  382. package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
  383. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  384. package/tools/definitions/get_web_room_state_detail_def.js +0 -19
  385. package/tools/definitions/get_web_room_state_detail_def.js.map +0 -1
  386. package/tools/definitions/present_scenario_choice_def.js +0 -53
  387. package/tools/definitions/present_scenario_choice_def.js.map +0 -1
  388. package/tools/definitions/record_prompt_def.js +0 -58
  389. package/tools/definitions/record_prompt_def.js.map +0 -1
  390. package/tools/definitions/record_result_def.js +0 -46
  391. package/tools/definitions/record_result_def.js.map +0 -1
  392. package/tools/live/get-native-live-uikit-integration.js +0 -177
  393. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  394. package/tools/live/get-web-live-component-detail.js +0 -31
  395. package/tools/live/get-web-live-component-detail.js.map +0 -1
  396. package/tools/live/get-web-live-state-detail.js +0 -31
  397. package/tools/live/get-web-live-state-detail.js.map +0 -1
  398. package/tools/live/get-web-live-uikit-integration.js +0 -52
  399. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  400. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  401. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  402. package/tools/live/get_native_live_uikit_interaction.js +0 -194
  403. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  404. package/tools/native_live/get-native-live-api.js +0 -31
  405. package/tools/native_live/get-native-live-api.js.map +0 -1
  406. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  407. package/tools/room/get-web-room-integration.js.map +0 -1
  408. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  409. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  410. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  411. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  412. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  413. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  414. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  415. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  416. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  417. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  418. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  419. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  420. package/tools/trtc/get-trtc-native-api.js +0 -31
  421. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  422. package/utils/handle-component-name.js +0 -33
  423. package/utils/handle-component-name.js.map +0 -1
  424. /package/resource/doc/{chatuikit/iOS/workflow.md → callkit/core-sdk/.gitkeep} +0 -0
  425. /package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +0 -0
  426. /package/resource/doc/{tuicallkit/react/faq.md → callkit/faq/web-faq.md} +0 -0
  427. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  428. /package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +0 -0
  429. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  430. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
  431. /package/resource/doc/roomkit/faq/common/{error_code.md → error-code.md} +0 -0
@@ -1,1017 +0,0 @@
1
- # Component Overview
2
-
3
-
4
- The `ConversationList` component is primarily responsible for the List function. It contains the Header part and List part, and has features such as conversation search, session creation, session pinning, and conversation deletion.
5
-
6
-
7
- This document introduces in detail the foundation usage, component customization, freely combine and the props parameter list of the component.
8
- <table>
9
- <tr>
10
- <td rowspan="1" colSpan="1" >**Conversation List**</td>
11
-
12
-
13
- <td rowspan="1" colSpan="1" >**Session Operation**</td>
14
-
15
-
16
- <td rowspan="1" colSpan="1" >**Conversation Search**</td>
17
-
18
-
19
- <td rowspan="1" colSpan="1" >**Create Session**</td>
20
- </tr>
21
-
22
-
23
- <tr>
24
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/c36abe657b2211ef82535254002693fd.png)</td>
25
-
26
-
27
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/9b217da57b2211ef852f52540075b605.png)</td>
28
-
29
-
30
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/d90a84b27b2211efa87a525400bdab9d.png)</td>
31
-
32
-
33
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/07c380377b2311efa87e52540055f650.png)</td>
34
- </tr>
35
- </table>
36
-
37
-
38
-
39
-
40
- ## Component composition
41
-
42
-
43
- The `ConversationList` component contains the following content:
44
- -`ConversationSearch` - Conversation Search
45
-
46
-
47
- - `ConversationList UI` - Conversation List Container
48
-
49
-
50
- - `ConversationPreview` - Show Session Information
51
-
52
-
53
- - `ConversationActions` - Conversation Action
54
-
55
-
56
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/6346335903ce11f0ae895254005ef0f7.png)
57
-
58
-
59
-
60
-
61
- ## Basic usage
62
-
63
-
64
- The `ConversationList` component has no required properties. You can use `ConversationList` with the following code.
65
- ``` typescript
66
- import { UIKitProvider, ConversationList } from '@tencentcloud/chat-uikit-react';
67
-
68
-
69
- const App = () => {
70
- return (
71
- <UIKitProvider>
72
- <ConversationList />
73
- </UIKitProvider>
74
- );
75
- };
76
- ```
77
-
78
-
79
- ## Custom components
80
-
81
-
82
- `ConversationList` provides various dimensional Props APIs for user customization, allowing users to customize features, UI, modules and more.
83
-
84
-
85
- The `ConversationList` component provides multiple replaceable subcomponents, allowing users to customize `Header`, `List`, `ConversationPreview`, `ConversationCreate`, `ConversationSearch`, `ConversationActions`, `Avatar`, `Placeholder`, and more. Meanwhile, users can also use default subcomponents for secondary development customization.
86
-
87
-
88
- ### Basic feature switch
89
-
90
-
91
- By setting the `enableSearch`, `enableCreate`, and `enableActions` parameters, you can flexibly control the display of conversation search, session creation, and conversation action features in `ConversationList`.
92
- ``` typescript
93
- <ConversationList enableSearch={false} />
94
- ```
95
- ``` typescript
96
- <ConversationList enableCreate={false} />
97
- ```
98
- ``` typescript
99
- <ConversationList enableActions={false} />
100
- ```
101
- <table>
102
- <tr>
103
- <td rowspan="1" colSpan="1" >`enableSearch={false}`</td>
104
-
105
-
106
- <td rowspan="1" colSpan="1" >`enableCreate={false}`</td>
107
-
108
-
109
- <td rowspan="1" colSpan="1" >`enableActions={false}`</td>
110
- </tr>
111
-
112
-
113
- <tr>
114
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/04e7a7b87b2411efa87a525400bdab9d.png)</td>
115
-
116
-
117
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/04eb02137b2411ef82535254002693fd.png)</td>
118
-
119
-
120
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/04e843b67b2411ef8829525400fdb830.png)</td>
121
- </tr>
122
- </table>
123
-
124
-
125
-
126
-
127
- ### Data filtering and sorting
128
-
129
-
130
- The `ConversationList` component provides the `filterConversation` and `sortConversation` properties, allowing you to filter and sort the conversation list data.
131
-
132
-
133
- #### Filter conversations
134
-
135
-
136
- To filter conversation list data, you can pass a filter function to the `filterConversation` property. This function receives an array of `ConversationModel` as parameter and should return a new array that only contains conversations meeting your filter criteria.
137
-
138
-
139
- Here is an example of using the `filterConversation` property to only display conversations with "unread messages":
140
- ``` typescript
141
- import { ConversationList } from '@tencentcloud/chat-uikit-react';
142
- import type { ConversationModel } from '@tencentcloud/chat-uikit-react';
143
-
144
-
145
- <ConversationList
146
- filter={(conversationList: ConversationModel[]) =>
147
- conversationList.filter(conversation => conversation.unreadCount > 0)}
148
- />
149
- ```
150
-
151
-
152
- #### Sort conversations
153
-
154
-
155
- To sort conversation list data, you can pass a sorting function to the `sortConversation` property. This function receives an array of `ConversationModel` as parameter and should return a new array with sessions sorted by your sorting criteria.
156
-
157
-
158
- Here is an example of using the `sortConversation` property to sort the session list by "latest news time" in descending order:
159
- ``` typescript
160
- import { ConversationList } from '@tencentcloud/chat-uikit-react';
161
- import type { ConversationModel } from '@tencentcloud/chat-uikit-react';
162
-
163
-
164
- <ConversationList
165
- sort={(conversationList: ConversationModel[]) =>
166
- conversationList.sort(
167
- (a, b) => (+(b?.lastMessage?.lastTime || 0)) - (+(a?.lastMessage?.lastTime || 0)),
168
- )}
169
- />
170
- ```
171
-
172
-
173
- By using the `filter` and `sort` properties, you can effectively filter and sort the conversation list data according to your needs.
174
-
175
-
176
- ### Custom actionsConfig
177
-
178
-
179
- Leverages [actionsConfig](https://write.woa.com/document/157860973841612800) to control the basic feature of ConversationActions.
180
-
181
-
182
- For more customization, see the [ConversationActions](https://write.woa.com/document/157860973841612800) chapter.
183
- ``` typescript
184
- import { ConversationList } from '@tencentcloud/chat-uikit-react';
185
- import type { ConversationModel } from '@tencentcloud/chat-uikit-react';
186
-
187
-
188
- <ConversationList
189
- actionsConfig={{
190
- enablePin: false,
191
- onConversationDelete: (conversation: ConversationModel) => { console.log('Delete conversation success'); },
192
- customConversationActions: {
193
- 'custom-actions-1': {
194
- label: 'custom-actions',
195
- onClick: (conversation: ConversationModel) => { console.log(conversation); },
196
- },
197
- },
198
- }}
199
- />
200
- ```
201
- <table>
202
- <tr>
203
- <td rowspan="1" colSpan="1" >`enablePin: false`</td>
204
-
205
-
206
- <td rowspan="1" colSpan="1" >`enableDelete: false`</td>
207
-
208
-
209
- <td rowspan="1" colSpan="1" >`enableMute: false`</td>
210
-
211
-
212
- <td rowspan="1" colSpan="1" >`customConversationActions`</td>
213
- </tr>
214
-
215
-
216
- <tr>
217
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/adaf4f4c7b4211efa87e52540055f650.png)</td>
218
-
219
-
220
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/d05321b37b4211ef82535254002693fd.png)</td>
221
-
222
-
223
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/e45d60e87b4211ef8829525400fdb830.png)</td>
224
-
225
-
226
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/fd8cbea27b4211efb9d8525400f69702.png)</td>
227
- </tr>
228
- </table>
229
-
230
-
231
-
232
-
233
- ### Custom Placeholder
234
-
235
-
236
- You can customize the list display in different statuses by importing `PlaceholderEmptyList`, `PlaceholderLoading`, and `PlaceholderLoadError`.
237
-
238
-
239
- Here is a custom `PlaceholderLoading` example:
240
- ``` typescript
241
- import { ConversationList } from '@tencentcloud/chat-uikit-react';
242
-
243
-
244
- <ConversationList
245
- PlaceholderEmptyList={<div>Empty List!!!</div>}
246
- />
247
- ```
248
-
249
-
250
- ### Custom Header
251
-
252
-
253
- `ConversationListHeader` is responsible for rendering the header part of `ConversationList`, serving as a wrapping layer to render the default `ConversationSearch` and `ConversationCreate`. You can customize it by importing left, right and other attributes, and you can also customize the entire component.
254
-
255
-
256
- #### Props
257
- <table>
258
- <tr>
259
- <td rowspan="1" colSpan="1" >**Parameter Name**</td>
260
-
261
-
262
- <td rowspan="1" colSpan="1" >**Type**</td>
263
-
264
-
265
- <td rowspan="1" colSpan="1" >**Default Value**</td>
266
-
267
-
268
- <td rowspan="1" colSpan="1" >**Description**</td>
269
- </tr>
270
-
271
-
272
- <tr>
273
- <td rowspan="1" colSpan="1" >children</td>
274
-
275
-
276
- <td rowspan="1" colSpan="1" >`ReactNode`</td>
277
-
278
-
279
- <td rowspan="1" colSpan="1" >-</td>
280
-
281
-
282
- <td rowspan="1" colSpan="1" >Custom session list header center component.<br>When used in `<ConversationList>`, it imports `<ConversationSearch>` and `<ConversationCreate>` by default.</td>
283
- </tr>
284
-
285
-
286
- <tr>
287
- <td rowspan="1" colSpan="1" >left</td>
288
-
289
-
290
- <td rowspan="1" colSpan="1" >`ReactElement`</td>
291
-
292
-
293
- <td rowspan="1" colSpan="1" >-</td>
294
-
295
-
296
- <td rowspan="1" colSpan="1" >Custom session list header left-side component.</td>
297
- </tr>
298
-
299
-
300
- <tr>
301
- <td rowspan="1" colSpan="1" >right</td>
302
-
303
-
304
- <td rowspan="1" colSpan="1" >`ReactElement`</td>
305
-
306
-
307
- <td rowspan="1" colSpan="1" >-</td>
308
-
309
-
310
- <td rowspan="1" colSpan="1" >Custom session list header right-side component.</td>
311
- </tr>
312
-
313
-
314
- <tr>
315
- <td rowspan="1" colSpan="1" >className</td>
316
-
317
-
318
- <td rowspan="1" colSpan="1" >`String`</td>
319
-
320
-
321
- <td rowspan="1" colSpan="1" >-</td>
322
-
323
-
324
- <td rowspan="1" colSpan="1" >Specify the custom name for the root element's CSS class.</td>
325
- </tr>
326
-
327
-
328
- <tr>
329
- <td rowspan="1" colSpan="1" >style</td>
330
-
331
-
332
- <td rowspan="1" colSpan="1" >`React.CSSProperties`</td>
333
-
334
-
335
- <td rowspan="1" colSpan="1" >-</td>
336
-
337
-
338
- <td rowspan="1" colSpan="1" >Specify the custom style for the root element.</td>
339
- </tr>
340
- </table>
341
-
342
-
343
- ### Basic customization
344
-
345
-
346
- Here is an example of adding a new function button on the right side of the Header Component.
347
- ``` typescript
348
- import {
349
- ConversationList,
350
- ConversationListHeader,
351
- } from '@tencentcloud/chat-uikit-react';
352
- import type { ConversationListHeaderProps } from '@tencentcloud/chat-uikit-react';
353
-
354
-
355
- const CustomConversationListHeader = (props: ConversationListHeaderProps) => {
356
- const CustomIcon = <div>Custom Icon</div>;
357
- return (
358
- <ConversationListHeader {...props} right={CustomIcon} />
359
- );
360
- };
361
-
362
- <ConversationList Header={CustomConversationListHeader} />
363
- ```
364
-
365
-
366
- #### Advanced customization
367
-
368
-
369
- Here is how to implement a simplified conversation grouping feature, distinguishing by All conversations, unread conversations, one-on-one chat sessions, and group chats across four key dimensions. Click different group buttons to execute different filtering rules.
370
- <table>
371
- <tr>
372
- <td rowspan="1" colSpan="1" >**Before modification**</td>
373
-
374
-
375
- <td rowspan="1" colSpan="1" >**Modified**</td>
376
- </tr>
377
-
378
-
379
- <tr>
380
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/d55e54fb7b3511ef852f52540075b605.png)</td>
381
-
382
-
383
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/7eaf71657b3511efa87a525400bdab9d.png)![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/8d7252bc7b3511efa87a525400bdab9d.png)![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/aad34b767b3511ef80ff525400d5f8ef.png)![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/bd04478f7b3511ef852f52540075b605.png)</td>
384
- </tr>
385
- </table>
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
- [React]
395
- ``` typescript
396
- import { useState } from 'react';
397
- import TUIChatEngine from '@tencentcloud/chat-uikit-engine';
398
- import { ConversationList, UIKitProvider } from '@tencentcloud/chat-uikit-react';
399
- import type { ConversationListHeaderProps, ConversationModel } from '@tencentcloud/chat-uikit-react';
400
-
401
-
402
- const App = () => {
403
- const [currentFilter, setCurrentFilter] = useState<string>('all');
404
- const conversationGroupFilter: Record<string, (conversationList: ConversationModel[]) => ConversationModel[]> = {
405
- all: (conversationList: ConversationModel[]) => conversationList,
406
- unread: (conversationList: ConversationModel[]) => conversationList?.filter((item: ConversationModel) => item.unreadCount > 0),
407
- c2c: (conversationList: ConversationModel[]) => conversationList?.filter((item: ConversationModel) => item.type === TUIChatEngine.TYPES.CONV_C2C),
408
- group: (conversationList: ConversationModel[]) => conversationList?.filter((item: ConversationModel) => item.type === TUIChatEngine.TYPES.CONV_GROUP),
409
- };
410
-
411
-
412
- const CustomConversationListHeader = (props: IConversationListHeaderProps) => {
413
- return (
414
- <div className="conversation-group-wrapper">
415
- <button className={currentFilter === 'all' ? 'btn-active' : 'btn-default'} onClick={() => setCurrentFilter('all')}>All</button>
416
- <button className={currentFilter === 'unread' ? 'btn-active' : 'btn-default'} onClick={() => setCurrentFilter('unread')}>Unread</button>
417
- <button className={currentFilter === 'c2c' ? 'btn-active' : 'btn-default'} onClick={() => setCurrentFilter('c2c')}>C2C</button>
418
- <button className={currentFilter === 'group' ? 'btn-active' : 'btn-default'} onClick={() => setCurrentFilter('group')}>Group</button>
419
- </div>
420
- );
421
- };
422
-
423
-
424
- return (
425
- <UIKitProvider>
426
- <ConversationList
427
- style={{ maxWidth: '300px', height: '600px' }}
428
- Header={CustomConversationListHeader}
429
- filter={conversationGroupFilter[currentFilter]}
430
- />
431
- </UIKitProvider>
432
- );
433
- };
434
- ```
435
-
436
-
437
- [CSS]
438
- ``` scss
439
- .conversation-group-wrapper {
440
- display: flex;
441
- justify-content: space-around;
442
- align-items: center;
443
- margin: 10px;
444
- font-size: 14px;
445
- .btn-default{
446
- display: flex;
447
- padding: 5px 10px;
448
- border: 1px solid #b3b3b4;
449
- color: #3b3d43;
450
- background-color: transparent;
451
- border-radius: 2px;
452
- }
453
- .btn-active{
454
- display: flex;
455
- padding: 5px 10px;
456
- border: 1px solid #1c66e5;
457
- color: #1c66e5;
458
- background-color: transparent;
459
- border-radius: 2px;
460
- }
461
- }
462
- ```
463
-
464
-
465
- Custom List
466
-
467
-
468
- `ConversationListContent` is responsible for the rendering work of the main list part in `ConversationList`.
469
-
470
-
471
- Render the precomputed current session list `filteredAndSortedConversationList` from Context as the default wrapping layer.
472
-
473
-
474
- #### Props
475
- <table>
476
- <tr>
477
- <td rowspan="1" colSpan="1" >**Parameter Name**</td>
478
-
479
-
480
- <td rowspan="1" colSpan="1" >**Type**</td>
481
-
482
-
483
- <td rowspan="1" colSpan="1" >**Default Value**</td>
484
-
485
-
486
- <td rowspan="1" colSpan="1" >**Description**</td>
487
- </tr>
488
-
489
-
490
- <tr>
491
- <td rowspan="1" colSpan="1" >children</td>
492
-
493
-
494
- <td rowspan="1" colSpan="1" >`ReactNode`</td>
495
-
496
-
497
- <td rowspan="1" colSpan="1" >-</td>
498
-
499
-
500
- <td rowspan="1" colSpan="1" >Custom session list content area component.<br>When used in `<ConversationList>`, it imports the `<Preview>` list traversed by `filteredAndSortedConversationList` by default.</td>
501
- </tr>
502
-
503
-
504
- <tr>
505
- <td rowspan="1" colSpan="1" >empty</td>
506
-
507
-
508
- <td rowspan="1" colSpan="1" >`Boolean`</td>
509
-
510
-
511
- <td rowspan="1" colSpan="1" >`false`</td>
512
-
513
-
514
- <td rowspan="1" colSpan="1" >Conversation list identifier bit. When used in `<ConversationList>`, it judges `filteredAndSortedConversationList.length === 0` and imports it.</td>
515
- </tr>
516
-
517
-
518
- <tr>
519
- <td rowspan="1" colSpan="1" >loading</td>
520
-
521
-
522
- <td rowspan="1" colSpan="1" >`Boolean`</td>
523
-
524
-
525
- <td rowspan="1" colSpan="1" >`false`</td>
526
-
527
-
528
- <td rowspan="1" colSpan="1" >Conversation list loading flag bit. When used in `<ConversationList>`, it uses `useConversationList()` to get `isLoading` and imports it.</td>
529
- </tr>
530
-
531
-
532
- <tr>
533
- <td rowspan="1" colSpan="1" >error</td>
534
-
535
-
536
- <td rowspan="1" colSpan="1" >`Boolean`</td>
537
-
538
-
539
- <td rowspan="1" colSpan="1" >`false`</td>
540
-
541
-
542
- <td rowspan="1" colSpan="1" >Conversation list load error flag bit. When used in `<ConversationList>`, it uses `useConversationList()` to get `isLoadError` and imports it.</td>
543
- </tr>
544
-
545
-
546
- <tr>
547
- <td rowspan="1" colSpan="1" >PlaceholderEmptyList</td>
548
-
549
-
550
- <td rowspan="1" colSpan="1" >`ReactNode`</td>
551
-
552
-
553
- <td rowspan="1" colSpan="1" >`<PlaceHolder type={PlaceHolderTypes.NO_CONVERSATIONS} />`</td>
554
-
555
-
556
- <td rowspan="1" colSpan="1" >Placeholder element when the custom session list is empty.</td>
557
- </tr>
558
-
559
-
560
- <tr>
561
- <td rowspan="1" colSpan="1" >PlaceholderLoading</td>
562
-
563
-
564
- <td rowspan="1" colSpan="1" >`ReactNode`</td>
565
-
566
-
567
- <td rowspan="1" colSpan="1" >`<PlaceHolder type={PlaceHolderTypes.LOADING} />`</td>
568
-
569
-
570
- <td rowspan="1" colSpan="1" >Placeholder element for custom session list loading.</td>
571
- </tr>
572
-
573
-
574
- <tr>
575
- <td rowspan="1" colSpan="1" >PlaceholderLoadError</td>
576
-
577
-
578
- <td rowspan="1" colSpan="1" >`ReactNode`</td>
579
-
580
-
581
- <td rowspan="1" colSpan="1" >`<PlaceHolder type={PlaceHolderTypes.WRONG} />`</td>
582
-
583
-
584
- <td rowspan="1" colSpan="1" >Placeholder element for custom session list load error.</td>
585
- </tr>
586
-
587
-
588
- <tr>
589
- <td rowspan="1" colSpan="1" >className</td>
590
-
591
-
592
- <td rowspan="1" colSpan="1" >`String`</td>
593
-
594
-
595
- <td rowspan="1" colSpan="1" >-</td>
596
-
597
-
598
- <td rowspan="1" colSpan="1" >Specify the custom name for the root element's CSS class.</td>
599
- </tr>
600
-
601
-
602
- <tr>
603
- <td rowspan="1" colSpan="1" >style</td>
604
-
605
-
606
- <td rowspan="1" colSpan="1" >`React.CSSProperties`</td>
607
-
608
-
609
- <td rowspan="1" colSpan="1" >-</td>
610
-
611
-
612
- <td rowspan="1" colSpan="1" >Specify the custom style for the root element.</td>
613
- </tr>
614
- </table>
615
-
616
-
617
-
618
-
619
- Basic customization
620
-
621
-
622
- The UI effects of the `List` component in different statuses are as follows. The trigger timing for each state is handled inside the `ConversationList`.
623
-
624
-
625
- Meanwhile, you can control the component status through custom input of `empty`, `loading`, and `error`.
626
- ``` typescript
627
- import { ConversationList, ConversationListContent } from '@tencentcloud/chat-uikit-react';
628
- import type { ConversationListContentProps } from '@tencentcloud/chat-uikit-react';
629
-
630
-
631
- const CustomConversationListContent = (props: ConversationListContentProps) => {
632
- return <ConversationListContent {...props} loading={true} />;
633
- };
634
-
635
-
636
- <ConversationList List={CustomConversationListContent} />
637
- ```
638
- <table>
639
- <tr>
640
- <td rowspan="1" colSpan="1" >`default`</td>
641
-
642
-
643
- <td rowspan="1" colSpan="1" >`empty={true}`</td>
644
-
645
-
646
- <td rowspan="1" colSpan="1" >`loading={true}`</td>
647
-
648
-
649
- <td rowspan="1" colSpan="1" >`error={true}`</td>
650
- </tr>
651
-
652
-
653
- <tr>
654
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/672801bf7b3f11efa87e52540055f650.png)</td>
655
-
656
-
657
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/38392e897b3f11efb9d8525400f69702.png)</td>
658
-
659
-
660
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/4a40aeb27b3f11ef8631525400a9236a.png)</td>
661
-
662
-
663
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/5b245e9b7b3f11efb9d8525400f69702.png)</td>
664
- </tr>
665
- </table>
666
-
667
-
668
-
669
-
670
- Custom ConversationPreview
671
-
672
-
673
- For details, see the [ConversationPreview](https://write.woa.com/document/157860950620008448) chapter.
674
- ``` typescript
675
- <ConversationList ConversationPreview={CustomConversationPreview} />
676
- ```
677
-
678
-
679
- Custom ConversationActions
680
-
681
-
682
- For details, see the [ConversationActions](https://write.woa.com/document/157860973841612800) chapter.
683
- ``` typescript
684
- <ConversationList ConversationActions={CustomConversationActions} />
685
- ```
686
-
687
-
688
- Custom ConversationSearch
689
-
690
-
691
- For details, see the [ConversationSearch](https://write.woa.com/document/157860965047783424) chapter.
692
- ``` typescript
693
- <ConversationList ConversationSearch={CustomConversationSearch} />
694
- ```
695
-
696
-
697
- Create and Bind Policy Query Instance Reset Instance Access Password
698
- ``` typescript
699
- <ConversationList ConversationCreate={CustomConversationCreate} />
700
- ```
701
-
702
-
703
- Custom Avatar
704
- ``` typescript
705
- <ConversationList Avatar={CustomAvatar} />
706
- ```
707
-
708
-
709
- ## APIs/Props
710
- <table>
711
- <tr>
712
- <td rowspan="1" colSpan="1" >**Parameter Name**</td>
713
-
714
-
715
- <td rowspan="1" colSpan="1" >**Type**</td>
716
-
717
-
718
- <td rowspan="1" colSpan="1" >**Default Value**</td>
719
-
720
-
721
- <td rowspan="1" colSpan="1" >**Description**</td>
722
- </tr>
723
-
724
-
725
- <tr>
726
- <td rowspan="1" colSpan="1" >enableSearch</td>
727
-
728
-
729
- <td rowspan="1" colSpan="1" >`Boolean`</td>
730
-
731
-
732
- <td rowspan="1" colSpan="1" >`true`</td>
733
-
734
-
735
- <td rowspan="1" colSpan="1" >Whether to display the control session search feature.</td>
736
- </tr>
737
-
738
-
739
- <tr>
740
- <td rowspan="1" colSpan="1" >enableCreate</td>
741
-
742
-
743
- <td rowspan="1" colSpan="1" >`Boolean`</td>
744
-
745
-
746
- <td rowspan="1" colSpan="1" >`true`</td>
747
-
748
-
749
- <td rowspan="1" colSpan="1" >Whether to display the control session creation feature.</td>
750
- </tr>
751
-
752
-
753
- <tr>
754
- <td rowspan="1" colSpan="1" >enableActions</td>
755
-
756
-
757
- <td rowspan="1" colSpan="1" >`Boolean`</td>
758
-
759
-
760
- <td rowspan="1" colSpan="1" >`true`</td>
761
-
762
-
763
- <td rowspan="1" colSpan="1" >Whether to display the conversation action feature.</td>
764
- </tr>
765
-
766
-
767
- <tr>
768
- <td rowspan="1" colSpan="1" >actionsConfig</td>
769
-
770
-
771
- <td rowspan="1" colSpan="1" >`ConversationActionsConfig`</td>
772
-
773
-
774
- <td rowspan="1" colSpan="1" >-</td>
775
-
776
-
777
- <td rowspan="1" colSpan="1" >For custom session operation configuration.</td>
778
- </tr>
779
-
780
-
781
- <tr>
782
- <td rowspan="1" colSpan="1" >Header</td>
783
-
784
-
785
- <td rowspan="1" colSpan="1" >`ReactElement`</td>
786
-
787
-
788
- <td rowspan="1" colSpan="1" >`Header`</td>
789
-
790
-
791
- <td rowspan="1" colSpan="1" >Custom Header component.</td>
792
- </tr>
793
-
794
-
795
- <tr>
796
- <td rowspan="1" colSpan="1" >List</td>
797
-
798
-
799
- <td rowspan="1" colSpan="1" >`ReactElement`</td>
800
-
801
-
802
- <td rowspan="1" colSpan="1" >`List`</td>
803
-
804
-
805
- <td rowspan="1" colSpan="1" >Custom session list component.</td>
806
- </tr>
807
-
808
-
809
- <tr>
810
- <td rowspan="1" colSpan="1" >Preview</td>
811
-
812
-
813
- <td rowspan="1" colSpan="1" >`ReactElement`</td>
814
-
815
-
816
- <td rowspan="1" colSpan="1" >[ConversationPreview](https://write.woa.com/document/157860950620008448)</td>
817
-
818
-
819
- <td rowspan="1" colSpan="1" >Session preview component.</td>
820
- </tr>
821
-
822
-
823
- <tr>
824
- <td rowspan="1" colSpan="1" >ConversationCreate</td>
825
-
826
-
827
- <td rowspan="1" colSpan="1" >`ReactElement`</td>
828
-
829
-
830
- <td rowspan="1" colSpan="1" >`ConversationCreate`</td>
831
-
832
-
833
- <td rowspan="1" colSpan="1" >Custom conversation component.</td>
834
- </tr>
835
-
836
-
837
- <tr>
838
- <td rowspan="1" colSpan="1" >ConversationSearch</td>
839
-
840
-
841
- <td rowspan="1" colSpan="1" >`ReactElement`</td>
842
-
843
-
844
- <td rowspan="1" colSpan="1" >[ConversationSearch](https://write.woa.com/document/157860965047783424)</td>
845
-
846
-
847
- <td rowspan="1" colSpan="1" >Custom session search component.</td>
848
- </tr>
849
-
850
-
851
- <tr>
852
- <td rowspan="1" colSpan="1" >ConversationActions</td>
853
-
854
-
855
- <td rowspan="1" colSpan="1" >`ReactElement`</td>
856
-
857
-
858
- <td rowspan="1" colSpan="1" >[ConversationActions](https://write.woa.com/document/157860973841612800)</td>
859
-
860
-
861
- <td rowspan="1" colSpan="1" >Custom Conversation Operation Component.</td>
862
- </tr>
863
-
864
-
865
- <tr>
866
- <td rowspan="1" colSpan="1" >Avatar</td>
867
-
868
-
869
- <td rowspan="1" colSpan="1" >`ReactElement`</td>
870
-
871
-
872
- <td rowspan="1" colSpan="1" >`Avatar`</td>
873
-
874
-
875
- <td rowspan="1" colSpan="1" >Custom avatar component.</td>
876
- </tr>
877
-
878
-
879
- <tr>
880
- <td rowspan="1" colSpan="1" >PlaceholderEmptyList</td>
881
-
882
-
883
- <td rowspan="1" colSpan="1" >`ReactNode`</td>
884
-
885
-
886
- <td rowspan="1" colSpan="1" >`<PlaceHolder type={PlaceHolderTypes.NO_CONVERSATIONS} />`</td>
887
-
888
-
889
- <td rowspan="1" colSpan="1" >Placeholder element when the custom session list is empty.</td>
890
- </tr>
891
-
892
-
893
- <tr>
894
- <td rowspan="1" colSpan="1" >PlaceholderLoading</td>
895
-
896
-
897
- <td rowspan="1" colSpan="1" >`ReactNode`</td>
898
-
899
-
900
- <td rowspan="1" colSpan="1" >`<PlaceHolder type={PlaceHolderTypes.LOADING} />`</td>
901
-
902
-
903
- <td rowspan="1" colSpan="1" >Placeholder element for custom session list loading.</td>
904
- </tr>
905
-
906
-
907
- <tr>
908
- <td rowspan="1" colSpan="1" >PlaceholderLoadError</td>
909
-
910
-
911
- <td rowspan="1" colSpan="1" >`ReactNode`</td>
912
-
913
-
914
- <td rowspan="1" colSpan="1" >`<PlaceHolder type={PlaceHolderTypes.WRONG} />`</td>
915
-
916
-
917
- <td rowspan="1" colSpan="1" >Placeholder element for custom session list load error.</td>
918
- </tr>
919
-
920
-
921
- <tr>
922
- <td rowspan="1" colSpan="1" >filter</td>
923
-
924
-
925
- <td rowspan="1" colSpan="1" >`(conversationList: ConversationModel[]) => ConversationModel[]`</td>
926
-
927
-
928
- <td rowspan="1" colSpan="1" >-</td>
929
-
930
-
931
- <td rowspan="1" colSpan="1" >Functions for filtering session list.</td>
932
- </tr>
933
-
934
-
935
- <tr>
936
- <td rowspan="1" colSpan="1" >sort</td>
937
-
938
-
939
- <td rowspan="1" colSpan="1" >`(conversationList: ConversationModel[]) => ConversationModel[]`</td>
940
-
941
-
942
- <td rowspan="1" colSpan="1" >-</td>
943
-
944
-
945
- <td rowspan="1" colSpan="1" >Functions for sorting session list.</td>
946
- </tr>
947
-
948
-
949
- <tr>
950
- <td rowspan="1" colSpan="1" >onConversationSelect</td>
951
-
952
-
953
- <td rowspan="1" colSpan="1" >`(conversation: ConversationModel) => void;`</td>
954
-
955
-
956
- <td rowspan="1" colSpan="1" >-</td>
957
-
958
-
959
- <td rowspan="1" colSpan="1" >Callback function when clicking a session, with the clicked conversation object as parameter.</td>
960
- </tr>
961
-
962
-
963
- <tr>
964
- <td rowspan="1" colSpan="1" >onBeforeCreateConversation</td>
965
-
966
-
967
- <td rowspan="1" colSpan="1" >`(params: CreateParams) => CreateParams;`</td>
968
-
969
-
970
- <td rowspan="1" colSpan="1" >-</td>
971
-
972
-
973
- <td rowspan="1" colSpan="1" >Custom action executed before session creation, with required parameters for creating a session.</td>
974
- </tr>
975
-
976
-
977
- <tr>
978
- <td rowspan="1" colSpan="1" >onConversationCreate</td>
979
-
980
-
981
- <td rowspan="1" colSpan="1" >`(conversation: ConversationModel) => void;`</td>
982
-
983
-
984
- <td rowspan="1" colSpan="1" >-</td>
985
-
986
-
987
- <td rowspan="1" colSpan="1" >Callback function after session creation, with the created session object as parameter.</td>
988
- </tr>
989
-
990
-
991
- <tr>
992
- <td rowspan="1" colSpan="1" >className</td>
993
-
994
-
995
- <td rowspan="1" colSpan="1" >`String`</td>
996
-
997
-
998
- <td rowspan="1" colSpan="1" >-</td>
999
-
1000
-
1001
- <td rowspan="1" colSpan="1" >Specify the custom name for the root element's CSS class.</td>
1002
- </tr>
1003
-
1004
-
1005
- <tr>
1006
- <td rowspan="1" colSpan="1" >style</td>
1007
-
1008
-
1009
- <td rowspan="1" colSpan="1" >`React.CSSProperties`</td>
1010
-
1011
-
1012
- <td rowspan="1" colSpan="1" >-</td>
1013
-
1014
-
1015
- <td rowspan="1" colSpan="1" >Specify the custom style for the root element.</td>
1016
- </tr>
1017
- </table>