@tencentcloud/sdk-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 (510) hide show
  1. package/index.js +1 -1
  2. package/index.js.map +1 -1
  3. package/package.json +2 -2
  4. package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/android-faq.md} +75 -308
  5. package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +2 -2
  6. package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/flutter-faq.md} +83 -315
  7. package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/ios-faq.md} +76 -313
  8. package/resource/doc/{tuicallkit/vue/faq.md → callkit/faq/web-faq.md} +78 -311
  9. package/resource/doc/callkit/preset/android/api.md +330 -0
  10. package/resource/doc/{tuicallkit → callkit/preset}/android/integration.md +63 -420
  11. package/resource/doc/callkit/preset/flutter/api.md +401 -0
  12. package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +53 -273
  13. package/resource/doc/callkit/preset/ios/api.md +282 -0
  14. package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +39 -120
  15. package/resource/doc/callkit/preset/react/api.md +600 -0
  16. package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +6 -6
  17. package/resource/doc/callkit/preset/vue/api.md +600 -0
  18. package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +5 -5
  19. package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -37
  20. package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
  21. package/resource/doc/{chatuikit → chatkit}/android/integration.md +30 -126
  22. package/resource/doc/chatkit/faq/android_sdk/client-api.md +280 -0
  23. package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +4 -17
  24. package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -2
  25. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +183 -0
  26. package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
  27. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +279 -0
  28. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +1 -1
  29. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +4 -4
  30. package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
  31. package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +20 -95
  32. package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -37
  33. package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
  34. package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +78 -280
  35. package/resource/doc/{chatuikit/vue → chatkit/react}/components/avatar.md +0 -1
  36. package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +7 -12
  37. package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +10 -17
  38. package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +1 -1
  39. package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -1
  40. package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +122 -703
  41. package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
  42. package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
  43. package/resource/doc/chatkit/react/components/conversation-preview.md +116 -0
  44. package/resource/doc/chatkit/react/components/conversation-search.md +57 -0
  45. package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -186
  46. package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +21 -113
  47. package/resource/doc/chatkit/react/components/search.md +282 -0
  48. package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +5 -26
  49. package/resource/doc/{chatuikit → chatkit}/react/integration.md +37 -104
  50. package/resource/doc/{chatuikit/react → chatkit/vue}/components/avatar.md +0 -1
  51. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -13
  52. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +13 -18
  53. package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +1 -2
  54. package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -1
  55. package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
  56. package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
  57. package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -316
  58. package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
  59. package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
  60. package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +1 -23
  61. package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -134
  62. package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
  63. package/resource/doc/chatkit/vue/components/tuikit.md +45 -0
  64. package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +4 -4
  65. package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
  66. package/resource/doc/{chatuikit → chatkit}/vue/integration.md +53 -121
  67. package/resource/doc/livekit/core-sdk/live/android/api-reference/AudioEffectStore.md +283 -0
  68. package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +148 -0
  69. package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +316 -0
  70. package/resource/doc/livekit/core-sdk/live/android/api-reference/CameraView.md +57 -0
  71. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +419 -0
  72. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +325 -0
  73. package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +436 -0
  74. package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +165 -0
  75. package/resource/doc/livekit/core-sdk/live/android/api-reference/LikeStore.md +49 -0
  76. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +239 -0
  77. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +74 -0
  78. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +417 -0
  79. package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +207 -0
  80. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +17 -88
  81. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
  82. package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +26 -139
  83. package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +16 -99
  84. package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +54 -161
  85. package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
  86. package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +91 -338
  87. package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +108 -492
  88. package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +27 -165
  89. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/AudioEffectStore.md +279 -0
  90. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +158 -0
  91. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BaseBeautyStore.md +155 -0
  92. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +304 -0
  93. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +394 -0
  94. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +303 -0
  95. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +410 -0
  96. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +160 -0
  97. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LikeStore.md +51 -0
  98. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +231 -0
  99. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveCoreView.md +143 -0
  100. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +375 -0
  101. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +170 -0
  102. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +13 -91
  103. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -177
  104. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +18 -102
  105. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -164
  106. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -161
  107. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +66 -460
  108. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
  109. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +160 -543
  110. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +22 -161
  111. package/resource/doc/livekit/core-sdk/live/ios/api-reference/AudioEffectStore.md +287 -0
  112. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +165 -0
  113. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +143 -0
  114. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +298 -0
  115. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +349 -0
  116. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +297 -0
  117. package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +471 -0
  118. package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +179 -0
  119. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LikeStore.md +49 -0
  120. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +238 -0
  121. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +74 -0
  122. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +412 -0
  123. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +173 -0
  124. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +23 -96
  125. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +33 -195
  126. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +35 -150
  127. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +20 -105
  128. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +35 -140
  129. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +77 -457
  130. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +70 -317
  131. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +90 -473
  132. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +28 -163
  133. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md +17 -88
  134. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audio-effect.md +34 -192
  135. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-barrage.md +26 -139
  136. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-co-guest-interaction.md +53 -262
  137. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-gift.md +75 -455
  138. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-host-interaction.md +60 -272
  139. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-integration.md +63 -440
  140. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-list.md +23 -151
  141. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audience-list.md +13 -91
  142. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audio-effect.md +34 -177
  143. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-barrage.md +18 -102
  144. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-co-guest-interaction.md +44 -201
  145. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-gift.md +66 -460
  146. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-integration.md +57 -419
  147. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-room-list.md +24 -157
  148. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audience-list.md +23 -96
  149. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audio-effect.md +33 -195
  150. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-barrage.md +35 -150
  151. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-co-guest-interaction.md +45 -254
  152. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-gift.md +77 -457
  153. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-host-interaction.md +52 -261
  154. package/resource/doc/livekit/core-sdk/voice/ios/voice-integration.md +478 -0
  155. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-room-list.md +36 -167
  156. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audience-list.md +15 -45
  157. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audio-effect.md +23 -137
  158. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-barrage.md +25 -131
  159. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-co-guest-interaction.md +70 -366
  160. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-gift.md +70 -424
  161. package/resource/doc/livekit/core-sdk/voice/uni-app/voice-integration.md +323 -0
  162. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-room-list.md +24 -116
  163. package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -3
  164. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
  165. package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
  166. package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +9 -48
  167. package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +27 -145
  168. package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +13 -76
  169. package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +33 -224
  170. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +211 -0
  171. package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
  172. package/resource/doc/livekit/preset/live/vue/live-list-integration.md +244 -0
  173. package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +301 -0
  174. package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +307 -0
  175. package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +754 -0
  176. package/resource/doc/roomkit/android/features/call-user-to-room.md +234 -0
  177. package/resource/doc/roomkit/android/features/room-participant-state.md +850 -0
  178. package/resource/doc/roomkit/android/features/room-state.md +358 -0
  179. package/resource/doc/roomkit/android/features/schedule-room.md +336 -0
  180. package/resource/doc/roomkit/android/integration.md +433 -0
  181. package/resource/doc/roomkit/{common/error_code.md → faq/common/error-code.md} +1 -1
  182. package/resource/doc/roomkit/flutter/features/call-user-to-room.md +228 -0
  183. package/resource/doc/roomkit/flutter/features/room-participant-state.md +796 -0
  184. package/resource/doc/roomkit/flutter/features/room-state.md +324 -0
  185. package/resource/doc/roomkit/flutter/features/schedule-room.md +324 -0
  186. package/resource/doc/roomkit/flutter/integration.md +405 -0
  187. package/resource/doc/roomkit/ios/features/call-user-to-room.md +226 -0
  188. package/resource/doc/roomkit/ios/features/room-participant-state.md +821 -0
  189. package/resource/doc/roomkit/ios/features/room-state.md +320 -0
  190. package/resource/doc/roomkit/ios/features/schedule-room.md +318 -0
  191. package/resource/doc/roomkit/ios/integration.md +384 -0
  192. package/resource/doc/roomkit/vue/faq.md +1 -0
  193. package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
  194. package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
  195. package/resource/doc/roomkit/vue/features/device-state.md +24 -44
  196. package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
  197. package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
  198. package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
  199. package/resource/doc/roomkit/vue/features/room-state.md +25 -36
  200. package/resource/doc/roomkit/vue/features/room-view.md +30 -127
  201. package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
  202. package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
  203. package/resource/doc/roomkit/vue/features/virtual-background.md +13 -34
  204. package/resource/doc/roomkit/vue/integration.md +21 -80
  205. package/resource/doc/rtcengine/faq/common/userSig.md +17 -141
  206. package/resource/doc/rtcengine/faq/web/web.md +15 -22
  207. package/resource/doc/rtcengine/web/api.md +17 -21
  208. package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +4 -10
  209. package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +4 -8
  210. package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +3 -3
  211. package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -3
  212. package/resource/doc/rtcengine/web/plugin/22-advanced-audio-mixer.md +6 -6
  213. package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +2 -2
  214. package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +2 -4
  215. package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +1 -2
  216. package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +2 -6
  217. package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +13 -14
  218. package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +10 -90
  219. package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -8
  220. package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +31 -35
  221. package/resource/doc/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -2
  222. package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +7 -49
  223. package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -1
  224. package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -3
  225. package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +20 -20
  226. package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
  227. package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -4
  228. package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
  229. package/resource/doc/trtc/C++/ITRTCCloud.md +718 -2847
  230. package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
  231. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +207 -1041
  232. package/resource/doc/trtc/C++/ITXDeviceManager.md +127 -768
  233. package/resource/doc/trtc/C++/TRTCCloudCallback.md +634 -2259
  234. package/resource/doc/trtc/C++/TRTCTypeDef.md +726 -3465
  235. package/resource/doc/trtc/C++/TXLiteAVCode.md +117 -916
  236. package/resource/doc/trtc/android/TRTCCloud.md +638 -2612
  237. package/resource/doc/trtc/android/TRTCCloudDef.md +769 -3697
  238. package/resource/doc/trtc/android/TRTCCloudListener.md +609 -2070
  239. package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
  240. package/resource/doc/trtc/android/TXAudioEffectManager.md +207 -1049
  241. package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
  242. package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
  243. package/resource/doc/trtc/android/TXLiteAVCode.md +115 -900
  244. package/resource/doc/trtc/iOS/TRTCCloud.md +726 -2930
  245. package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +580 -2099
  246. package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
  247. package/resource/doc/trtc/iOS/TXAudioEffectManager.md +179 -896
  248. package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
  249. package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
  250. package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
  251. package/resource/doc/trtc/iOS/TXLiveSDKTypeDef.md +747 -3559
  252. package/server.js +1 -5
  253. package/server.js.map +1 -1
  254. package/tools/call/get_callkit_api.js +32 -0
  255. package/tools/call/get_callkit_api.js.map +1 -0
  256. package/tools/call/get_native_call_uikit_integration.js +34 -0
  257. package/tools/call/get_native_call_uikit_integration.js.map +1 -0
  258. package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
  259. package/tools/call/get_web_call_uikit_integration.js.map +1 -0
  260. package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
  261. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
  262. package/tools/chat/get_native_chat_uikit_integration.js +45 -0
  263. package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
  264. package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
  265. package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
  266. package/tools/chat/get_web_chat_uikit_integration.js +45 -0
  267. package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
  268. package/tools/common/get_faq.js +265 -0
  269. package/tools/common/get_faq.js.map +1 -0
  270. package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
  271. package/tools/common/get_usersig.js.map +1 -0
  272. package/tools/common/present_framework_choice.js +63 -0
  273. package/tools/common/present_framework_choice.js.map +1 -0
  274. package/tools/definitions/get_callkit_api_def.js +28 -0
  275. package/tools/definitions/get_callkit_api_def.js.map +1 -0
  276. package/tools/definitions/get_faq_def.js +18 -19
  277. package/tools/definitions/get_faq_def.js.map +1 -1
  278. package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
  279. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  280. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
  281. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
  282. package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
  283. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  284. package/tools/definitions/get_native_livekit_core_features_def.js +33 -0
  285. package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
  286. package/tools/definitions/get_native_livekit_core_integration_def.js +33 -0
  287. package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
  288. package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
  289. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
  290. package/tools/definitions/get_usersig_def.js +17 -24
  291. package/tools/definitions/get_usersig_def.js.map +1 -1
  292. package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
  293. package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
  294. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
  295. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
  296. package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
  297. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  298. package/tools/definitions/get_web_live_uikit_integration_def.js +13 -18
  299. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
  300. package/tools/definitions/get_web_livekit_api_def.js +27 -0
  301. package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
  302. package/tools/definitions/get_web_livekit_component_detail_def.js +29 -0
  303. package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
  304. package/tools/definitions/get_web_room_uikit_integration_def.js +13 -46
  305. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  306. package/tools/definitions/get_web_roomkit_feature_detail_def.js +30 -0
  307. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
  308. package/tools/definitions/get_web_trtc_sdk_api_def.js +25 -0
  309. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
  310. package/tools/definitions/get_web_trtc_sdk_integration_def.js +25 -0
  311. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
  312. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +25 -0
  313. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
  314. package/tools/definitions/present_framework_choice_def.js +23 -12
  315. package/tools/definitions/present_framework_choice_def.js.map +1 -1
  316. package/tools/index.js +47 -61
  317. package/tools/index.js.map +1 -1
  318. package/tools/live/get_native_livekit_core_features.js +65 -0
  319. package/tools/live/get_native_livekit_core_features.js.map +1 -0
  320. package/tools/live/get_native_livekit_core_integration.js +59 -0
  321. package/tools/live/get_native_livekit_core_integration.js.map +1 -0
  322. package/tools/live/get_web_live_uikit_integration.js +48 -0
  323. package/tools/live/get_web_live_uikit_integration.js.map +1 -0
  324. package/tools/live/get_web_livekit_api.js +32 -0
  325. package/tools/live/get_web_livekit_api.js.map +1 -0
  326. package/tools/live/get_web_livekit_component_detail.js +34 -0
  327. package/tools/live/get_web_livekit_component_detail.js.map +1 -0
  328. package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
  329. package/tools/room/get_web_room_uikit_integration.js.map +1 -0
  330. package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
  331. package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
  332. package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
  333. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
  334. package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
  335. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
  336. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
  337. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
  338. package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
  339. package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
  340. package/utils/generate-structured-result.js +61 -17
  341. package/utils/generate-structured-result.js.map +1 -1
  342. package/utils/report-cls-client.js +12 -1
  343. package/utils/report-cls-client.js.map +1 -1
  344. package/utils/report-es-client.js +1 -1
  345. package/resource/doc/chatuikit/android/workflow.md +0 -713
  346. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1376
  347. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -860
  348. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1371
  349. package/resource/doc/chatuikit/flutter/workflow.md +0 -816
  350. package/resource/doc/chatuikit/iOS/workflow.md +0 -0
  351. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -765
  352. package/resource/doc/chatuikit/react/components/search.md +0 -885
  353. package/resource/doc/chatuikit/react/create-group.md +0 -22
  354. package/resource/doc/chatuikit/react/init.md +0 -25
  355. package/resource/doc/chatuikit/react/workflow.md +0 -254
  356. package/resource/doc/chatuikit/uniapp-app/faq.md +0 -0
  357. package/resource/doc/chatuikit/uniapp-app/integration.md +0 -619
  358. package/resource/doc/chatuikit/uniapp-app/workflow.md +0 -576
  359. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  360. package/resource/doc/chatuikit/vue/components/tuikit.md +0 -110
  361. package/resource/doc/chatuikit/vue/create-group.md +0 -26
  362. package/resource/doc/chatuikit/vue/init.md +0 -35
  363. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  364. package/resource/doc/livekit/live/android/workflow.md +0 -322
  365. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  366. package/resource/doc/livekit/live/ios/workflow.md +0 -352
  367. package/resource/doc/livekit/live/vue/components/barrage.md +0 -615
  368. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -442
  369. package/resource/doc/livekit/live/vue/faq.md +0 -0
  370. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -195
  371. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -293
  372. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -381
  373. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -598
  374. package/resource/doc/livekit/live/vue/states/live-state.md +0 -2656
  375. package/resource/doc/livekit/live/vue/workflow.md +0 -219
  376. package/resource/doc/livekit/voice/android/workflow.md +0 -333
  377. package/resource/doc/livekit/voice/flutter/workflow.md +0 -359
  378. package/resource/doc/livekit/voice/ios/voice-integration.md +0 -853
  379. package/resource/doc/livekit/voice/ios/workflow.md +0 -358
  380. package/resource/doc/livekit/voice/uni-app/voice-integration.md +0 -613
  381. package/resource/doc/livekit/voice/uni-app/workflow.md +0 -369
  382. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -334
  383. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -434
  384. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -685
  385. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -712
  386. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -284
  387. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  388. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  389. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  390. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  391. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -879
  392. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -668
  393. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -456
  394. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -332
  395. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  396. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -328
  397. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -505
  398. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  399. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -676
  400. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  401. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -820
  402. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1065
  403. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  404. package/resource/doc/roomkit/vue/workflow.md +0 -733
  405. package/resource/doc/tuicallkit/android/workflow.md +0 -432
  406. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -786
  407. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -663
  408. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -932
  409. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -926
  410. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -452
  411. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -779
  412. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -635
  413. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  414. package/resource/doc/tuicallkit/react/api.md +0 -1512
  415. package/resource/doc/tuicallkit/react/faq.md +0 -986
  416. package/resource/doc/tuicallkit/vue/api.md +0 -1512
  417. package/tools/call/get-native-call-integration.js +0 -43
  418. package/tools/call/get-native-call-integration.js.map +0 -1
  419. package/tools/call/get-web-call-api.js +0 -27
  420. package/tools/call/get-web-call-api.js.map +0 -1
  421. package/tools/call/get-web-call-integration.js.map +0 -1
  422. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  423. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  424. package/tools/chat/get-native-chat-integration.js +0 -45
  425. package/tools/chat/get-native-chat-integration.js.map +0 -1
  426. package/tools/chat/get-web-chat-component-detail.js +0 -31
  427. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  428. package/tools/chat/get-web-chat-integration.js +0 -45
  429. package/tools/chat/get-web-chat-integration.js.map +0 -1
  430. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  431. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  432. package/tools/chat/get-web-create-group-doc.js +0 -28
  433. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  434. package/tools/common/get-faq.js +0 -91
  435. package/tools/common/get-faq.js.map +0 -1
  436. package/tools/common/get-usersig.js.map +0 -1
  437. package/tools/common/present-framework-choice.js +0 -16
  438. package/tools/common/present-framework-choice.js.map +0 -1
  439. package/tools/common/present-scenario-choice.js +0 -16
  440. package/tools/common/present-scenario-choice.js.map +0 -1
  441. package/tools/common/record-prompt.js +0 -55
  442. package/tools/common/record-prompt.js.map +0 -1
  443. package/tools/common/record-result.js +0 -60
  444. package/tools/common/record-result.js.map +0 -1
  445. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  446. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  447. package/tools/definitions/get_native_live_api_def.js +0 -22
  448. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  449. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -109
  450. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  451. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
  452. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  453. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
  454. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  455. package/tools/definitions/get_trtc_native_api_def.js +0 -17
  456. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  457. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  458. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  459. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  460. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  461. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  462. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  463. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  464. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  465. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  466. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  467. package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
  468. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  469. package/tools/definitions/present_scenario_choice_def.js +0 -53
  470. package/tools/definitions/present_scenario_choice_def.js.map +0 -1
  471. package/tools/definitions/record_prompt_def.js +0 -58
  472. package/tools/definitions/record_prompt_def.js.map +0 -1
  473. package/tools/definitions/record_result_def.js +0 -46
  474. package/tools/definitions/record_result_def.js.map +0 -1
  475. package/tools/live/get-native-live-uikit-integration.js +0 -177
  476. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  477. package/tools/live/get-web-live-component-detail.js +0 -31
  478. package/tools/live/get-web-live-component-detail.js.map +0 -1
  479. package/tools/live/get-web-live-state-detail.js +0 -31
  480. package/tools/live/get-web-live-state-detail.js.map +0 -1
  481. package/tools/live/get-web-live-uikit-integration.js +0 -52
  482. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  483. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  484. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  485. package/tools/live/get_native_live_uikit_interaction.js +0 -194
  486. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  487. package/tools/native_live/get-native-live-api.js +0 -31
  488. package/tools/native_live/get-native-live-api.js.map +0 -1
  489. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  490. package/tools/room/get-web-room-integration.js.map +0 -1
  491. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  492. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  493. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  494. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  495. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  496. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  497. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  498. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  499. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  500. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  501. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  502. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  503. package/tools/trtc/get-trtc-native-api.js +0 -31
  504. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  505. package/utils/handle-component-name.js +0 -33
  506. package/utils/handle-component-name.js.map +0 -1
  507. /package/resource/doc/{rtcengine/web → callkit/core-sdk}/.gitkeep +0 -0
  508. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  509. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  510. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
@@ -1,619 +0,0 @@
1
- chat-uikit-uniapp 是一款基于腾讯云 Chat SDK 的 uniapp UI 组件库,提供了一些通用的 UI 组件,包含会话、聊天、群组等功能。基于这些精心设计的 UI 组件,您可以快速构建优雅的、可靠的、可扩展的 Chat 应用。 chat-uikit-uniapp 界面效果如下图所示:
2
-
3
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/5a41851bbba411f09a6b525400454e06.png)
4
-
5
-
6
- ## 前提条件
7
-
8
- ### 开通服务
9
-
10
- #### 步骤1:创建 IM 应用
11
-
12
- 登录 [即时通信 IM 控制台](https://console.cloud.tencent.com/im),在**应用管理**页面,单击**创建新应用**。如果您已有应用,可省略创建应用过程。
13
-
14
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/ed41bca3ca7211f09e745254007c27c5.png)
15
-
16
-
17
- #### 步骤2:获取 SDKAppID 与密钥
18
-
19
- 在**应用管理**的应用列表中,获取新应用的 `SDKAppID` 和 `SecretKey` (密钥) 信息。
20
-
21
- > **注意:**
22
- >
23
- > - 查看密钥信息需要验证身份。
24
- > - 密钥信息为敏感信息,为防止他人盗用,请妥善保管,谨防泄露。
25
-
26
-
27
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/ed4fdbf6ca7211f09e745254007c27c5.png)
28
-
29
-
30
- #### 步骤3:创建测试账号
31
-
32
- 在**账号管理**中创建两个预设账号用于互相发送消息,以便后续的开发和调试。
33
-
34
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/ed3df54fca7211f0a4a55254001c06ec.png)
35
-
36
- ### 环境要求
37
- - **IDE**: HBuilderX,需升级到新版本。
38
-
39
- - **语言**: TypeScript / JavaScript。TUIKit 使用 TS 开发,支持在 JS 或 TS 项目中集成。
40
-
41
- - **框架**: Vue2 / Vue3。
42
-
43
- - **CSS 预处理器**: sass (sass-loader 版本 $\le$ 10.1.1)。
44
-
45
- - **运行环境**: Node.js v12 版本及以上。
46
-
47
- - **包管理**: npm (版本需与 Node 版本匹配)。
48
-
49
- - **支持平台**: Uniapp 打包 App。
50
-
51
-
52
- > **说明:**
53
- >
54
- > - Uniapp 打包微信小程序请另外参考 [uniapp 精简版](https://write.woa.com/document/187938582089838592)。
55
- > - TUIKit **v2.2.0** 起,请按照本文所述步骤接入。
56
- > - TUIKit **v2.1.3** 起,支持通过 cli 脚手架工具创建的项目集成,集成指引请点击 [uniapp vue2/vue3(cli 脚手架)](https://cloud.tencent.com/document/product/269/106501)查看。
57
-
58
-
59
- ## 集成步骤
60
-
61
-
62
-
63
- 完成以下步骤即可发送您的第一条消息。
64
-
65
- ### 步骤1:创建项目
66
-
67
- 打开 HBuilderX,在菜单栏中选择 “**文件 > 新建 > 项目**”,创建一个名为 `chat-example` 的 uni-app 项目。![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027666621/70cc91385cef11ee974d5254005f490f.png)
68
-
69
- ### 步骤2:下载 TUIKit 组件
70
- 1. 创建 `package.json` 文件:HBuilderX 默认不创建该文件,请在项目根目录下执行命令:
71
-
72
- ``` bash
73
- npm init -y
74
- ```
75
- 2. **下载 TUIKit 和依赖**:通过 [NPM](https://www.npmjs.com/package/@tencentcloud/chat-uikit-uniapp) 方式下载 TUIKit 组件和 unplugin-vue2-script-setup 依赖:
76
-
77
- ``` bash
78
- npm i @tencentcloud/chat-uikit-uniapp unplugin-vue2-script-setup
79
- ```
80
- 3. **拷贝 TUIKit 源码**:为了方便开发者对 UI 进行扩展,需要将 TUIKit 源码复制到项目目录中的 ./TUIKit 文件夹下。
81
-
82
-
83
-
84
-
85
-
86
- 【macOS 端】
87
- ``` bash
88
- mkdir -p ./TUIKit && rsync -av --exclude={'node_modules','excluded-list.txt'} ./node_modules/@tencentcloud/chat-uikit-uniapp/ ./TUIKit && rsync -av ./node_modules/@tencentcloud/chat-uikit-uniapp/static ./
89
- ```
90
-
91
-
92
- 【Windows 端】
93
- ``` bash
94
- xcopy .\node_modules\@tencentcloud\chat-uikit-uniapp .\TUIKit /i /e /exclude:.\node_modules\@tencentcloud\chat-uikit-uniapp\excluded-list.txt && xcopy node_modules\@tencentcloud\chat-uikit-uniapp\static .\static /i /e
95
- ```
96
-
97
-
98
- ### 步骤3:集成 TUIKit 组件
99
- 1. **工程配置**:本步骤配置 `manifest.json` 和 `vue.config.js` 文件,确保 TUIKit 运行的环境正常。
100
-
101
-
102
-
103
-
104
- 【manifest.json 文件】
105
-
106
- 在 `manifest.json `文件的源码视图中手动关闭 H5 `treeShaking` 选项。
107
- ``` json
108
- {
109
- "name" : "chat-example",
110
- /* 其他配置 */
111
- "h5" : {
112
- "optimization" : {
113
- "treeShaking" : {
114
- "enable" : false
115
- }
116
- }
117
- },
118
- /* 其他配置 */
119
- }
120
- ```
121
-
122
- 【vue.config.js(仅 Vue2 项目)】
123
-
124
- **Vue2 项目**必须在根目录下修改 vue.config.js (如果没有该文件,请创建该文件并写入以下代码)。
125
- ``` javascript
126
- const ScriptSetup = require('unplugin-vue2-script-setup/webpack').default;
127
-
128
- module.exports = {
129
- parallel: false,
130
- configureWebpack: {
131
- plugins: [
132
- ScriptSetup({
133
- /* options */
134
- }),
135
- ],
136
- },
137
- chainWebpack(config) {
138
- // disable type check and let `vue-tsc` handles it
139
- config.plugins.delete('fork-ts-checker');
140
- },
141
- };
142
- ```
143
-
144
- 2. **集成 TUIKit**:本步骤配置 `app.vue`、`pages.json` 和 `main.js` 文件,确保 TUIKit 可以正常加载。
145
-
146
-
147
-
148
-
149
- 【App.vue 文件】
150
-
151
- 在 App.vue 中引入并初始化 `TUIChatKit`。
152
- ``` javascript
153
- <script lang="ts">
154
- import { TUIChatKit } from './TUIKit';
155
- TUIChatKit.init();
156
-
157
- export default {
158
- onLaunch: function () {}
159
- };
160
- </script>
161
- <style>
162
- /* common css for page */
163
- uni-page-body,html,body,page {
164
- width: 100% !important;
165
- height: 100% !important;
166
- overflow: hidden;
167
- }
168
- </style>
169
- ```
170
-
171
- 【pages.json 文件】
172
-
173
- 配置 `pages.json` 路由是集成 TUIKit 的必备步骤。同时,配置 `TabBar` 以展示“消息”、“通讯录”和“个人中心”。
174
- ``` json
175
- {
176
- "pages": [
177
- {
178
- "path": "pages/index/index", // 您的项目首页
179
- "style": {
180
- "navigationBarTitleText": "腾讯云 IM",
181
- "navigationBarBackgroundColor": "#EBF0F6"
182
- }
183
- },
184
- {
185
- "path": "pages/profile/profile",
186
- "style": {
187
- "navigationBarTitleText": "腾讯云 IM",
188
- "navigationBarBackgroundColor": "#EBF0F6"
189
- }
190
- },
191
- {
192
- "path": "TUIKit/components/TUIConversation/index",
193
- "style": {
194
- "navigationStyle": "custom"
195
- }
196
- },
197
- {
198
- "path": "TUIKit/components/TUIChat/index",
199
- "style": {
200
- "navigationStyle": "custom",
201
- "app-plus": {
202
- "softinputMode": "adjustResize"
203
- }
204
- }
205
- },
206
- {
207
- "path": "TUIKit/components/TUIContact/index",
208
- "style": {
209
- "navigationStyle": "custom"
210
- }
211
- },
212
- {
213
- "path": "TUIKit/components/TUIChat/video-play",
214
- "style": {
215
- "navigationBarTitleText": "腾讯云 IM",
216
- "navigationBarBackgroundColor": "#EBF0F6"
217
- }
218
- },
219
- {
220
- "path": "TUIKit/components/TUIChat/web-view",
221
- "style": {
222
- "navigationBarTitleText": "腾讯云 IM",
223
- "navigationBarBackgroundColor": "#EBF0F6"
224
- }
225
- },
226
- {
227
- "path": "TUIKit/components/TUIGroup/index",
228
- "style": {
229
- "navigationStyle": "custom"
230
- }
231
- },
232
- {
233
- "path": "TUIKit/components/TUISearch/index",
234
- "style": {
235
- "navigationBarTitleText": "聊天记录",
236
- "navigationBarBackgroundColor": "#EBF0F6"
237
- }
238
- }
239
- ],
240
- "tabBar": {
241
- "backgroundColor": "#EBF0F6",
242
- "height": "70px",
243
- "list": [
244
- {
245
- "pagePath": "TUIKit/components/TUIConversation/index",
246
- "text": "消息",
247
- "iconPath": "./static/message.png",
248
- "selectedIconPath": "./static/message-selected.png"
249
- },
250
- {
251
- "pagePath": "TUIKit/components/TUIContact/index",
252
- "text": "通讯录",
253
- "iconPath": "./static/relation.png",
254
- "selectedIconPath": "./static/relation-selected.png"
255
- },
256
- {
257
- "pagePath": "pages/profile/profile",
258
- "text": "个人中心",
259
- "iconPath": "./static/profile.png",
260
- "selectedIconPath": "./static/profile-selected.png"
261
- }
262
- ]
263
- },
264
- "globalStyle": {
265
- "navigationBarTextStyle": "black",
266
- "navigationBarTitleText": "uni-app",
267
- "navigationBarBackgroundColor": "#F8F8F8",
268
- "backgroundColor": "#F8F8F8"
269
- },
270
- "uniIdRouter": {}
271
- }
272
- ```
273
-
274
- 【main.js(仅 Vue2 项目)】
275
-
276
- 如果您是 Vue2 项目,请在 `main.js`** 中引入组合式API**。
277
- ``` javascript
278
- // #ifndef VUE3
279
- import VueCompositionAPI from '@vue/composition-api';
280
- Vue.use(VueCompositionAPI);
281
- // #endif
282
- ```
283
-
284
-
285
- ### **步骤4:配置登录和登出**
286
- 1. **登录配置**:请将以下内容复制到首页文件 `pages/index/index.vue` 中并配置[前提条件 > 开通服务 > 步骤2:获取 SDKAppID 与密钥](https://write.woa.com/#57149ca5-0bc6-478c-a6df-2ca51f38514a) 中获取的SDKAppID、secretKey 完成登录逻辑配置。
287
-
288
-
289
- > **说明:**
290
- >
291
- > - 代码中使用的 `genTestUserSig` 是通过本地脚本使用 `secretKey` 生成 `UserSig`。**用于方便开发和调试,不适合生成环境**。
292
- > - 该方法仅适用于本地 Demo 运行和功能调试,因为 `secretKey` 容易被反编译逆向破解,一旦密钥泄露,攻击者可以盗用您的腾讯云流量,**绝对不能用于生产环境**。
293
- > - **生产环境**下,请将 `UserSig` 的计算代码集成到您的服务端,并提供面向项目的接口, 正确的`UserSig`签发方式参见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
294
-
295
- ``` javascript
296
- <template>
297
- <view class="login-container">
298
- <view class="login-form">
299
- <view class="title-section">
300
- <text class="title">登录</text>
301
- </view>
302
-
303
- <view class="input-section">
304
- <view class="input-group">
305
- <text class="input-label">用户ID</text>
306
- <input
307
- class="input-field"
308
- type="text"
309
- v-model="userID"
310
- placeholder="请输入用户ID"
311
- />
312
- </view>
313
- </view>
314
-
315
- <view class="button-section">
316
- <button
317
- class="login-btn"
318
- :disabled="!canLogin || isLoading"
319
- @tap="handleLogin"
320
- >
321
- {{ isLoading ? '登录中...' : '登录' }}
322
- </button>
323
- </view>
324
- </view>
325
- </view>
326
- </template>
327
-
328
- <script>
329
- import { TUILogin } from '@tencentcloud/tui-core-lite';
330
- import { genTestUserSig } from '../../TUIKit/debug';
331
-
332
- let vueVersion = 2;
333
- // #ifdef VUE3
334
- vueVersion = 3;
335
- // #endif
336
-
337
- const SDKAppID = 0; // Your SDKAppID
338
- const secretKey = ''; // Your secretKey
339
-
340
- export default {
341
- data() {
342
- return {
343
- userID: '',
344
- isLoading: false,
345
- }
346
- },
347
- computed: {
348
- canLogin() {
349
- return this.userID.trim().length > 0
350
- }
351
- },
352
- methods: {
353
- async handleLogin() {
354
- if (!this.canLogin || this.isLoading) return;
355
- this.isLoading = true;
356
- try {
357
- const { userSig } = genTestUserSig({
358
- SDKAppID: SDKAppID,
359
- userID: this.userID,
360
- secretKey: secretKey,
361
- });
362
- TUILogin.login({
363
- SDKAppID: SDKAppID,
364
- userID: this.userID,
365
- userSig: userSig,
366
- framework: `vue${vueVersion}` // framework used vue2 / vue3
367
- })
368
- .then(() => {
369
- uni?.switchTab({
370
- url: '/TUIKit/components/TUIConversation/index',
371
- });
372
- })
373
- .catch((error) => {
374
- console.error(error);
375
- });
376
- } catch (error) {
377
- uni.showToast({
378
- title: '登录失败',
379
- icon: 'error'
380
- })
381
- } finally {
382
- this.isLoading = false
383
- }
384
- }
385
- }
386
- }
387
- </script>
388
-
389
- <style lang="scss" scoped>
390
- .login-container{display:flex;align-items:center;justify-content:center;}.login-form{width:100%;padding:80rpx 60rpx;}.title-section{text-align:center;margin-bottom:80rpx;}.title{font-size:48rpx;font-weight:bold;color:#333333;}.input-section{margin-bottom:60rpx;}.input-group{margin-bottom:40rpx;}.input-label{display:block;font-size:28rpx;color:#666666;margin-bottom:16rpx;}.input-field{width:100%;height:88rpx;border:2rpx solid #e0e0e0;border-radius:8rpx;padding:0 24rpx;font-size:32rpx;color:#333333;box-sizing:border-box;&:focus{border-color:#007aff;}}.button-section{margin-top:40rpx;}.login-btn{width:100%;height:88rpx;background-color:#007aff;color:#ffffff;border:none;border-radius:8rpx;font-size:32rpx;font-weight:600;}
391
- </style>
392
- ```
393
- 2. **登出配置:**在项目 `pages` 目录下新建 `profile` 页面,并将以下代码复制到 `pages/profile/profile.vue`,完成个人中心和登出逻辑配置。
394
-
395
- ``` java
396
- <template>
397
- <div class="profile">
398
- <div class="profile-basic">
399
- <img
400
- class="profile-basic-avatar"
401
- :src="
402
- userProfile.avatar ||
403
- 'https://web.sdk.qcloud.com/component/TUIKit/assets/avatar_21.png'
404
- "
405
- >
406
- <div class="profile-basic-info">
407
- <div class="profile-basic-info-nick"
408
- >
409
- {{ userProfile.nick || "-" }}
410
- </div>
411
- <div class="profile-basic-info-id">
412
- <label class="profile-basic-info-id-label"
413
- >{{ "用户ID" }}:</label>
414
- <div class="profile-basic-info-id-value">
415
- {{ userProfile.userID }}
416
- </div>
417
- </div>
418
- </div>
419
- </div>
420
- <div class="profile-footer">
421
- <button class="logout-btn" @click="logout">
422
- 退出登录
423
- </button>
424
- </div>
425
- </div>
426
- </template>
427
- <script>
428
- import { TUIUserService } from '@tencentcloud/chat-uikit-engine-lite';
429
- import { TUILogin } from '@tencentcloud/tui-core-lite';
430
-
431
- export default {
432
- data() {
433
- return {
434
- userProfile: {}
435
- }
436
- },
437
- methods: {
438
- logout() {
439
- TUILogin.logout().then(() => {
440
- uni.reLaunch({
441
- url: '/pages/index/index',
442
- })
443
- });
444
- }
445
- },
446
- mounted() {
447
- TUIUserService.getUserProfile().then((res) => {
448
- this.userProfile = res.data;
449
- });
450
- }
451
- }
452
- </script>
453
-
454
- <style lang="scss" scoped>
455
- .profile{height:100%;flex:1;display:flex;flex-direction:column;&-basic{display:flex;gap:10px;box-sizing:border-box;padding:14px 18px;flex-direction:row;align-items:flex-start;border-bottom:10px solid #f5f5f5;&-avatar{flex:0 0 auto;width:78px;height:78px;border-radius:8px;}&-info{padding:10px 0;box-sizing:border-box;height:100%;flex:1;display:flex;flex-direction:column;justify-content:space-between;min-width:0;&-nick{font-size:14px;word-break:keep-all;white-space:nowrap;overflow:hidden;text-overflow:ellipsis;font-family:PingFangSC-Medium;font-weight:500;color:#000;letter-spacing:0;}&-id{display:flex;align-items:center;font-family:PingFangSC-Regular;color:#999;letter-spacing:0;font-size:14px;word-break:keep-all;&-value{white-space:nowrap;overflow:hidden;text-overflow:ellipsis;}}}}&-footer{flex:1;display:flex;align-items:center;padding:20px 18px;margin-top:auto;.logout-btn{width:100%;padding:10px 20px;background-color:#ff4757;color:#ffffff;border:none;border-radius:8px;font-size:16px;font-weight:500;text-align:center;}}}
456
- </style>
457
- ```
458
-
459
- ## 运行和测试
460
-
461
- ### 步骤1:运行项目
462
-
463
- 使用 HBuilderX 启动该项目,单击菜单栏中的:**运行** > **运行到手机或模拟器** > **运行到“指定”基座**。
464
-
465
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100033438418/36394185b08d11f099275254005ef0f7.png)
466
-
467
-
468
- ### 步骤2:发送您的第一条消息
469
- - 登录页输入 [前提条件 > 开通服务 > 步骤3:创建测试账号](https://write.woa.com/#be7f0bca-1672-4a37-8653-aa8dd6a17547) 中创建的测试账号,点击登录进入 TUIKit。
470
-
471
- - 点击**发起单聊**后并在**搜索栏**输入 [前提条件 > 开通服务 > 步骤3:创建测试账号](https://write.woa.com/#be7f0bca-1672-4a37-8653-aa8dd6a17547) 中创建的另一个测试账号 `userID`。
472
-
473
- - 选中后单击**完成**,即可进入聊天界面并发送您的第一条消息。
474
-
475
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/a9565af2ca9511f0b011525400bf7822.png)
476
-
477
-
478
- ## 更多高级特性(强烈推荐)
479
-
480
- ### [消息推送](https://cloud.tencent.com/document/product/269/103522)
481
-
482
- > **说明:**
483
- >
484
-
485
- > 如果您的 app 需要推送功能,推荐您接入 [uni-app 腾讯云推送服务(Push)](https://cloud.tencent.com/document/product/269/103522),支持 iOS 和 Android 推送,同时适配各大厂商推送。对 FCM 也有完善的支持,**出海必备**。
486
- >
487
-
488
-
489
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/4b10b46eca9f11f087ad52540099c741.png)
490
-
491
-
492
- ### [消息云端搜索](https://console.cloud.tencent.com/im/plugin/TUICloudSearch)
493
-
494
- > **说明:**
495
- >
496
-
497
- > @tencentcloud/chat-uikit-uniapp ≥ 2.0.6 默认支持, 只需要进入 [控制台 > 插件市场 > 云端搜索](https://cloud.tencent.com/login?s_url=https%3A%2F%2Fconsole.cloud.tencent.com%2Fim%2Fplugin%2FTUICloudSearch) ,单击**免费试用**或**购买插件**即可使用消息云端搜索功能。
498
- >
499
-
500
-
501
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/4379dab4ca9f11f0b011525400bf7822.png)
502
-
503
-
504
- ### 音视频通话 TUICallKit 插件
505
-
506
- > **说明:**
507
- >
508
- > - **TUIKit 中默认没有集成 TUICallKit 音视频组件**。
509
- > - TUICallKit 主要负责语音、视频通话。
510
-
511
- <table>
512
- <tr>
513
- <td rowspan="1" colSpan="1" >运行平台</td>
514
-
515
- <td rowspan="1" colSpan="1" >集成方案</td>
516
-
517
- <td rowspan="1" colSpan="1" >文档链接</td>
518
- </tr>
519
-
520
- <tr>
521
- <td rowspan="1" colSpan="1" >移动端应用 (App)</td>
522
-
523
- <td rowspan="1" colSpan="1" >请集成 **uni-app (客户端) TUICallKit**。</td>
524
-
525
- <td rowspan="1" colSpan="1" >[音视频通话(客户端)](https://cloud.tencent.com/document/product/269/83857)</td>
526
- </tr>
527
-
528
- <tr>
529
- <td rowspan="1" colSpan="1" >H5 环境</td>
530
-
531
- <td rowspan="1" colSpan="1" >请集成 **uni-app (H5) TUICallKit**。</td>
532
-
533
- <td rowspan="1" colSpan="1" >[音视频通话(H5)](https://cloud.tencent.com/document/product/269/97872)</td>
534
- </tr>
535
- </table>
536
-
537
- - 客户端通话示意图:
538
-
539
-
540
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/4376e224ca9f11f0b011525400bf7822.png)
541
-
542
- - H5 通话示意图:
543
-
544
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/438ef430ca9f11f0a7775254005ef0f7.png)
545
-
546
-
547
- ### [智能客服](https://cloud.tencent.com/document/product/269/97537)
548
-
549
- > **说明:**
550
- >
551
- > - 进入[智能客服控制台](https://console.cloud.tencent.com/im/ai-desk),选择应用后,通过领取试用(每个应用都可领取2次、每次有效期7天的免费试用)或者直接购买,开通智能客服。如果您没有可选择的应用,可参见 [创建应用](https://cloud.tencent.com/document/product/269/32577) 步骤操作,再为新建应用开通智能客服。
552
- > - 单独购买智能客服时,仅支持用户和客服号收发消息,账号数和 DAU 无上限。如需 C2C 聊天、群聊等功能,请加购 IM 套餐包。
553
- > - 集成请参考 [用户端 SDK 轻量接入](https://cloud.tencent.com/document/product/269/97537)。
554
-
555
-
556
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027116646/45b00980ca9f11f0a4a55254001c06ec.png)
557
-
558
-
559
- ### 云端审核
560
-
561
- 在消息发送、资料修改场景中,很有可能会扩散不合适的内容,特别是与敏感事件/人物相关、黄色不良内容等令人反感的内容,不仅严重损害了用户们的身心健康,更很有可能违法并导致业务被监管部门查封。即时通信 IM 支持云端内容审核(反垃圾信息)功能,可针对不安全、不适宜的内容进行自动识别、处理,为您的产品体验和业务安全保驾护航。
562
-
563
- [云端审核](https://write.woa.com/document/107052219630235648):在服务端检测由单聊、群聊、资料场景中产生的文本、图片、音频、视频内容,支持针对不同场景的不同内容分别配置审核策略,并对识别出的不安全内容进行拦截。此功能已提供默认预设拦截词库和审核场景,只需在 IM 控制台打开功能开关,即可直接使用。
564
-
565
- ## 常见问题
566
-
567
- ### Debug 文件的作用?
568
-
569
- 主要作用​​:在开发阶段,TUIKit 提供了 debug 文件夹中的本地 UserSig 生成脚本,**用于方便开发和调试**。
570
-
571
- > **警告:(该方法仅适合本地跑通 Demo 和功能调试)**
572
- >
573
- > - 该方法中的 `SECRETKEY` 容易被反编译逆向破解。
574
- > - 一旦密钥泄露,攻击者可以盗用您的腾讯云流量。
575
- > - ​​仅适用于本地 Demo 运行和功能调试​​,**绝对不能用于生产环境**。
576
-
577
-
578
- **请在项目发布前删除 Debug 脚本,使用后台生成 UserSig**,具体原因和操作步骤请参考文档:[生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
579
-
580
- ### uniapp 打包 App 中 Chat 的实例是 web 实例还是 native 实例?
581
-
582
- chat-uikit-uniapp 即使打包为 App,其 Chat 实例依然是 ​​web 实例​​,而非 native 实例。
583
-
584
- ### Conversation 中 groupProfile 或 userProfile 信息不全是为什么,如何获取?
585
-
586
- 原因:会话(Conversation)中携带的群组资料(groupProfile)或用户资料(userProfile)通常是简化版本,主要包含最核心的信息,例如基本的群名称、群头像或用户的昵称、头像等。这样设计的首要目的是为了​​提升性能和应用响应速度。
587
-
588
- 解决方案:
589
- - **获取完整的群组资料​**:通过 [TUIGroupService.getGroupProfile](https://web.sdk.qcloud.com/im/doc/chat-engine-lite/ITUIGroupService.html#getGroupProfile) 获取。
590
-
591
- - **获取完整的用户资料​**:通过 [TUIUserService.getUserProfile](https://web.sdk.qcloud.com/im/doc/chat-engine-lite/ITUIUserService.html#getUserProfile) 获取。
592
-
593
-
594
- > **说明:**
595
- >
596
-
597
- > 群组或用户的自定义字段的获取都需要在完整信息中获取。
598
- >
599
-
600
-
601
- **更多常见问题请参见:**[**uni-app 相关问题**](https://write.woa.com/document/107052248780648448)**。**
602
-
603
-
604
- ## 参考信息
605
-
606
- TUIKit GitHub 源码:
607
- - [chat-uikit-uniapp (vue2/vue3) GitHub 源码](https://github.com/TencentCloud/chat-uikit-uniapp)
608
-
609
-
610
- 实现更多功能,请参考 ChatEngine API 文档:
611
-
612
- - [ChatEngine API 手册](https://web.sdk.qcloud.com/im/doc/chat-engine-lite/index.html)
613
-
614
- - [ChatEngine Lite npm](https://www.npmjs.com/package/@tencentcloud/chat-uikit-engine-lite)
615
-
616
-
617
- ## 联系我们
618
-
619
- 如遇任何问题,可联系 [官网售后](https://cloud.tencent.com/act/event/connect-service#/) 反馈,享有专业工程师的支持,解决您的难题。