@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.js +0 -1
- package/knowledge/bm25-cache.js +73 -0
- package/knowledge/bm25.js +147 -0
- package/knowledge/build-index.js +65 -0
- package/knowledge/chunker.js +167 -0
- package/knowledge/content-loader.js +44 -0
- package/knowledge/extractors.js +25 -0
- package/knowledge/path-meta.js +175 -0
- package/knowledge/search/exact-lookup.js +330 -0
- package/knowledge/search/filter-pool.js +86 -0
- package/knowledge/search/requires-framework.js +72 -0
- package/knowledge/search/search-knowledge.js +226 -0
- package/package.json +9 -9
- package/resource/_schema/feature-aliases.yaml +10 -0
- package/resource/_schema/goal-tags.yaml +72 -0
- package/resource/_schema/products.yaml +16 -0
- package/resource/_schema/trtc-intents.yaml +27 -0
- package/resource/_schema/types.yaml +44 -0
- package/resource/index/component-slugs.json +1 -0
- package/resource/index/manifest.json +1 -0
- package/resource/{doc → integration}/callkit/preset/android/integration.md +32 -28
- package/resource/{doc → integration}/callkit/preset/flutter/integration.md +109 -54
- package/resource/integration/callkit/preset/ios/integration.md +411 -0
- package/resource/integration/callkit/preset/react/integration.md +499 -0
- package/resource/integration/callkit/preset/vue/integration.md +768 -0
- package/resource/{doc/chatkit → integration/chat/preset}/android/integration.md +11 -11
- package/resource/{doc/chatkit → integration/chat/preset}/flutter/integration.md +59 -37
- package/resource/integration/chat/preset/ios/integration.md +568 -0
- package/resource/{doc/chatkit → integration/chat/preset}/react/integration.md +127 -95
- package/resource/integration/chat/preset/uni-app/integration.md +494 -0
- package/resource/{doc/chatkit → integration/chat/preset}/vue/integration.md +163 -143
- package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +15 -15
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +25 -13
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-h5-integration.md +15 -9
- package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +31 -26
- package/resource/integration/roomkit/preset/vue/integration.md +571 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +852 -0
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +929 -0
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +364 -0
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1150 -0
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1216 -0
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +412 -0
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1191 -0
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1292 -0
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +537 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +953 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +1061 -0
- package/resource/knowledge/callkit/faq/android.md +168 -0
- package/resource/knowledge/callkit/faq/common.md +180 -0
- package/resource/knowledge/callkit/faq/flutter.md +52 -0
- package/resource/knowledge/callkit/faq/ios.md +116 -0
- package/resource/knowledge/callkit/faq/uniapp-app.md +89 -0
- package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +217 -0
- package/resource/knowledge/callkit/faq/web.md +363 -0
- package/resource/knowledge/callkit/preset/android/api.md +413 -0
- package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
- package/resource/knowledge/callkit/preset/ios/api.md +256 -0
- package/resource/knowledge/callkit/preset/web/api.md +79 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +72 -0
- package/resource/knowledge/chat/preset/android/features/contact-list.md +41 -0
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +123 -0
- package/resource/knowledge/chat/preset/android/features/language.md +142 -0
- package/resource/knowledge/chat/preset/android/features/message-input.md +57 -0
- package/resource/knowledge/chat/preset/android/features/message-list.md +142 -0
- package/resource/knowledge/chat/preset/android/features/search.md +64 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/android/features/theme.md +21 -18
- package/resource/knowledge/chat/preset/android-view/integration.md +448 -0
- package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +62 -0
- package/resource/knowledge/chat/preset/flutter/features/contact-list.md +40 -0
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +129 -0
- package/resource/knowledge/chat/preset/flutter/features/language.md +104 -0
- package/resource/knowledge/chat/preset/flutter/features/message-input.md +54 -0
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +163 -0
- package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/flutter/features/theme.md +47 -19
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +92 -0
- package/resource/knowledge/chat/preset/ios/features/contact-list.md +119 -0
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +134 -0
- package/resource/knowledge/chat/preset/ios/features/language.md +105 -0
- package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
- package/resource/knowledge/chat/preset/ios/features/message-list.md +164 -0
- package/resource/knowledge/chat/preset/ios/features/search.md +94 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/ios/features/theme.md +54 -51
- package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +157 -94
- package/resource/knowledge/chat/preset/react/features/chat-setting.md +123 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +256 -104
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +217 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/conversation-list.md +86 -79
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +99 -0
- package/resource/knowledge/chat/preset/react/features/conversation-search.md +58 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +30 -83
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-list.md +22 -25
- package/resource/knowledge/chat/preset/react/features/search.md +531 -0
- package/resource/knowledge/chat/preset/react/features/theme.md +16 -0
- package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/chat-setting.md +0 -4
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/contact-list.md +59 -53
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-actions.md +49 -43
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-list.md +61 -49
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-preview.md +43 -40
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +1 -1
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-input.md +128 -105
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-list.md +108 -195
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +74 -68
- package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
- package/resource/knowledge/chat/urls/error-code.md +16 -0
- package/resource/knowledge/chat/urls/product.md +61 -0
- package/resource/knowledge/chat/urls/restapi.md +226 -0
- package/resource/knowledge/chat/urls/sdk/android.md +84 -0
- package/resource/knowledge/chat/urls/sdk/flutter.md +73 -0
- package/resource/knowledge/chat/urls/sdk/ios.md +84 -0
- package/resource/knowledge/chat/urls/sdk/web.md +88 -0
- package/resource/knowledge/chat/urls/webhook.md +73 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/AudioEffectStore.md +79 -76
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +174 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +329 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/CameraView.md +7 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +434 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +362 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +466 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +173 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/LikeStore.md +12 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +291 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +78 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +439 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +221 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/AudioEffectStore.md +79 -76
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/BaseBeautyStore.md +43 -45
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +312 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +404 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +334 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +420 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LikeStore.md +12 -11
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LiveCoreView.md +49 -42
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +397 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +183 -0
- package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/AudioEffectStore.md +79 -75
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +192 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +146 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +309 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +370 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +339 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +503 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +188 -0
- package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/LikeStore.md +12 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +289 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +78 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +434 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +187 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +780 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +59 -51
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +37 -34
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +68 -38
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +18 -15
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +17 -17
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +86 -80
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +53 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +47 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +26 -22
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +16 -13
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +33 -21
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +29 -25
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +21 -20
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +78 -69
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-host-interaction.md +47 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +48 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +27 -23
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +15 -12
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +39 -36
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +42 -29
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +19 -16
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +20 -19
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +55 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +50 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +48 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +26 -22
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +59 -51
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +41 -38
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +67 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +53 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +86 -80
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +45 -40
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +43 -42
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +523 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audience-list.md +16 -13
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audio-effect.md +54 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-barrage.md +33 -21
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +34 -28
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-gift.md +73 -64
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +46 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-room-list.md +165 -148
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +19 -16
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +40 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +41 -28
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +54 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +52 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +55 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +47 -45
- package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +404 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audience-list.md +40 -57
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audio-effect.md +38 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-barrage.md +53 -53
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-co-guest-interaction.md +106 -116
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-gift.md +49 -59
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-integration.md +52 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-room-list.md +38 -46
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +915 -0
- package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +179 -0
- package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +419 -0
- package/resource/knowledge/push/config/android/fcm.md +133 -0
- package/resource/knowledge/push/config/android/honor.md +111 -0
- package/resource/knowledge/push/config/android/huawei.md +106 -0
- package/resource/knowledge/push/config/android/meizu.md +121 -0
- package/resource/knowledge/push/config/android/oppo.md +108 -0
- package/resource/knowledge/push/config/android/vivo.md +101 -0
- package/resource/knowledge/push/config/android/xiaomi.md +99 -0
- package/resource/knowledge/push/integration/android.md +1028 -0
- package/resource/knowledge/push/integration/donut.md +271 -0
- package/resource/knowledge/push/integration/flutter.md +363 -0
- package/resource/knowledge/push/integration/harmonyos.md +72 -0
- package/resource/knowledge/push/integration/ios.md +705 -0
- package/resource/knowledge/push/integration/react-native.md +337 -0
- package/resource/knowledge/push/integration/uni-app.md +461 -0
- package/resource/knowledge/push/integration/unity.md +357 -0
- package/resource/knowledge/push/integration/unreal-engine.md +353 -0
- package/resource/knowledge/push/overview/prepare.md +30 -0
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/call-user-to-room.md +22 -20
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-participant-state.md +22 -193
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-state.md +33 -32
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/schedule-room.md +30 -29
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-participant-state.md +22 -21
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-state.md +29 -28
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/schedule-room.md +17 -16
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/call-user-to-room.md +22 -20
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-participant-state.md +49 -218
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-state.md +37 -37
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/schedule-room.md +28 -28
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/call-user-to-room.md +122 -7
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +318 -3
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +1504 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/free-beauty-panel.md +4 -3
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +709 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1105 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +635 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +529 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/schedule-room.md +256 -13
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/screen-share.md +218 -25
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/virtual-background.md +4 -3
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/android/integration.md +50 -64
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/flutter/integration.md +34 -31
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/ios/integration.md +45 -53
- package/resource/knowledge/roomkit/preset/react/integration.md +571 -0
- package/resource/{doc → knowledge}/rtcengine/web/how_to_run_web_sdk_demo.md +31 -15
- package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +9 -3
- package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/23-advanced-support-detection.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/24-advanced-network-quality.md +6 -6
- package/resource/{doc → knowledge}/rtcengine/web/plugin/25-advanced-device-change.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -4
- package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +4 -4
- package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
- package/resource/{doc → knowledge}/trtc/android/TRTCCloud.md +547 -495
- package/resource/{doc → knowledge}/trtc/android/TRTCCloudDef.md +434 -403
- package/resource/{doc → knowledge}/trtc/android/TRTCCloudListener.md +394 -348
- package/resource/{doc → knowledge}/trtc/android/TRTCStatistics.md +17 -15
- package/resource/{doc → knowledge}/trtc/android/TXAudioEffectManager.md +227 -197
- package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
- package/resource/{doc → knowledge}/trtc/android/TXDeviceManager.md +70 -63
- package/resource/{doc → knowledge}/trtc/android/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCCloud.md +599 -544
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCStatistics.md +17 -15
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +403 -0
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCCloudCallback.md +439 -387
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCTypeDef.md +417 -387
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloud.md +619 -559
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloudDelegate.md +409 -360
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCStatistics.md +17 -15
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXAudioEffectManager.md +187 -164
- package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +399 -0
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiveSDKTypeDef.md +422 -396
- package/server-config.js +0 -1
- package/server.js +22 -12
- package/streamable-http.js +0 -1
- package/tools/call/get_native_call_uikit_integration.js +2 -4
- package/tools/call/get_native_callkit_core_integration.js +2 -6
- package/tools/call/get_web_call_uikit_integration.js +2 -4
- package/tools/chat/get_native_chat_uikit_integration.js +2 -4
- package/tools/chat/get_web_chat_uikit_integration.js +2 -4
- package/tools/common/get_usersig.js +0 -1
- package/tools/common/present_framework_choice.js +9 -4
- package/tools/common/record_answer.js +19 -26
- package/tools/common/record_feedback.js +17 -31
- package/tools/common/search_trtc_knowledge.js +44 -0
- package/tools/definitions/get_native_call_uikit_integration_def.js +2 -1
- package/tools/definitions/get_native_callkit_core_integration_def.js +2 -1
- package/tools/definitions/get_native_chat_uikit_integration_def.js +3 -2
- package/tools/definitions/get_native_livekit_core_integration_def.js +2 -1
- package/tools/definitions/get_usersig_def.js +0 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js +2 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js +2 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js +4 -3
- package/tools/definitions/get_web_room_core_integration_def.js +46 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +3 -1
- package/tools/definitions/integration-boundary.js +5 -0
- package/tools/definitions/present_framework_choice_def.js +11 -10
- package/tools/definitions/record_answer_def.js +6 -5
- package/tools/definitions/record_feedback_def.js +4 -3
- package/tools/definitions/search_trtc_knowledge_def.js +69 -0
- package/tools/index.js +5 -37
- package/tools/live/get_native_livekit_core_integration.js +1 -4
- package/tools/live/get_web_live_uikit_integration.js +2 -5
- package/tools/room/get_web_room_core_integration.js +47 -0
- package/tools/room/get_web_room_uikit_integration.js +2 -4
- package/utils/generate-structured-result.js +4 -11
- package/utils/generate-usersig.js +0 -1
- package/utils/get-device-identifier.js +0 -1
- package/utils/get-doc-content.js +14 -9
- package/utils/http-get.js +0 -1
- package/utils/http-post.js +0 -1
- package/utils/report-cls-client.js +22 -21
- package/utils/report-es-client.js +1 -2
- package/utils/report-runtime-error-cls-client.js +0 -1
- package/index.js.map +0 -1
- package/resource/doc/callkit/core-sdk/.gitkeep +0 -0
- package/resource/doc/callkit/core-sdk/android/answer-call.md +0 -942
- package/resource/doc/callkit/core-sdk/android/make-call.md +0 -876
- package/resource/doc/callkit/core-sdk/android/offline-push.md +0 -368
- package/resource/doc/callkit/core-sdk/flutter/answer-call.md +0 -1132
- package/resource/doc/callkit/core-sdk/flutter/make-call.md +0 -1206
- package/resource/doc/callkit/core-sdk/flutter/offline-push.md +0 -357
- package/resource/doc/callkit/core-sdk/ios/answer-call.md +0 -1009
- package/resource/doc/callkit/core-sdk/ios/make-call.md +0 -1154
- package/resource/doc/callkit/core-sdk/ios/offline-push.md +0 -470
- package/resource/doc/callkit/core-sdk/uni-app/answer-call.md +0 -1146
- package/resource/doc/callkit/core-sdk/uni-app/make-call.md +0 -1267
- package/resource/doc/callkit/faq/android-faq.md +0 -767
- package/resource/doc/callkit/faq/flutter-faq.md +0 -749
- package/resource/doc/callkit/faq/ios-faq.md +0 -759
- package/resource/doc/callkit/faq/web-faq.md +0 -753
- package/resource/doc/callkit/preset/android/api.md +0 -330
- package/resource/doc/callkit/preset/flutter/api.md +0 -401
- package/resource/doc/callkit/preset/ios/api.md +0 -282
- package/resource/doc/callkit/preset/ios/integration.md +0 -188
- package/resource/doc/callkit/preset/react/api.md +0 -600
- package/resource/doc/callkit/preset/react/integration.md +0 -86
- package/resource/doc/callkit/preset/vue/api.md +0 -600
- package/resource/doc/callkit/preset/vue/integration.md +0 -83
- package/resource/doc/chatkit/android/faq.md +0 -109
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +0 -280
- package/resource/doc/chatkit/faq/common/product.md +0 -82
- package/resource/doc/chatkit/faq/common/server.md +0 -53
- package/resource/doc/chatkit/faq/common/server_error_code.md +0 -74
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +0 -183
- package/resource/doc/chatkit/faq/flutter_sdk/faq.md +0 -54
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +0 -279
- package/resource/doc/chatkit/faq/web_sdk/error_code.md +0 -47
- package/resource/doc/chatkit/faq/web_sdk/faq.md +0 -292
- package/resource/doc/chatkit/flutter/faq.md +0 -22
- package/resource/doc/chatkit/ios/faq.md +0 -109
- package/resource/doc/chatkit/react/components/avatar.md +0 -104
- package/resource/doc/chatkit/react/components/chat-header.md +0 -148
- package/resource/doc/chatkit/react/components/chat-setting.md +0 -117
- package/resource/doc/chatkit/react/components/chat.md +0 -38
- package/resource/doc/chatkit/react/components/component-list.md +0 -35
- package/resource/doc/chatkit/react/components/conversation-actions.md +0 -174
- package/resource/doc/chatkit/react/components/conversation-preview.md +0 -116
- package/resource/doc/chatkit/react/components/conversation-search.md +0 -57
- package/resource/doc/chatkit/react/components/search.md +0 -282
- package/resource/doc/chatkit/react/components/tuikit.md +0 -43
- package/resource/doc/chatkit/react/faq.md +0 -26
- package/resource/doc/chatkit/vue/components/avatar.md +0 -104
- package/resource/doc/chatkit/vue/components/chat-header.md +0 -149
- package/resource/doc/chatkit/vue/components/chat.md +0 -42
- package/resource/doc/chatkit/vue/components/component-list.md +0 -89
- package/resource/doc/chatkit/vue/components/tuikit.md +0 -45
- package/resource/doc/chatkit/vue/components/userpicker.md +0 -256
- package/resource/doc/chatkit/vue/faq.md +0 -35
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +0 -148
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +0 -316
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +0 -419
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +0 -325
- package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +0 -436
- package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +0 -165
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +0 -239
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +0 -74
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +0 -417
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +0 -207
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +0 -158
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +0 -304
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +0 -394
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +0 -303
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +0 -410
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +0 -160
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +0 -231
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +0 -375
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +0 -170
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +0 -165
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +0 -143
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +0 -298
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +0 -349
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +0 -297
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +0 -471
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +0 -179
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +0 -238
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +0 -74
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +0 -412
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +0 -173
- package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +0 -365
- package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +0 -336
- package/resource/doc/livekit/preset/live/vue/api-reference/index.md +0 -780
- package/resource/doc/livekit/preset/live/vue/components/barrage.md +0 -291
- package/resource/doc/livekit/preset/live/vue/components/co-guest-panel.md +0 -88
- package/resource/doc/livekit/preset/live/vue/components/live-audience-list.md +0 -164
- package/resource/doc/livekit/preset/live/vue/components/live-scene-panel.md +0 -130
- package/resource/doc/livekit/preset/live/vue/components/live-view.md +0 -203
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +0 -211
- package/resource/doc/livekit/preset/live/vue/faq.md +0 -1
- package/resource/doc/roomkit/faq/common/error-code.md +0 -67
- package/resource/doc/roomkit/flutter/features/call-user-to-room.md +0 -228
- package/resource/doc/roomkit/vue/faq.md +0 -1
- package/resource/doc/roomkit/vue/features/device-state.md +0 -460
- package/resource/doc/roomkit/vue/features/room-chat.md +0 -369
- package/resource/doc/roomkit/vue/features/room-participant-state.md +0 -385
- package/resource/doc/roomkit/vue/features/room-state.md +0 -280
- package/resource/doc/roomkit/vue/features/room-view.md +0 -241
- package/resource/doc/roomkit/vue/integration.md +0 -315
- package/resource/doc/rtcengine/faq/web_sdk/.gitkeep +0 -0
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +0 -472
- package/resource/doc/trtc/C++/ITXDeviceManager.md +0 -388
- package/resource/doc/trtc/android/TXBeautyManager.md +0 -403
- package/resource/doc/trtc/iOS/TXBeautyManager.md +0 -404
- package/resource/doc/trtc/iOS/TXDeviceManager.md +0 -382
- package/server-config.js.map +0 -1
- package/server.js.map +0 -1
- package/streamable-http.js.map +0 -1
- package/tools/call/get_callkit_api.js +0 -33
- package/tools/call/get_callkit_api.js.map +0 -1
- package/tools/call/get_native_call_uikit_integration.js.map +0 -1
- package/tools/call/get_native_callkit_core_integration.js.map +0 -1
- package/tools/call/get_web_call_uikit_integration.js.map +0 -1
- package/tools/chat/get_native_chat_uikit_feature_detail.js +0 -35
- package/tools/chat/get_native_chat_uikit_feature_detail.js.map +0 -1
- package/tools/chat/get_native_chat_uikit_integration.js.map +0 -1
- package/tools/chat/get_web_chat_uikit_component_detail.js +0 -35
- package/tools/chat/get_web_chat_uikit_component_detail.js.map +0 -1
- package/tools/chat/get_web_chat_uikit_integration.js.map +0 -1
- package/tools/common/get_faq.js +0 -266
- package/tools/common/get_faq.js.map +0 -1
- package/tools/common/get_usersig.js.map +0 -1
- package/tools/common/present_framework_choice.js.map +0 -1
- package/tools/common/record_answer.js.map +0 -1
- package/tools/common/record_feedback.js.map +0 -1
- package/tools/common/record_skill_session.js +0 -69
- package/tools/common/record_skill_session.js.map +0 -1
- package/tools/definitions/get_callkit_api_def.js +0 -28
- package/tools/definitions/get_callkit_api_def.js.map +0 -1
- package/tools/definitions/get_faq_def.js +0 -40
- package/tools/definitions/get_faq_def.js.map +0 -1
- package/tools/definitions/get_native_call_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_callkit_core_integration_def.js.map +0 -1
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +0 -31
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_native_chat_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_livekit_core_features_def.js +0 -33
- package/tools/definitions/get_native_livekit_core_features_def.js.map +0 -1
- package/tools/definitions/get_native_livekit_core_integration_def.js.map +0 -1
- package/tools/definitions/get_native_trtc_sdk_docs_def.js +0 -32
- package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +0 -1
- package/tools/definitions/get_usersig_def.js.map +0 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js +0 -31
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_livekit_api_def.js +0 -27
- package/tools/definitions/get_web_livekit_api_def.js.map +0 -1
- package/tools/definitions/get_web_livekit_component_detail_def.js +0 -29
- package/tools/definitions/get_web_livekit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_room_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_roomkit_feature_detail_def.js +0 -30
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_api_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +0 -1
- package/tools/definitions/present_framework_choice_def.js.map +0 -1
- package/tools/definitions/record_answer_def.js.map +0 -1
- package/tools/definitions/record_feedback_def.js.map +0 -1
- package/tools/definitions/record_skill_session_def.js +0 -31
- package/tools/definitions/record_skill_session_def.js.map +0 -1
- package/tools/index.js.map +0 -1
- package/tools/live/get_native_livekit_core_features.js +0 -68
- package/tools/live/get_native_livekit_core_features.js.map +0 -1
- package/tools/live/get_native_livekit_core_integration.js.map +0 -1
- package/tools/live/get_web_live_uikit_integration.js.map +0 -1
- package/tools/live/get_web_livekit_api.js +0 -33
- package/tools/live/get_web_livekit_api.js.map +0 -1
- package/tools/live/get_web_livekit_component_detail.js +0 -35
- package/tools/live/get_web_livekit_component_detail.js.map +0 -1
- package/tools/room/get_web_room_uikit_integration.js.map +0 -1
- package/tools/room/get_web_roomkit_feature_detail.js +0 -69
- package/tools/room/get_web_roomkit_feature_detail.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_api.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_api.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_integration.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +0 -1
- package/tools/trtc/get_native_trtc_sdk_docs.js +0 -74
- package/tools/trtc/get_native_trtc_sdk_docs.js.map +0 -1
- package/utils/build-session-directives.js +0 -122
- package/utils/build-session-directives.js.map +0 -1
- package/utils/generate-structured-result.js.map +0 -1
- package/utils/generate-usersig.js.map +0 -1
- package/utils/get-device-identifier.js.map +0 -1
- package/utils/get-doc-content.js.map +0 -1
- package/utils/handle-framework.js +0 -9
- package/utils/handle-framework.js.map +0 -1
- package/utils/handle-state-name.js +0 -29
- package/utils/handle-state-name.js.map +0 -1
- package/utils/http-get.js.map +0 -1
- package/utils/http-post.js.map +0 -1
- package/utils/report-cls-client.js.map +0 -1
- package/utils/report-es-client.js.map +0 -1
- package/utils/report-runtime-error-cls-client.js.map +0 -1
- /package/resource/{doc/callkit/faq/common → knowledge/callkit/faq}/error-code.md +0 -0
- /package/resource/{doc/livekit/faq/common → knowledge/livekit/faq}/error-code.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/api.md +0 -0
- /package/resource/{doc/rtcengine/faq/web/web.md → knowledge/rtcengine/web/faq.md} +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/how_to_integrated_web_sdk.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/28-advanced-beauty.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/29-advanced-water-mark.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/30-advanced-cross-room-link.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/34-advanced-proxy.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/37-advanced-voice-changer.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/38-advanced-basic-beauty.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/40-advanced-video-mixer.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/43-advanced-face-detection.md +0 -0
- /package/resource/{doc/rtcengine/faq/common → knowledge/share}/userSig.md +0 -0
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
## **组件概述**
|
|
2
|
+
|
|
3
|
+
Search 是搜索组件,为用户提供搜索框、搜索结果展示、界面跳转等功能的完整组件集合。该组件支持用户搜索、群组搜索、消息搜索等功能,并提供了丰富的交互回调接口。
|
|
4
|
+
|
|
5
|
+
> **说明:**
|
|
6
|
+
>
|
|
7
|
+
|
|
8
|
+
> 搜索为旗舰版或企业版功能,购买旗舰版或企业版套餐包后可使用,详情请参见 [价格说明](https://cloud.tencent.com/document/product/269/81908#FUNCDetail)。
|
|
9
|
+
>
|
|
10
|
+
|
|
11
|
+
| <strong>搜索入口</strong> | <strong>搜索结果</strong> |
|
|
12
|
+
| --- | --- |
|
|
13
|
+
| | |
|
|
14
|
+
|
|
15
|
+
## 组件集成
|
|
16
|
+
|
|
17
|
+
Search 组件属于 TUIKit Compose 的一部分,集成 TUIKit Compose 即可获取并使用 Search 组件。集成方法请参考文档 [TUIKit Compose](https://cloud.tencent.com/document/product/269/125127) 里的集成步骤,完成登录操作。
|
|
18
|
+
|
|
19
|
+
## 组件构成
|
|
20
|
+
|
|
21
|
+
`SearchScreen` 是 Search 组件的入口组件,对外仅暴露了搜索组件的初始化方法,其他逻辑均封装在 `SearchScreen` 中。
|
|
22
|
+
| 方法名 | 参数 | 描述 |
|
|
23
|
+
| --- | --- | --- |
|
|
24
|
+
| SearchScreen | <code>modifier: Modifier</code> | Jetpack Compose 中用来设置组件的样式、布局、行为和外观。 |
|
|
25
|
+
| <code>onBack: () -> Unit</code> | 点击取消按钮的回调,可选参数。 | |
|
|
26
|
+
| <code>onContactSelect: (FriendSearchInfo) -> Unit</code> | 点击搜索到的联系人条目时的回调,可选参数。 | |
|
|
27
|
+
| <code>onGroupSelect: (GroupSearchInfo) -> Unit</code> | 点击搜索到的群组条目时的回调,可选参数。 | |
|
|
28
|
+
| <code>onConversationSelect: (MessageSearchResultItem) -> Unit</code> | 点击搜索到的会话条目时的回调,可选参数。 | |
|
|
29
|
+
| <code>onMessageSelect: (MessageInfo) -> Unit</code> | 点击搜索到的消息条目时的回调,可选参数。 | |
|
|
30
|
+
|
|
31
|
+
## 基础用法
|
|
32
|
+
|
|
33
|
+
`SearchScreen` 的搜索结果路由跳转如下:
|
|
34
|
+
- 自动路由:在搜索结果界面中,点击**更多**(**More**)按钮或聊天记录列表时,组件内部会通过自动完成页面跳转。
|
|
35
|
+
|
|
36
|
+
- 自定义路由:当用户点击具体的联系人、群组、会话或消息时,组件会触发相应的回调`onContactSelect/onGroupSelect/onConversationSelect/onMessageSelect`,需在回调中实现自定义跳转(例如跳转到您的自定义聊天界面)。
|
|
37
|
+
|
|
38
|
+
如下图所示:
|
|
39
|
+
|
|
40
|
+
`SearchScreen`组件可直接初始化使用,示例代码如下:
|
|
41
|
+
|
|
42
|
+
``` java
|
|
43
|
+
SearchScreen(
|
|
44
|
+
modifier = Modifier.Companion
|
|
45
|
+
.fillMaxSize()
|
|
46
|
+
.statusBarsPadding()
|
|
47
|
+
.navigationBarsPadding(),
|
|
48
|
+
onBack = {
|
|
49
|
+
// 取消按钮点击响应事件
|
|
50
|
+
},
|
|
51
|
+
onContactSelect = {
|
|
52
|
+
// 联系人点击响应事件
|
|
53
|
+
},
|
|
54
|
+
onGroupSelect = {
|
|
55
|
+
// 群组点击响应事件
|
|
56
|
+
},
|
|
57
|
+
onConversationSelect = {
|
|
58
|
+
// 会话点击响应事件
|
|
59
|
+
},
|
|
60
|
+
onMessageSelect = {
|
|
61
|
+
// 消息点击响应事件
|
|
62
|
+
}
|
|
63
|
+
)
|
|
64
|
+
```
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
TUIKit Compose 提供了强大的外观定制能力,支持自定义应用的主题模式(浅色/深色/跟随系统)和主题色。通过简单的配置,开发者可以轻松实现应用级别的主题切换和品牌色定制。
|
|
2
2
|
|
|
3
3
|
以消息列表为例,自定义主题模式和主题色的效果如下图所示:
|
|
4
|
-
|
|
|
4
|
+
| <strong>浅色 + 默认颜色</strong> | <strong>浅色 + 橘黄色</strong> | <strong>深色 + 默认颜色</strong> | <strong>深色 + 绿色主题</strong> |
|
|
5
5
|
| --- | --- | --- | --- |
|
|
6
6
|
| | | | |
|
|
7
7
|
|
|
@@ -31,13 +31,14 @@ TUIKit Compose 提供了强大的外观定制能力,支持自定义应用的
|
|
|
31
31
|
### 设置主题模式
|
|
32
32
|
| 方法 | 参数 | 返回值 | 说明 |
|
|
33
33
|
| --- | --- | --- | --- |
|
|
34
|
-
|
|
|
34
|
+
| <code>setThemeMode</code> | <code>ThemeMode</code> | <code>Unit</code> | 设置显示模式,自动保存并刷新。<br>- <code>ThemeMode.SYSTEM</code>:跟随系统外观。<br>- <code>ThemeMode.LIGHT</code>:强制使用浅色模式。<br>- <code>ThemeMode.DARK</code>:强制使用深色模式。 |
|
|
35
35
|
|
|
36
36
|
### 设置主题色
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
37
|
+
|
|
38
|
+
|方法|参数|返回值|说明|
|
|
39
|
+
|---------|---------|---------|---------|
|
|
40
|
+
|`setPrimaryColor`|`String`|`Unit`|设置主题色,需要 Hex 格式(例如 "#1C66E5")。|
|
|
41
|
+
|`clearPrimaryColor`|无|`Unit`|清除自定义主题色,恢复默认蓝色。|
|
|
41
42
|
|
|
42
43
|
> **说明:**
|
|
43
44
|
>
|
|
@@ -48,12 +49,13 @@ TUIKit Compose 提供了强大的外观定制能力,支持自定义应用的
|
|
|
48
49
|
### 查询 ThemeState 信息
|
|
49
50
|
|
|
50
51
|
通过以下只读属性可以查询当前的主题配置状态和信息:
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
52
|
+
|
|
53
|
+
|属性|类型|说明|
|
|
54
|
+
|---------|---------|---------|
|
|
55
|
+
|`currentMode`|`ThemeMode`|当前主题模式。|
|
|
56
|
+
|`currentPrimaryColor`|`String?`|当前主题色(Hex 格式)。|
|
|
57
|
+
|`hasCustomPrimaryColor`|`Boolean`|是否设置了自定义主题色。|
|
|
58
|
+
|`isDarkMode`|`Boolean`|当前是否为深色模式。|
|
|
57
59
|
|
|
58
60
|
## 使用方式
|
|
59
61
|
|
|
@@ -63,7 +65,7 @@ TUIKit Compose 提供了强大的外观定制能力,支持自定义应用的
|
|
|
63
65
|
|
|
64
66
|
AppBuilder是一个便捷式功能及 UI 自定义配置工具,通过 JSON 配置文件统一管理,适用于 Web + Native 双端应用需要保持统一外观的场景。
|
|
65
67
|
|
|
66
|
-
您可以在 [Chat Web 体验馆](https://trtc.io/demo/homepage/#/detail
|
|
68
|
+
您可以在 [Chat Web 体验馆](https://trtc.io/demo/homepage/#/detail) 体验 AppBuilder 功能,体验入口:
|
|
67
69
|
|
|
68
70
|
虽然 Chat Web 体验馆上暂时无法实时观看移动端的配置效果,但移动端已经预先支持了 AppBuilder 的配置能力。
|
|
69
71
|
|
|
@@ -74,7 +76,7 @@ AppBuilder是一个便捷式功能及 UI 自定义配置工具,通过 JSON 配
|
|
|
74
76
|
|
|
75
77
|
#### 1. 下载配置文件
|
|
76
78
|
|
|
77
|
-
访问 [Chat Web 体验馆](https://trtc.io/demo/homepage/#/detail
|
|
79
|
+
访问 [Chat Web 体验馆](https://trtc.io/demo/homepage/#/detail),下载配置文件 appConfig.json。下载路径为:
|
|
78
80
|
|
|
79
81
|
`appConfig.json`文件内容如下所示,与 AppBuilder 页面的配置项一一对应,与定义外观相关的配置是 `theme`及其子字段:
|
|
80
82
|
``` json
|
|
@@ -117,10 +119,11 @@ AppBuilder是一个便捷式功能及 UI 自定义配置工具,通过 JSON 配
|
|
|
117
119
|
```
|
|
118
120
|
|
|
119
121
|
**配置选项说明**
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
122
|
+
|
|
123
|
+
|参数说明|类型|可选值|说明|
|
|
124
|
+
|---------|---------|---------|---------|
|
|
125
|
+
|`mode`|String|`"system"`、`"light"`、`"dark"`|主题模式|
|
|
126
|
+
|`primaryColor`|String|Hex 颜色值,例如 `"#0ABF77"`|主题色|
|
|
124
127
|
|
|
125
128
|
#### 2. 将配置文件拖入项目中
|
|
126
129
|
|
|
@@ -0,0 +1,448 @@
|
|
|
1
|
+
TUIKit 是基于 IM SDK 的一套 UI 组件库,可通过 UI 组件快速实现聊天、会话、搜索、关系链、群组等功能。本文介绍如何快速集成 TUIKit 并实现核心功能。
|
|
2
|
+
|
|
3
|
+
## 集成 TUIKit
|
|
4
|
+
|
|
5
|
+
TUIKit 采用数据驱动的响应式架构与原生 Android View 体系(非 Compose),以源码方式开放集成。它提供会话列表、聊天、联系人、搜索、群组等完整 UI 能力,并内置主题切换与全局配置。
|
|
6
|
+
|
|
7
|
+
### 环境要求
|
|
8
|
+
|
|
9
|
+
> **架构说明**:本文档对应 **Android TUIKit(View 架构 / 传统 XML 布局)**,适用于基于 Android View 体系的项目。如需 Jetpack Compose 架构,请参考 Android TUIKit Compose 集成文档。
|
|
10
|
+
- Android Studio 2022.3.1 及之后的版本,JDK 17。
|
|
11
|
+
|
|
12
|
+
- Android 6.0 及以上真机或模拟器。
|
|
13
|
+
|
|
14
|
+
- 工程需支持 Kotlin(TUIKit 使用 Kotlin 开发)。
|
|
15
|
+
|
|
16
|
+
- minSdk >= 23 。
|
|
17
|
+
|
|
18
|
+
- 一个有效的腾讯云账号及 Chat 应用。可参考 开通服务 从控制台获取以下信息:
|
|
19
|
+
|
|
20
|
+
- SDKAppID:App 在控制台获取的 Chat 应用的 ID,为应用的唯一标识。
|
|
21
|
+
|
|
22
|
+
- SDKSecretKey:应用的密钥。
|
|
23
|
+
|
|
24
|
+
>
|
|
25
|
+
|
|
26
|
+
> **版本兼容性说明:**
|
|
27
|
+
>
|
|
28
|
+
>
|
|
29
|
+
|
|
30
|
+
> 为确保构建环境稳定,请严格遵循官方兼容性要求进行配置:
|
|
31
|
+
>
|
|
32
|
+
> - Gradle、Android Gradle Plugin、JDK 与 Android Studio 的兼容性,请参阅 Android 官方文档:[版本说明](https://developer.android.com/build/releases/gradle-plugin#updating-gradle)。
|
|
33
|
+
> - Kotlin、Android Gradle Plugin 与 Gradle 的版本对应关系,请参阅 Kotlin 官方文档:[Kotlin-Gradle 插件兼容性](https://kotlinlang.org/docs/gradle-configure-project.html#apply-the-plugin)。
|
|
34
|
+
|
|
35
|
+
> 我们建议您根据上述指南,选择与项目要求完全匹配的版本组合。
|
|
36
|
+
>
|
|
37
|
+
|
|
38
|
+
### 集成步骤
|
|
39
|
+
1. 从 GitHub 仓库 [Tencent-RTC/TUIKit_Android](https://github.com/Tencent-RTC/TUIKit_Android) 下载源码,将仓库根目录下的 `chat`、`atomic_x`(以及可选的、用于音视频通话的 `call`)文件夹整体复制到您的工程根目录下。复制完成后的目录结构如下:
|
|
40
|
+
|
|
41
|
+
``` text
|
|
42
|
+
YourApplication/
|
|
43
|
+
├── app/ # 您的应用模块
|
|
44
|
+
├── atomic_x/ # 基础 UI 组件库(必要)
|
|
45
|
+
├── call/ # 音视频通话组件(可选)
|
|
46
|
+
│ └── tuicallkit-kt/
|
|
47
|
+
├── chat/ # Chat 源码
|
|
48
|
+
│ ├── demo/ # 示例工程(可参考,非必需)
|
|
49
|
+
│ └── uikit/ # Chat UIKit 组件库(必要)
|
|
50
|
+
├── settings.gradle.kts
|
|
51
|
+
└── build.gradle.kts
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
> **说明:**TUIKit_Android 是包含多个产品的开源仓库,Chat 的 UI 源码位于 `chat/` 目录下(`chat/uikit` 为 UIKit 组件库,`chat/demo` 为示例工程),其依赖的基础组件 `atomic_x` 与音视频通话组件 `call/tuicallkit-kt` 位于仓库根目录。模块目录可放在工程任意位置,只需在 `settings.gradle.kts` 中设置正确的相对路径即可。
|
|
55
|
+
>
|
|
56
|
+
|
|
57
|
+
2. 在 `settings.gradle.kts` 中引入对应模块(请按源码实际存放位置调整相对路径):
|
|
58
|
+
|
|
59
|
+
【Kotlin DSL】
|
|
60
|
+
``` kotlin
|
|
61
|
+
// settings.gradle.kts
|
|
62
|
+
|
|
63
|
+
// 引入 Chat UIKit 组件库(必要)
|
|
64
|
+
include(":uikit")
|
|
65
|
+
project(":uikit").projectDir = file("${settingsDir.path}/chat/uikit")
|
|
66
|
+
|
|
67
|
+
// 引入 AtomicX 基础 UI 组件库(必要)
|
|
68
|
+
include(":atomic_x")
|
|
69
|
+
project(":atomic_x").projectDir = file("${settingsDir.path}/atomic_x")
|
|
70
|
+
|
|
71
|
+
// 引入音视频通话组件(可选,集成音视频通话时需要)
|
|
72
|
+
include(":tuicallkit-kt")
|
|
73
|
+
project(":tuicallkit-kt").projectDir = file("${settingsDir.path}/call/tuicallkit-kt")
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
【Groovy DSL】
|
|
77
|
+
``` groovy
|
|
78
|
+
// settings.gradle
|
|
79
|
+
|
|
80
|
+
// 引入 Chat UIKit 组件库(必要)
|
|
81
|
+
include ':uikit'
|
|
82
|
+
project(':uikit').projectDir = new File(settingsDir, 'chat/uikit')
|
|
83
|
+
|
|
84
|
+
// 引入 AtomicX 基础 UI 组件库(必要)
|
|
85
|
+
include ':atomic_x'
|
|
86
|
+
project(':atomic_x').projectDir = new File(settingsDir, 'atomic_x')
|
|
87
|
+
|
|
88
|
+
// 引入音视频通话组件(可选,集成音视频通话时需要)
|
|
89
|
+
include ':tuicallkit-kt'
|
|
90
|
+
project(':tuicallkit-kt').projectDir = new File(settingsDir, 'call/tuicallkit-kt')
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
3. 在 app 模块的 `build.gradle.kts` 中添加依赖:
|
|
94
|
+
|
|
95
|
+
【Kotlin DSL】
|
|
96
|
+
``` kotlin
|
|
97
|
+
// app/build.gradle.kts
|
|
98
|
+
dependencies {
|
|
99
|
+
// TUIKit 组件库(必要)
|
|
100
|
+
implementation(project(":uikit"))
|
|
101
|
+
implementation(project(":atomic_x"))
|
|
102
|
+
// 音视频通话(可选)
|
|
103
|
+
implementation(project(":tuicallkit-kt"))
|
|
104
|
+
}
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
【Groovy DSL】
|
|
108
|
+
``` groovy
|
|
109
|
+
// app/build.gradle
|
|
110
|
+
dependencies {
|
|
111
|
+
// TUIKit 组件库(必要)
|
|
112
|
+
implementation project(':uikit')
|
|
113
|
+
implementation project(':atomic_x')
|
|
114
|
+
// 音视频通话(可选)
|
|
115
|
+
implementation project(':tuicallkit-kt')
|
|
116
|
+
}
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### 接入步骤
|
|
120
|
+
|
|
121
|
+
完成上述集成后,参考以下步骤,您仅需几行代码即可在项目中快速搭建会话列表、聊天、联系人等核心界面。
|
|
122
|
+
|
|
123
|
+
#### 步骤1:配置用户鉴权
|
|
124
|
+
|
|
125
|
+
在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im/tool-usersig) 根据 UserID 获取 UserSig,用于后续登录时的用户鉴权。
|
|
126
|
+
|
|
127
|
+
#### 步骤2:用户登录
|
|
128
|
+
|
|
129
|
+
登录鉴权后才能正常使用组件的功能。调用 `LoginStore` 的 `login` 接口,传入上文获取的 sdkAppID、userID、userSig 进行登录鉴权:
|
|
130
|
+
``` java
|
|
131
|
+
import io.trtc.tuikit.atomicxcore.api.CompletionHandler
|
|
132
|
+
import io.trtc.tuikit.atomicxcore.api.login.LoginStore
|
|
133
|
+
|
|
134
|
+
LoginStore.shared.login(
|
|
135
|
+
context,
|
|
136
|
+
sdkAppID, // Int,控制台获取
|
|
137
|
+
userID, // String
|
|
138
|
+
userSig, // String,控制台或服务端生成
|
|
139
|
+
object : CompletionHandler {
|
|
140
|
+
override fun onSuccess() {
|
|
141
|
+
// 登录成功,可跳转会话列表或聊天页
|
|
142
|
+
}
|
|
143
|
+
override fun onFailure(code: Int, desc: String) {
|
|
144
|
+
// 登录失败,可弹框报错
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
)
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
> **注意:**
|
|
151
|
+
>
|
|
152
|
+
|
|
153
|
+
> 在正式的生产环境中,建议在您的服务端生成 UserSig,在需要时由 App 向业务服务器发起请求获取动态 UserSig 进行鉴权。详见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
|
|
154
|
+
>
|
|
155
|
+
|
|
156
|
+
#### 步骤3:构建会话列表界面
|
|
157
|
+
|
|
158
|
+
会话列表只需创建 `ConversationsPageView` 并加入到您的布局即可。它会自动从本地读取最近会话,点击某个会话时通过 `onConversationClick` 回调返回该会话的 `conversationID`,您可据此跳转聊天界面。
|
|
159
|
+
``` kotlin
|
|
160
|
+
import android.os.Bundle
|
|
161
|
+
import androidx.appcompat.app.AppCompatActivity
|
|
162
|
+
import io.trtc.tuikit.chat.uikit.pages.ConversationsPageView
|
|
163
|
+
|
|
164
|
+
class ConversationActivity : AppCompatActivity() {
|
|
165
|
+
override fun onCreate(savedInstanceState: Bundle?) {
|
|
166
|
+
super.onCreate(savedInstanceState)
|
|
167
|
+
|
|
168
|
+
val conversationsPage = ConversationsPageView(this)
|
|
169
|
+
conversationsPage.setHeaderTitle("消息")
|
|
170
|
+
|
|
171
|
+
// 点击会话回调,conversationID 已带 c2c_ / group_ 前缀
|
|
172
|
+
conversationsPage.onConversationClick = { conversationID ->
|
|
173
|
+
// 跳转到您的聊天界面,并将 conversationID 传入(可参考步骤4 的 ChatActivity)
|
|
174
|
+
}
|
|
175
|
+
// 可选:搜索、发起单聊、创建群聊等入口回调
|
|
176
|
+
conversationsPage.onSearchClick = { /* 跳转搜索页 */ }
|
|
177
|
+
conversationsPage.onStartChatClick = { /* 发起单聊 */ }
|
|
178
|
+
conversationsPage.onCreateGroupClick = { /* 创建群聊 */ }
|
|
179
|
+
|
|
180
|
+
// 将会话列表设置为页面内容
|
|
181
|
+
setContentView(conversationsPage)
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
#### 步骤4:构建聊天界面
|
|
187
|
+
|
|
188
|
+
聊天界面使用 `ChatPageView` 展示和收发消息,通过 `setup` 传入 `conversationID` 即可。`conversationID` 的格式为:单聊 `c2c_<对方 UserID>`,群聊 `group_<群 GroupID>`。
|
|
189
|
+
``` kotlin
|
|
190
|
+
import android.content.Context
|
|
191
|
+
import android.content.Intent
|
|
192
|
+
import android.os.Bundle
|
|
193
|
+
import androidx.appcompat.app.AppCompatActivity
|
|
194
|
+
import io.trtc.tuikit.chat.uikit.pages.ChatPageView
|
|
195
|
+
|
|
196
|
+
class ChatActivity : AppCompatActivity() {
|
|
197
|
+
|
|
198
|
+
override fun onCreate(savedInstanceState: Bundle?) {
|
|
199
|
+
// 必须设置 Material Components 主题,否则 ChatPageView 运行时会 Crash
|
|
200
|
+
setTheme(com.google.android.material.R.style.Theme_MaterialComponents_Light_NoActionBar)
|
|
201
|
+
super.onCreate(savedInstanceState)
|
|
202
|
+
|
|
203
|
+
// conversationID 格式:单聊 "c2c_<对方 UserID>",群聊 "group_<群 GroupID>"
|
|
204
|
+
val conversationID = intent.getStringExtra("conversationID") ?: return
|
|
205
|
+
|
|
206
|
+
val chatPageView = ChatPageView(this)
|
|
207
|
+
chatPageView.setup(conversationID = conversationID)
|
|
208
|
+
setContentView(chatPageView)
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
companion object {
|
|
212
|
+
fun start(context: Context, conversationID: String) {
|
|
213
|
+
context.startActivity(Intent(context, ChatActivity::class.java).apply {
|
|
214
|
+
putExtra("conversationID", conversationID)
|
|
215
|
+
})
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
> **注意:**
|
|
222
|
+
>
|
|
223
|
+
|
|
224
|
+
> 承载聊天页的 Activity **必须**设置 Material Components 主题(如 `setTheme(com.google.android.material.R.style.Theme_MaterialComponents_Light_NoActionBar)`),否则 `ChatPageView` 内部使用的 Material 控件会因缺少对应主题属性,在运行时直接 Crash。
|
|
225
|
+
>
|
|
226
|
+
|
|
227
|
+
> **说明:**示例工程(demo)中提供了基于 `ChatPageView` 封装好的聊天页 `ChatActivity`(带标题栏、未读角标、群事件处理等),可直接复用或参考其实现进行自定义:`ChatActivity.start(context, conversationID)`。
|
|
228
|
+
>
|
|
229
|
+
|
|
230
|
+
#### 步骤5:构建联系人界面
|
|
231
|
+
|
|
232
|
+
联系人界面使用 `ContactsPageView` 展示好友列表、群组列表等,通过 `setup` 设置点击回调。点击联系人或群组时跳转对应聊天界面。
|
|
233
|
+
``` kotlin
|
|
234
|
+
import android.os.Bundle
|
|
235
|
+
import androidx.appcompat.app.AppCompatActivity
|
|
236
|
+
import io.trtc.tuikit.chat.uikit.pages.ContactsPageView
|
|
237
|
+
|
|
238
|
+
class ContactActivity : AppCompatActivity() {
|
|
239
|
+
override fun onCreate(savedInstanceState: Bundle?) {
|
|
240
|
+
super.onCreate(savedInstanceState)
|
|
241
|
+
|
|
242
|
+
val contactsPage = ContactsPageView(this)
|
|
243
|
+
contactsPage.setHeaderTitle("通讯录")
|
|
244
|
+
contactsPage.setup(
|
|
245
|
+
onContactClick = { contactInfo ->
|
|
246
|
+
// 跳转到您的聊天界面,单聊会话 ID 为 "c2c_" + contactInfo.userID(可参考步骤4 的 ChatActivity)
|
|
247
|
+
},
|
|
248
|
+
onGroupClick = { contactInfo ->
|
|
249
|
+
// 跳转到您的聊天界面,群聊会话 ID 为 "group_" + contactInfo.userID(可参考步骤4 的 ChatActivity)
|
|
250
|
+
}
|
|
251
|
+
)
|
|
252
|
+
setContentView(contactsPage)
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
#### 步骤6:主题设置(可选)
|
|
258
|
+
|
|
259
|
+
TUIKit 通过 `ThemeStore` 支持设置主题色与浅色 / 深色主题切换。
|
|
260
|
+
``` kotlin
|
|
261
|
+
import io.trtc.tuikit.atomicx.theme.Theme
|
|
262
|
+
import io.trtc.tuikit.atomicx.theme.ThemeStore
|
|
263
|
+
|
|
264
|
+
// 设置主题色
|
|
265
|
+
ThemeStore.shared(context).setPrimaryColor("#1C66E5")
|
|
266
|
+
|
|
267
|
+
// 切换浅色 / 深色主题
|
|
268
|
+
ThemeStore.shared(context).setTheme(Theme.lightTheme(context))
|
|
269
|
+
// ThemeStore.shared(context).setTheme(Theme.darkTheme(context))
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
#### 步骤7:音视频通话(可选)
|
|
273
|
+
|
|
274
|
+
若需在聊天中支持音视频通话,请先 [开通音视频服务](https://console.cloud.tencent.com/im),并在集成步骤中引入 `:tuicallkit-kt` 组件。**登录成功后**初始化 `TUICallEngine,`即可在 Chat 组件中正常使用该功能。
|
|
275
|
+
``` kotlin
|
|
276
|
+
import com.tencent.cloud.tuikit.engine.call.TUICallEngine
|
|
277
|
+
import com.tencent.cloud.tuikit.engine.common.TUICommonDefine
|
|
278
|
+
|
|
279
|
+
TUICallEngine.createInstance(context).init(
|
|
280
|
+
sdkAppID, userID, userSig,
|
|
281
|
+
object : TUICommonDefine.Callback {
|
|
282
|
+
override fun onSuccess() {
|
|
283
|
+
// 初始化成功,可使用音视频通话能力
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
override fun onError(errCode: Int, errMsg: String) {
|
|
287
|
+
// 初始化失败
|
|
288
|
+
}
|
|
289
|
+
}
|
|
290
|
+
)
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
## 集成 TUIKit(旧架构)
|
|
294
|
+
|
|
295
|
+
> **版本说明**
|
|
296
|
+
>
|
|
297
|
+
> - TUIKit(旧架构)为历史版本,目前已不再新增功能并逐步停止维护,主要面向存量项目继续使用。若您是新接入的项目,建议优先按上文「集成 TUIKit」章节进行集成,以获得更现代的架构、更低的接入成本与持续的功能更新。
|
|
298
|
+
> - 如您当前仍在使用旧架构 TUIKit,欢迎花 1 分钟填写这份[调研问卷](https://wj.qq.com/s2/27183285/0606/),帮我们了解您继续沿用旧版的原因,以便提供更合适的迁移支持。
|
|
299
|
+
|
|
300
|
+
**TUIKit 新架构的主要优势**
|
|
301
|
+
| | 新架构 | 旧架构 |
|
|
302
|
+
| --- | --- | --- |
|
|
303
|
+
| 开发语言 | 基于 Kotlin,借力协程与空安全,语法更简洁、更易维护 | 以 Java 为主 |
|
|
304
|
+
| 架构与自定义 | 界面与数据解耦,界面自定义更灵活、更安全 | 界面与数据耦合较高 |
|
|
305
|
+
| 主题与语言切换 | 主题、语言支持动态切换,无需重启应用 | 主题、语言切换需重启应用 |
|
|
306
|
+
| 性能与体验 | 动画更流畅,卡顿更少 | 受旧架构限制,流畅性弱于新架构 |
|
|
307
|
+
| 功能演进 | 持续支持新功能 | 仅维护,不再新增功能 |
|
|
308
|
+
|
|
309
|
+
> **消息引用与回复功能的版本兼容性:**
|
|
310
|
+
>
|
|
311
|
+
|
|
312
|
+
> 自 9.0.7652 版本起:
|
|
313
|
+
>
|
|
314
|
+
> - **消息引用(Quote)**改用 IMSDK 原生引用能力实现,与旧版本引用消息格式不兼容。新旧版本互发的引用消息无法正确解析引用内容,请将收发双方统一升级至 9.0.7652 及以上版本。
|
|
315
|
+
> - **消息回复(Reply)**功能已下线,相关接口与 UI 入口不再提供,如业务有相关需求,可参考旧版本 TUIKit 自行实现。
|
|
316
|
+
|
|
317
|
+
> **两者区别:**引用是发送新消息时附带一条历史消息的摘要卡片,点击可跳转原消息(一问一答);回复是在某条消息下追加评论并聚合成回复列表(评论区式)。
|
|
318
|
+
>
|
|
319
|
+
|
|
320
|
+
### 集成步骤
|
|
321
|
+
1. 从 GitHub 下载 [Android TUIKit 源码](https://github.com/TencentCloud/TIMSDK/tree/master/Android/TUIKit),将 `TUIKit` 目录复制到工程目录下。
|
|
322
|
+
|
|
323
|
+
2. 在 `settings.gradle` 中引入所需模块(模块相互独立,可只引入需要的模块)。核心模块如下,其余可选模块按需引入即可:
|
|
324
|
+
|
|
325
|
+
``` groovy
|
|
326
|
+
include ':app'
|
|
327
|
+
include ':tuicore'
|
|
328
|
+
project(':tuicore').projectDir = new File(settingsDir, '../TUIKit/TUICore/tuicore')
|
|
329
|
+
include ':timcommon'
|
|
330
|
+
project(':timcommon').projectDir = new File(settingsDir, '../TUIKit/TIMCommon/timcommon')
|
|
331
|
+
include ':tuichat'
|
|
332
|
+
project(':tuichat').projectDir = new File(settingsDir, '../TUIKit/TUIChat/tuichat')
|
|
333
|
+
include ':tuicontact'
|
|
334
|
+
project(':tuicontact').projectDir = new File(settingsDir, '../TUIKit/TUIContact/tuicontact')
|
|
335
|
+
include ':tuiconversation'
|
|
336
|
+
project(':tuiconversation').projectDir = new File(settingsDir, '../TUIKit/TUIConversation/tuiconversation')
|
|
337
|
+
// 搜索、社群、通话、会议及各插件等可选模块按需引入
|
|
338
|
+
```
|
|
339
|
+
3. 在 app 模块的 `build.gradle` 中添加依赖:
|
|
340
|
+
|
|
341
|
+
``` groovy
|
|
342
|
+
dependencies {
|
|
343
|
+
api project(':tuiconversation')
|
|
344
|
+
api project(':tuicontact')
|
|
345
|
+
api project(':tuichat')
|
|
346
|
+
// 其余已引入的可选模块按需添加 api project(...) 依赖
|
|
347
|
+
}
|
|
348
|
+
```
|
|
349
|
+
4. 配置 Kotlin 支持
|
|
350
|
+
|
|
351
|
+
- 如果您的项目已是 Kotlin 工程:可跳过此步。
|
|
352
|
+
|
|
353
|
+
- 如果您的项目尚未配置 Kotlin:请添加对应版本的 Kotlin Gradle 插件
|
|
354
|
+
|
|
355
|
+
> **说明:**
|
|
356
|
+
>
|
|
357
|
+
> - 本地源码集成方式升级时需从 GitHub 重新拉取最新代码覆盖本地 `TUIKit` 目录,冲突需手动合并。
|
|
358
|
+
> - 旧架构默认提供经典版与简约版两套 UI,**不能混用**:集成多个组件时必须统一选择经典版或简约版。
|
|
359
|
+
|
|
360
|
+
### 接入步骤
|
|
361
|
+
|
|
362
|
+
常用聊天软件由会话列表、聊天窗口、好友列表、音视频通话等基本界面组成,参考下列步骤即可快速搭建。
|
|
363
|
+
|
|
364
|
+
**步骤1:配置用户鉴权**
|
|
365
|
+
|
|
366
|
+
在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im/tool-usersig) 根据 UserID 获取 UserSig,用于后续登录鉴权。
|
|
367
|
+
|
|
368
|
+
**步骤2:用户登录**
|
|
369
|
+
``` java
|
|
370
|
+
TUILogin.login(context, sdkAppID, userID, userSig, new TUICallback() {
|
|
371
|
+
@Override
|
|
372
|
+
public void onSuccess() {
|
|
373
|
+
// 登录成功,可跳转聊天或会话页
|
|
374
|
+
}
|
|
375
|
+
@Override
|
|
376
|
+
public void onError(final int code, final String desc) {
|
|
377
|
+
// 登录失败,可弹框报错
|
|
378
|
+
}
|
|
379
|
+
});
|
|
380
|
+
```
|
|
381
|
+
|
|
382
|
+
> **注意:**
|
|
383
|
+
>
|
|
384
|
+
|
|
385
|
+
> 正式生产环境建议在服务端生成 UserSig,由 App 向业务服务器请求动态 UserSig 鉴权。详见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
|
|
386
|
+
>
|
|
387
|
+
|
|
388
|
+
**步骤3:构建会话列表界面**
|
|
389
|
+
|
|
390
|
+
创建 `TUIConversationFragment`(经典版)或 `TUIConversationMinimalistFragment`(简约版)并加入布局:
|
|
391
|
+
``` java
|
|
392
|
+
TUIConversationFragment conversationFragment = new TUIConversationFragment();
|
|
393
|
+
getSupportFragmentManager().beginTransaction()
|
|
394
|
+
.add(R.id.fragment_container, conversationFragment).commitAllowingStateLoss();
|
|
395
|
+
```
|
|
396
|
+
|
|
397
|
+
**步骤4:构建聊天界面**
|
|
398
|
+
|
|
399
|
+
可直接启动预置的聊天 Activity,或在自定义 Activity 中嵌入聊天 Fragment。以经典版为例:
|
|
400
|
+
``` java
|
|
401
|
+
Bundle param = new Bundle();
|
|
402
|
+
param.putInt(TUIConstants.TUIChat.CHAT_TYPE, isGroup ? V2TIMConversation.V2TIM_GROUP : V2TIMConversation.V2TIM_C2C);
|
|
403
|
+
param.putString(TUIConstants.TUIChat.CHAT_ID, chatID);
|
|
404
|
+
if (isGroup) {
|
|
405
|
+
TUICore.startActivity("TUIGroupChatActivity", param);
|
|
406
|
+
} else {
|
|
407
|
+
TUICore.startActivity("TUIC2CChatActivity", param);
|
|
408
|
+
}
|
|
409
|
+
```
|
|
410
|
+
|
|
411
|
+
**步骤5:构建联系人界面**
|
|
412
|
+
|
|
413
|
+
创建 `TUIContactFragment`(经典版)或 `TUIContactMinimalistFragment`(简约版)并加入布局:
|
|
414
|
+
``` java
|
|
415
|
+
TUIContactFragment contactFragment = new TUIContactFragment();
|
|
416
|
+
getSupportFragmentManager().beginTransaction()
|
|
417
|
+
.add(R.id.fragment_container, contactFragment).commitAllowingStateLoss();
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
**步骤6:音视频通话(可选)**
|
|
421
|
+
1. 在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im) 开通实时音视频(TRTC)服务。
|
|
422
|
+
|
|
423
|
+
2. 在 `settings.gradle` 中引入 `atomic_x` 与 `tuicallkit-kt`,并在 app 的 `build.gradle` 添加 `api project(':tuicallkit-kt')`。
|
|
424
|
+
|
|
425
|
+
3. 集成后聊天与联系人界面默认显示「视频通话」「语音通话」按钮,点击即可发起通话。
|
|
426
|
+
|
|
427
|
+
**步骤7:多人音视频(可选)**
|
|
428
|
+
|
|
429
|
+
在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im) 开通多人音视频(TUIRoomKit)免费体验,在 `settings.gradle` 引入 `tuiroomkit` 并在 app 的 `build.gradle` 添加 `api project(':tuiroomkit')`,集成后聊天界面将出现「快速会议」入口。
|
|
430
|
+
|
|
431
|
+
## 常见问题
|
|
432
|
+
|
|
433
|
+
### 音视频常见问题
|
|
434
|
+
|
|
435
|
+
##### 通话邀请的超时时间默认是多久?
|
|
436
|
+
|
|
437
|
+
通话邀请的默认超时时间是 30 秒。
|
|
438
|
+
|
|
439
|
+
##### 在邀请超时时间内,被邀请者如果离线再上线,能否立即收到邀请?
|
|
440
|
+
- 如果是单聊通话邀请,被邀请者离线再上线可以收到通话邀请,TUIKit 内部会自动唤起通话邀请界面。
|
|
441
|
+
|
|
442
|
+
- 如果是群聊通话邀请,被邀请者离线再上线后会自动拉取最近 30 秒内的邀请,TUIKit 会自动唤起群通话界面。
|
|
443
|
+
|
|
444
|
+
### 其他常见问题
|
|
445
|
+
|
|
446
|
+
##### 表情包的使用
|
|
447
|
+
|
|
448
|
+
为了尊重版权,IM Demo/TUIKit 工程中默认不包含大表情元素切图。正式上线商用前请您替换为自己设计或拥有版权的其他表情包。下图所示默认的**小黄脸表情包版权归腾讯云所有**,可有偿授权使用,如需获得授权,您可以通过升级至 [IM 企业版套餐](https://buy.cloud.tencent.com/avc) 免费使用该表情包。
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
## 组件概述
|
|
2
|
+
|
|
3
|
+
ChatSetting 是聊天设置组件集合,主要包含单聊设置(C2CChatSetting)和群聊设置(GroupChatSetting)两个核心组件。这些组件为用户提供了完整的聊天会话管理功能,包括用户信息管理、权限设置、群组管理等核心能力。
|
|
4
|
+
| <strong>单聊设置界面</strong> | <strong>群聊设置界面</strong> |
|
|
5
|
+
| --- | --- |
|
|
6
|
+
| | |
|
|
7
|
+
|
|
8
|
+
## 组件集成
|
|
9
|
+
|
|
10
|
+
ChatSetting 组件属于 TUIKit Flutter 的一部分,集成 TUIKit Flutter 即可获取并使用 ChatSetting 组件。集成方法请参考文档 TUIKit Flutter 里的集成步骤。
|
|
11
|
+
|
|
12
|
+
## 组件构成
|
|
13
|
+
|
|
14
|
+
ChatSetting 包含两个主要组件:C2CChatSetting(单聊设置)和 GroupChatSetting(群聊设置),每个组件都提供了丰富的配置选项。
|
|
15
|
+
|
|
16
|
+
### 单聊设置(C2CChatSetting)
|
|
17
|
+
|
|
18
|
+
#### 初始化参数
|
|
19
|
+
|
|
20
|
+
|参数名|类型|描述|
|
|
21
|
+
|---------|---------|---------|
|
|
22
|
+
|`userID`|`String`|聊天对象的用户 ID。|
|
|
23
|
+
|`onSendMessageClick`|`void Function({String? userID, String? groupID})`|发送消息按钮点击回调,可选参数。|
|
|
24
|
+
|`onContactDelete`|`VoidCallback`|删除联系人按钮点击回调,可选参数。|
|
|
25
|
+
|
|
26
|
+
### 群聊设置(GroupChatSetting)
|
|
27
|
+
|
|
28
|
+
#### 初始化参数
|
|
29
|
+
|
|
30
|
+
|方法名|参数|描述|
|
|
31
|
+
|---------|---------|---------|
|
|
32
|
+
|`groupID`|`String`|群组 ID,用于标识群聊。|
|
|
33
|
+
|`onSendMessageClick`|`void Function({String? userID, String? groupID})`|发送消息按钮点击回调,可选参数。|
|
|
34
|
+
|`onGroupDelete`|`VoidCallback`|解散/退出群组点击回调,可选参数。|
|
|
35
|
+
|
|
36
|
+
## 基础用法
|
|
37
|
+
|
|
38
|
+
初始化 C2CChatSetting 即可直接展示单聊设置页面,示例代码如下:
|
|
39
|
+
``` swift
|
|
40
|
+
C2CChatSetting(
|
|
41
|
+
userID: userID,
|
|
42
|
+
onSendMessageClick: ({String? userID, String? groupID}) {
|
|
43
|
+
// 处理发送消息点击事件
|
|
44
|
+
},
|
|
45
|
+
onContactDelete: () {
|
|
46
|
+
// 处理删除好友点击事件
|
|
47
|
+
},
|
|
48
|
+
);
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
初始化 GroupChatSetting 即可直接展示群聊设置页面,示例代码如下:
|
|
52
|
+
``` swift
|
|
53
|
+
GroupChatSetting(
|
|
54
|
+
groupID: groupID,
|
|
55
|
+
onGroupDelete: () {
|
|
56
|
+
// 处理删除、解散、退出群聊点击事件
|
|
57
|
+
},
|
|
58
|
+
onSendMessageClick: ({String? userID, String? groupID}) {
|
|
59
|
+
// 处理发送消息点击事件
|
|
60
|
+
},
|
|
61
|
+
);
|
|
62
|
+
```
|