@tencentcloud/sdk-mcp 1.4.6 → 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 -11
- 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 +9 -8
- 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 -41
- 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,353 @@
|
|
|
1
|
+
## 操作步骤
|
|
2
|
+
|
|
3
|
+
### 步骤1: 集成 TIMPush
|
|
4
|
+
|
|
5
|
+
完成 [厂商配置](https://cloud.tencent.com/document/product/269/123436) 后集成推送插件,下载 [TIMPush](https://github.com/TencentCloud/TIMSDK/tree/master/UE5/Push/pushdemo/Plugins/TIMPush) 并拷贝到项目的 `Plugins` 目录下,在项目主模块的 Build.cs 文件中,引入 TIMPush。
|
|
6
|
+
| 拷贝目录 | 引入插件 |
|
|
7
|
+
| --- | --- |
|
|
8
|
+
| | |
|
|
9
|
+
|
|
10
|
+
### 步骤2: 推送参数配置
|
|
11
|
+
|
|
12
|
+
【iOS】
|
|
13
|
+
|
|
14
|
+
请将您在厂商配置步骤中,获取到的 iOS APNs 推送证书, 上传至 IM 控制台。
|
|
15
|
+
|
|
16
|
+
IM 控制台会为您分配一个证书 ID,见下图:
|
|
17
|
+
|
|
18
|
+
设置 businessID:
|
|
19
|
+
|
|
20
|
+
请在 UE4 Editor 中打开“项目设置”,搜索查找 `Additional Plist Data` 并将下面文本修改后复制进入文本框中,其中 `YourBusinessID` 是必填项,而 `YourGroupID` 是当您需要统计推送的抵达和点击数据时需要修改的值
|
|
21
|
+
``` plaintext
|
|
22
|
+
<key>businessID</key><string>YourBusinessID</string><key>TIMPushAppGroupID</key><string>YourGroupID</string>
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
开启远程推送能力:
|
|
26
|
+
|
|
27
|
+
完成证书 ID 配置之后,您需要开启应用的 Push Notifications 能力:
|
|
28
|
+
- 如果您的 UE 引擎是从源代码自行编译构建的,您可以通过 “项目设置 > iOS 中勾选 Enable Remote Notifications Support” 来开启对应能力;
|
|
29
|
+
|
|
30
|
+
- 如果您的 UE 引擎是从 Epic Game 下载的,您可以通过打开 “`<proj_dir>/Config/DefaultEngine.ini`” ,在脚本的 `IOSRuntimeSettings` 中添加:
|
|
31
|
+
|
|
32
|
+
``` plaintext
|
|
33
|
+
// Some code
|
|
34
|
+
[/Script/IOSRuntimeSettings.IOSRuntimeSettings]
|
|
35
|
+
bEnableRemoteNotificationsSupport=True
|
|
36
|
+
```
|
|
37
|
+
- 或者,您也可以选择在项目根目录中使用 Xcode 打开 UE 生成的 YourProject.xcworkspace,在 Project > Target 中,点击 Signing & Capabilities 选项,点击左上角 Capability,搜索添加 Push Notifications 能力到您的项目中
|
|
38
|
+
|
|
39
|
+
【Android】
|
|
40
|
+
|
|
41
|
+
完成控制台厂商推送信息填写后,下载并添加配置文件到工程。将下载的 `timpush-configs.json` 文件添加到 TIMPush 的 `Source/ThirdParty/TIMPushLibrary/Android/TIMPush/Assets` 目录下。
|
|
42
|
+
| 下载配置文件 | 拷贝路径 |
|
|
43
|
+
| --- | --- |
|
|
44
|
+
| | |
|
|
45
|
+
|
|
46
|
+
### 步骤3: 客户端厂商配置
|
|
47
|
+
|
|
48
|
+
【iOS】
|
|
49
|
+
|
|
50
|
+
iOS 端无需进行此步骤。
|
|
51
|
+
|
|
52
|
+
【Android】
|
|
53
|
+
|
|
54
|
+
APL 相关配置 TIMPush 已配置好,只需要替换成应用自己的配置信息即可。TIMPush_APL.xml 路径在:`/Plugins/TIMPush/Source/TIMPush/`
|
|
55
|
+
|
|
56
|
+
#### 1. 推送包集成配置
|
|
57
|
+
``` xml
|
|
58
|
+
<buildGradleAdditions>
|
|
59
|
+
<insert>
|
|
60
|
+
dependencies {
|
|
61
|
+
// 版本号 “VERSION” 请前往 中获取配置。
|
|
62
|
+
// 推送主包必须要集成
|
|
63
|
+
implementation 'com.tencent.timpush:tpush:VERSION'
|
|
64
|
+
|
|
65
|
+
// 按照需要集成对应厂商
|
|
66
|
+
implementation 'com.tencent.timpush:huawei:VERSION'
|
|
67
|
+
implementation 'com.tencent.timpush:xiaomi:VERSION'
|
|
68
|
+
implementation 'com.tencent.timpush:oppo:VERSION'
|
|
69
|
+
implementation 'com.tencent.timpush:vivo:VERSION'
|
|
70
|
+
implementation 'com.tencent.timpush:honor:VERSION'
|
|
71
|
+
implementation 'com.tencent.timpush:meizu:VERSION'
|
|
72
|
+
implementation 'com.tencent.timpush:fcm:VERSION'
|
|
73
|
+
}
|
|
74
|
+
</insert>
|
|
75
|
+
</buildGradleAdditions>
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
#### **2. vivo 和荣耀适配 **(不接入该厂商不需要关注)
|
|
79
|
+
|
|
80
|
+
根据 vivo 和荣耀厂商接入指引,需要将 APPID 和 APPKEY 添加到配置文件中,否则会出现编译问题。
|
|
81
|
+
``` xml
|
|
82
|
+
<buildGradleAdditions>
|
|
83
|
+
<insert>
|
|
84
|
+
android {
|
|
85
|
+
defaultConfig {
|
|
86
|
+
manifestPlaceholders = [
|
|
87
|
+
"VIVO_APPKEY" : "xxxxxx", // VIVO AppKey
|
|
88
|
+
"VIVO_APPID" : "xxxxxx", // VIVO AppId
|
|
89
|
+
"HONOR_APPID" : "xxxxxx" // Honor AppId
|
|
90
|
+
]
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
</insert>
|
|
94
|
+
</buildGradleAdditions>
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
#### **3. 华为、荣耀和 Google FCM 适配**
|
|
98
|
+
|
|
99
|
+
按照厂商方法,集成对应的 plugin 和 json 配置文件。
|
|
100
|
+
|
|
101
|
+
> **注意:**
|
|
102
|
+
>
|
|
103
|
+
|
|
104
|
+
> 以下荣耀的适配仅 7.7.5283 及以上版本需要配置。
|
|
105
|
+
>
|
|
106
|
+
|
|
107
|
+
3.1 下载 json 配置文件,添加到插件 TIMPush 目录 `Source/ThirdParty/TIMPushLibrary/Android/TIMPush/` 目录下。
|
|
108
|
+
|
|
109
|
+
【华为】
|
|
110
|
+
|
|
111
|
+
【荣耀】
|
|
112
|
+
|
|
113
|
+
【Google FCM】
|
|
114
|
+
|
|
115
|
+
【目标路径】
|
|
116
|
+
|
|
117
|
+
3.2 plugin 相关配置已配置好,可根据需求增减和适配版本。
|
|
118
|
+
``` xml
|
|
119
|
+
<baseBuildGradleAdditions>
|
|
120
|
+
<insert>
|
|
121
|
+
allprojects {
|
|
122
|
+
repositories {
|
|
123
|
+
mavenCentral()
|
|
124
|
+
maven { url "https://mirrors.tencent.com/nexus/repository/maven-public/" }
|
|
125
|
+
maven { url "https://mirrors.tencent.com/repository/maven/liteavsdk/" }
|
|
126
|
+
maven { url 'https://developer.huawei.com/repo/' }
|
|
127
|
+
maven { url 'https://mirrors.tencent.com/repository/maven/SensitiveScan' }
|
|
128
|
+
maven { url 'https://developer.hihonor.com/repo' }
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
</insert>
|
|
132
|
+
</baseBuildGradleAdditions>
|
|
133
|
+
|
|
134
|
+
<buildscriptGradleAdditions>
|
|
135
|
+
<insert>
|
|
136
|
+
repositories {
|
|
137
|
+
mavenCentral()
|
|
138
|
+
maven { url "https://mirrors.tencent.com/nexus/repository/maven-public/" }
|
|
139
|
+
maven { url "https://mirrors.tencent.com/repository/maven/liteavsdk/" }
|
|
140
|
+
maven { url 'https://developer.huawei.com/repo/' }
|
|
141
|
+
maven { url 'https://mirrors.tencent.com/repository/maven/SensitiveScan' }
|
|
142
|
+
maven { url 'https://developer.hihonor.com/repo' }
|
|
143
|
+
}
|
|
144
|
+
dependencies {
|
|
145
|
+
classpath 'com.google.gms:google-services:4.4.3' // FCM Plugin
|
|
146
|
+
classpath 'com.huawei.agconnect:agcp:1.9.1.300' // Huawei Plugin
|
|
147
|
+
classpath 'com.hihonor.mcs:asplugin:2.0.1.300' // Honor Plugin
|
|
148
|
+
|
|
149
|
+
}
|
|
150
|
+
</insert>
|
|
151
|
+
</buildscriptGradleAdditions>
|
|
152
|
+
|
|
153
|
+
<buildGradleAdditions>
|
|
154
|
+
<insert>
|
|
155
|
+
apply plugin: 'com.google.gms.google-services' // FCM Plugin
|
|
156
|
+
apply plugin: 'com.huawei.agconnect' // Huawei Plugin
|
|
157
|
+
apply plugin: 'com.hihonor.mcs.asplugin' // Honor Plugin
|
|
158
|
+
</insert>
|
|
159
|
+
</buildGradleAdditions>
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### 步骤4:处理消息点击回调,并解析参数
|
|
163
|
+
|
|
164
|
+
如果您需要自定义解析收到的远程推送,您可按照如下方法实现:
|
|
165
|
+
|
|
166
|
+
> **注意:**
|
|
167
|
+
>
|
|
168
|
+
> 1. 注册回调时机必须放在程序入口函数中。
|
|
169
|
+
> 2. 控制台配置点击后续动作按如下配置,选择:**打开应用内指定界面,**请勿修改使用默认值。
|
|
170
|
+
|
|
171
|
+
``` cpp
|
|
172
|
+
class DemoPushListener: public PushListener {
|
|
173
|
+
public:
|
|
174
|
+
using OnRecvPushMessageCallback = std::function<void(const PushMessage &)>;
|
|
175
|
+
using OnRevokePushMessageCallback = std::function<void(const FString &)>;
|
|
176
|
+
using OnNotificationClickedCallback = std::function<void(const FString &)>;
|
|
177
|
+
|
|
178
|
+
void SetCallback(OnRecvPushMessageCallback recv_cb, OnRevokePushMessageCallback revoke_cb, OnNotificationClickedCallback clicked_cb) {
|
|
179
|
+
on_recv_message_callback_ = std::move(recv_cb);
|
|
180
|
+
on_revoke_message_callback_ = std::move(revoke_cb);
|
|
181
|
+
on_notification_clicked_callback_ = std::move(clicked_cb);
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
void OnRecvPushMessage(const PushMessage& message) override {
|
|
185
|
+
if (on_recv_message_callback_) {
|
|
186
|
+
on_recv_message_callback_(message);
|
|
187
|
+
}
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
void OnRevokePushMessage(const FString& messageID) override {
|
|
191
|
+
if (on_revoke_message_callback_) {
|
|
192
|
+
on_revoke_message_callback_(messageID);
|
|
193
|
+
}
|
|
194
|
+
}
|
|
195
|
+
void OnNotificationClicked(const FString& ext) override {
|
|
196
|
+
if (on_notification_clicked_callback_) {
|
|
197
|
+
on_notification_clicked_callback_(ext);
|
|
198
|
+
}
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
private:
|
|
202
|
+
OnRecvPushMessageCallback on_recv_message_callback_;
|
|
203
|
+
OnRevokePushMessageCallback on_revoke_message_callback_;
|
|
204
|
+
OnNotificationClickedCallback on_notification_clicked_callback_;
|
|
205
|
+
};
|
|
206
|
+
|
|
207
|
+
auto listener = new DemoPushListener();
|
|
208
|
+
listener.SetCallback(
|
|
209
|
+
[](const PushMessage& message) {
|
|
210
|
+
UE_LOG(LogTemp, Warning, TEXT("Push Called in OnRecvPushMessage. Message title: %s, desc: %s, ext: %s, id: %s"), *message.GetTitle(), *message.GetDesc(), *message.GetExt(), *message.GetMessageID());
|
|
211
|
+
},
|
|
212
|
+
[](const FString& messageID) {
|
|
213
|
+
UE_LOG(LogTemp, Warning, TEXT("Push Called in OnRevokePushMessage. Message id: %s"), *messageID);
|
|
214
|
+
},
|
|
215
|
+
[](const FString& ext) {
|
|
216
|
+
UE_LOG(LogTemp, Warning, TEXT("Push Called in OnNotificationClicked. Message ext: %s"), *ext);
|
|
217
|
+
}
|
|
218
|
+
);
|
|
219
|
+
PushManager::GetInstance()->AddPushListener(&listener);
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### 步骤5:注册推送插件
|
|
223
|
+
|
|
224
|
+
调用接口推送注册成功后,就可以收到离线推送通知了。
|
|
225
|
+
``` cpp
|
|
226
|
+
template <class T>
|
|
227
|
+
class DemoPushValueCallback : public PushValueCallback<T> {
|
|
228
|
+
public:
|
|
229
|
+
using SuccessCallback = std::function<void(const T &)>;
|
|
230
|
+
using ErrorCallback = std::function<void(int, const FString &)>;
|
|
231
|
+
|
|
232
|
+
DemoPushValueCallback<T>() = default;
|
|
233
|
+
~DemoPushValueCallback() override = default;
|
|
234
|
+
|
|
235
|
+
void SetCallback(SuccessCallback success_cb, ErrorCallback error_cb) {
|
|
236
|
+
success_callback_ = std::move(success_cb);
|
|
237
|
+
error_callback_ = std::move(error_cb);
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
void OnSuccess(const T &value) override {
|
|
241
|
+
if (success_callback_) {
|
|
242
|
+
success_callback_(value);
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
void OnError(int error_code, const FString &error_message) override {
|
|
246
|
+
if (error_callback_) {
|
|
247
|
+
error_callback_(error_code, error_message);
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
private:
|
|
252
|
+
SuccessCallback success_callback_;
|
|
253
|
+
ErrorCallback error_callback_;
|
|
254
|
+
};
|
|
255
|
+
|
|
256
|
+
auto callback = new DemoPushValueCallback<FString>();
|
|
257
|
+
callback->SetCallback(
|
|
258
|
+
[=](const FString &value) {
|
|
259
|
+
UE_LOG(LogTemp, Warning, TEXT("Push succeed, device token is %s"), *value);
|
|
260
|
+
delete callback;
|
|
261
|
+
},
|
|
262
|
+
[=](int error_code, const FString &error_message) {
|
|
263
|
+
UE_LOG(LogTemp, Warning, TEXT("Push failed erro code: %d, desc: %s"), error_code, *error_message);
|
|
264
|
+
delete callback;
|
|
265
|
+
}
|
|
266
|
+
);
|
|
267
|
+
PushManager::GetInstance()->RegisterPush(您的 sdkAppId, "您的 appKey", callback);
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
### 步骤6:消息推送触达统计
|
|
271
|
+
|
|
272
|
+
如果您需要统计触达数据,请按照如下完成配置:
|
|
273
|
+
|
|
274
|
+
【华为】
|
|
275
|
+
|
|
276
|
+
回执地址:`https://api.im.qcloud.com/v3/offline_push_report/huawei`
|
|
277
|
+
|
|
278
|
+
> **注意:**
|
|
279
|
+
>
|
|
280
|
+
|
|
281
|
+
> 华为推送证书 ID <= 11344时,使用华为推送 v2 版本接口,不支持触达和点击回执,请重新生成更新证书 ID。
|
|
282
|
+
>
|
|
283
|
+
|
|
284
|
+
【荣耀】
|
|
285
|
+
|
|
286
|
+
回执地址:`https://api.im.qcloud.com/v3/offline_push_report/honor`
|
|
287
|
+
|
|
288
|
+
【vivo】
|
|
289
|
+
|
|
290
|
+
|回调地址配置|回执 ID 配置到 IM 控制台|
|
|
291
|
+
|---------|---------|
|
|
292
|
+
|<br>回执地址:`https://api.im.qcloud.com/v3/offline_push_report/vivo`||
|
|
293
|
+
|
|
294
|
+
【魅族】
|
|
295
|
+
|
|
296
|
+
|打开回执开关|配置回执地址|
|
|
297
|
+
|---------|---------|
|
|
298
|
+
|||
|
|
299
|
+
|
|
300
|
+
回执地址:`https://api.im.qcloud.com/v3/offline_push_report/meizu`
|
|
301
|
+
|
|
302
|
+
> **注意:**
|
|
303
|
+
>
|
|
304
|
+
|
|
305
|
+
> 打开回执开关后,请务必确保回执地址正确配置。不配置或者配置地址错误,都会影响推送功能。
|
|
306
|
+
>
|
|
307
|
+
|
|
308
|
+
【iOS】
|
|
309
|
+
1. 如果您需要统计推送的抵达和点击数据,您需要在上文的 “项目设置” 中将“YourGroupID”修改为您自己的 App Group ID (生成方式可参见 厂商配置-生成 App GroupID)。
|
|
310
|
+
|
|
311
|
+
2. 在完成 App Group ID 的配置后,您需要使用 Xcode 打开 UE 在项目目录生成的 xcworkspace 文件,并参考 厂商配置-生成 App GroupID-步骤四 中的方法配置您的 App Group ID。之后,请在 Xcode 项目中的 `Editor - Add Target` 中开启 Notification Service Extension Target。
|
|
312
|
+
|
|
313
|
+
3. 您还需要将项目根目录的 `Plugins-TIMPush-Source-ThirdParty-TIMPushLibrary-iOS` 路径中的两个 framework 压缩包解压缩,并在 Xcode 项目中将内部的 .framework 文件夹添加到您的 pushservice target 之中。
|
|
314
|
+
|
|
315
|
+
4. 您现在可以在 [Notification Service Extension](https://github.com/TencentCloud/TIMSDK/blob/master/iOS/Demo/pushservice/NotificationService.m) 的 `-didReceiveNotificationRequest:withContentHandler:` 方法中调用推送抵达率统计函数:
|
|
316
|
+
|
|
317
|
+
``` objectivec
|
|
318
|
+
@implementation NotificationService
|
|
319
|
+
|
|
320
|
+
- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
|
|
321
|
+
//appGroup 标识当前主 APP 和 Extension 之间共享的 APP Group,需要在主 APP 的 Capability 中配置 App Groups 能力。
|
|
322
|
+
//格式为group + [主bundleID]+ key
|
|
323
|
+
//如group.com.tencent.im.pushkey
|
|
324
|
+
NSString * appGroupID = kTIMPushAppGroupKey;
|
|
325
|
+
__weak typeof(self) weakSelf = self;
|
|
326
|
+
[TIMPushManager handleNotificationServiceRequest:request appGroupID:appGroupID callback:^(UNNotificationContent *content) {
|
|
327
|
+
weakSelf.bestAttemptContent = [content mutableCopy];
|
|
328
|
+
// Modify the notification content here...
|
|
329
|
+
// self.bestAttemptContent.title = [NSString stringWithFormat:@"%@ [modified]", self.bestAttemptContent.title];
|
|
330
|
+
weakSelf.contentHandler(weakSelf.bestAttemptContent);
|
|
331
|
+
}];
|
|
332
|
+
}
|
|
333
|
+
|
|
334
|
+
@end
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
> **注意:**
|
|
338
|
+
>
|
|
339
|
+
> 5. 上报推送触达数据,需要开启 mutable-content 开关来支持 iOS 10 的 Extension 功能。
|
|
340
|
+
|
|
341
|
+
> 6. 数据详情可在推送数据页面查看,推送数据页面仅限 [购买推送插件](https://console.cloud.tencent.com/im/plugin/TIMPush) 后使用。
|
|
342
|
+
|
|
343
|
+
其余支持厂商不需要配置,FCM 暂不支持推送统计功能。
|
|
344
|
+
|
|
345
|
+
恭喜您已经完成了推送插件的接入,需要提醒您:推送插件**试用或购买到期后,将自动停止提供推送服务(包括普通消息离线推送、全员/标签推送等服务)**。为避免影响您业务正常使用,请提前 [购买](https://buy.cloud.tencent.com/avc)/[续费](https://console.cloud.tencent.com/account/renewal)。
|
|
346
|
+
|
|
347
|
+
> **说明:**
|
|
348
|
+
>
|
|
349
|
+
> 1. 厂商离线通道都有 [消息分类机制](https://cloud.tencent.com/document/product/269/100649),不同类型也会有不同的推送策略。
|
|
350
|
+
> - 如果推送需求属于 IM 类型推送,想要推送及时触达,需要按照厂商规则设置自己应用为对应的推送类型,会归类为高优先级的系统消息类型或者重要消息类型。
|
|
351
|
+
> - 反之,离线推送会有数量和频次的限制,可能不会及时推送到设备。
|
|
352
|
+
> 2. 接入完成收不到推送,请先自助使用 [排查工具](https://cloud.tencent.com/document/product/269/100629) 查看下具体原因。推送指标数据查看,请使用 [数据统计](https://cloud.tencent.com/document/product/269/100628) 查询。
|
|
353
|
+
> 3. 全员/标签推送功能请参见:[REST API 接口 - 发起全员/标签推送](https://cloud.tencent.com/document/product/269/100634)。
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
在接入推送服务之前,请务必开通 Push 服务,否则后续接入流程会失败。
|
|
2
|
+
|
|
3
|
+
## 开通 Push 服务
|
|
4
|
+
1. 登录 [腾讯云即时通信 IM 管理后台](https://console.cloud.tencent.com/im),在**应用管理**页点击**创建新应用**。
|
|
5
|
+
|
|
6
|
+
2. 选择**免费开通**消息推送 Push。
|
|
7
|
+
|
|
8
|
+
3. 填写**应用名称**,选择合适的**数据中心**。
|
|
9
|
+
|
|
10
|
+
4. 创建 Push 应用成功后,Push 的概览页能看到刚才创建的 SDKAppID。继续点击**免费领取**或**立即购买**,开通 Push 服务:
|
|
11
|
+
|
|
12
|
+
5. 开通推送服务 Push 后,能在当前页看到推送数据统计信息:
|
|
13
|
+
|
|
14
|
+
6. 与此同时,消息服务 Chat 里会自动创建一个相同 SDKAppID 的应用。
|
|
15
|
+
|
|
16
|
+
> **注意:**
|
|
17
|
+
>
|
|
18
|
+
> - **如果您需要使用 Chat 服务发送消息,请记录下该 Chat 应用的信息,否则可以忽略。**
|
|
19
|
+
> - 自动创建的消息服务 Chat 应用和手动创建的推送服务 Push 应用的 SDKAppID 相同,但密钥不同,注意区分。
|
|
20
|
+
|
|
21
|
+
## 接入流程说明
|
|
22
|
+
|
|
23
|
+
开通服务后,可进入接入流程。接入流程主要分为 3 步:
|
|
24
|
+
1. 厂商配置:完成各平台厂商配置。该步骤是离线推送链路的基础,决定哪些设备能从厂商通道收到推送。
|
|
25
|
+
|
|
26
|
+
2. SDK 接入:完成各平台 TIMPush 接入。完成后即可收到基础离线推送通知。
|
|
27
|
+
|
|
28
|
+
3. 高级功能设置(可选):包括消息分类、自定义角标、铃声、小图标、点击跳转、推送触达统计等,用于优化推送体验、满足厂商合规要求。请在基础链路验证通过后再按需启用,便于隔离问题、定位故障。
|
|
29
|
+
|
|
30
|
+
建议按上述顺序完成接入,每一步验证通过后再进入下一步,并参考对应平台或厂商文档进行配置。
|
|
@@ -8,14 +8,14 @@
|
|
|
8
8
|
## 核心概念
|
|
9
9
|
|
|
10
10
|
在开始集成之前,需要通过下表了解一下`RoomStore`中与会中呼叫相关的几个核心概念:
|
|
11
|
-
|
|
|
11
|
+
| <strong>核心概念</strong> | <strong>类型</strong> | <strong>核心职责与描述</strong> |
|
|
12
12
|
| --- | --- | --- |
|
|
13
|
-
|
|
|
14
|
-
|
|
|
15
|
-
|
|
|
16
|
-
|
|
|
17
|
-
|
|
|
18
|
-
|
|
|
13
|
+
| <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-room-call-status/index.html">RoomCallStatus</a> | <code>enum class</code> | 代表会中呼叫的状态,包含:<br>- <code>NONE</code>(默认态)。<br>- <code>CALLING</code>(呼叫中)。<br>- <code>TIMEOUT</code>(呼叫超时)。<br>- <code>REJECTED</code>(呼叫被拒绝)。 |
|
|
14
|
+
| <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-room-call-result/index.html">RoomCallResult</a> | <code>enum class</code> | 代表会中呼叫的结果,包含:<br>- <code>SUCCESS</code>(呼叫成功)。<br>- <code>ALREADY_IN_CALLING</code>(已在呼叫中)。<br>- <code>ALREADY_IN_ROOM</code>(已在房间中)。 |
|
|
15
|
+
| <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-call-rejection-reason/index.html">CallRejectionReason</a> | <code>enum class</code> | 代表呼叫被拒绝的原因,目前仅支持:<br>- <code>REJECTED</code>当有其他用户向被呼叫方发起入会邀请时触发(主动拒绝)。<br>- <code>IN_OTHER_ROOM</code>(在其他房间中)。 |
|
|
16
|
+
| <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-room-call/index.html">RoomCall</a> | <code>data class</code> | 代表会中呼叫业务的核心数据结构。负责存储呼叫者信息、被呼叫者信息、以及当前呼叫状态。 |
|
|
17
|
+
| <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-room-listener/index.html">RoomListener</a> | <code>abstract class</code> | 代表房间动态的实时事件。其中包含会中呼叫相关的事件。 |
|
|
18
|
+
| <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-room-store/index.html">RoomStore</a> | <code>abstract class</code> | 这是与房间全生命周期相关的核心类。功能包含:发起会中呼叫,响应会中呼叫,获取房间的会中呼叫列表,并通过订阅其 <code>RoomListener</code> 来接收与会中呼叫相关的实时动态事件。 |
|
|
19
19
|
|
|
20
20
|
## 实现步骤
|
|
21
21
|
|
|
@@ -134,12 +134,13 @@ fun subscribeRoomCallEvents() {
|
|
|
134
134
|
```
|
|
135
135
|
|
|
136
136
|
**呼叫事件函数详细说明**
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
|
141
|
-
|
|
|
142
|
-
|
|
|
137
|
+
|
|
138
|
+
|事件函数|触发时机与说明|
|
|
139
|
+
|---------|---------|
|
|
140
|
+
|[onCallTimeout](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-room-listener/on-call-timeout.html)|呼叫超时。当呼叫请求在预设的时间内(由调用 callUserToRoom 时指定)未得到被呼叫方的响应时触发。此时,呼叫自动结束,呼叫方通常需要提示“对方无人接听”。|
|
|
141
|
+
|[onCallAccepted](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-room-listener/on-call-accepted.html)|呼叫被接受。被呼叫方主动点击了“接听”或“接受”按钮。收到此回调后,表示双方已达成呼叫意图,呼叫方通常应立即执行进入房间或开始推流的操作。|
|
|
142
|
+
|[onCallRejected](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-room-listener/on-call-rejected.html)|呼叫被拒绝。被呼叫方主动拒绝了通话请求,或者因为被呼叫方当前正处于其他房间中而自动拒绝。回调中通常包含拒绝原因(例如主动拒绝或在其他房间中)。|
|
|
143
|
+
|[onCallHandledByOtherDevice](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-room-listener/on-call-handled-by-other-device.html)|呼叫已在其他设备处理。当用户在多个设备(如手机和 iPad)同时登录时,如果呼叫已在其中一台设备上被处理(接受或拒绝),当前设备会收到此通知,用于同步 UI 状态并自动消除呼叫界面。|
|
|
143
144
|
|
|
144
145
|
### 步骤3:被呼叫方功能
|
|
145
146
|
|
|
@@ -173,11 +174,12 @@ fun subscribeRoomCallEvents() {
|
|
|
173
174
|
```
|
|
174
175
|
|
|
175
176
|
**事件函数详细说明**
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
|
180
|
-
|
|
|
177
|
+
|
|
178
|
+
|事件函数|触发时机与说明|
|
|
179
|
+
|---------|---------|
|
|
180
|
+
|[onCallReceived](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-room-listener/on-call-received.html)|收到呼叫邀请。当有其他用户向您发起入会邀请时触发。收到此回调后,被呼叫方通常应立即弹出“呼叫提醒”界面,展示呼叫者信息、房间信息,并提供“接听”和“拒绝”按钮。|
|
|
181
|
+
|[onCallCancelled](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-room-listener/on-call-cancelled.html)|呼叫被发起方取消。呼叫方在被呼叫方callUserToRoom未做出响应前,主动撤回了呼叫请求。收到此回调后,被呼叫方应立即关闭当前的来电界面,并提示“对方已取消呼叫”,以恢复应用正常操作流程。|
|
|
182
|
+
|[onCallRevokedByAdmin](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-room-listener/on-call-revoked-by-admin.html)|呼叫被管理员撤销。房间管理员或后台系统因权限变更、房间解散等原因强行终止了该笔呼叫邀请。收到此通知后,被呼叫方需立即停止呼叫流程并隐藏相关 UI,处理逻辑通常类似于呼叫被取消。|
|
|
181
183
|
|
|
182
184
|
#### **2. 接受呼叫、拒绝呼叫**
|
|
183
185
|
|
|
@@ -229,6 +231,6 @@ fun rejectCall(roomID: String, reason: CallRejectionReason = CallRejectionReason
|
|
|
229
231
|
```
|
|
230
232
|
|
|
231
233
|
## API 文档
|
|
232
|
-
|
|
|
234
|
+
| <strong>Store/Component</strong> | <strong>功能描述</strong> | <strong>API文档</strong> |
|
|
233
235
|
| --- | --- | --- |
|
|
234
|
-
|
|
|
236
|
+
| <strong>RoomStore</strong> | 房间全生命周期管理:创建并加入 / 加入 / 离开 / 结束房间 / 更新、获取房间信息 / 房间预约 / 呼叫房间外成员 / 监听房间内被动事件(例如房间解散,房间信息更新等)。 | <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-room-store/index.html">API 文档</a> |
|