@tencentcloud/sdk-mcp 1.6.3 → 1.6.5
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 -4
- package/knowledge/build-index.js +1 -1
- package/knowledge/chunker.js +81 -52
- package/knowledge/path-meta.js +181 -21
- package/knowledge/search/exact-lookup.js +166 -0
- package/knowledge/search/filter-pool.js +73 -19
- package/knowledge/search/product-scope-intent.js +2 -2
- package/knowledge/search/requires-framework.js +1 -1
- package/knowledge/search/search-knowledge.js +234 -57
- package/package.json +1 -1
- package/resource/_schema/feature-aliases.yaml +1 -0
- package/resource/integration/callkit/preset/android/integration.md +3 -5
- package/resource/integration/callkit/preset/flutter/integration.md +2 -3
- package/resource/integration/callkit/preset/ios/integration.md +2 -5
- package/resource/integration/callkit/preset/react/integration.md +12 -26
- package/resource/integration/callkit/preset/vue/integration.md +17 -33
- package/resource/integration/chat/preset/android/integration.md +44 -14
- package/resource/integration/chat/preset/flutter/integration.md +54 -13
- package/resource/integration/chat/preset/ios/integration.md +42 -6
- package/resource/integration/chat/preset/react/integration.md +30 -28
- package/resource/integration/chat/preset/uni-app/integration.md +101 -40
- package/resource/integration/chat/preset/vue/integration.md +62 -28
- package/resource/integration/livekit/preset/live/android/live-audience-integration.md +133 -0
- package/resource/integration/livekit/preset/live/android/live-host-integration.md +225 -0
- package/resource/integration/livekit/preset/live/android/live-list-integration.md +278 -0
- package/resource/integration/livekit/preset/live/android/prepare-integration.md +271 -0
- package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +207 -0
- package/resource/integration/livekit/preset/live/ios/live-host-integration.md +358 -0
- package/resource/integration/livekit/preset/live/ios/live-list-integration.md +246 -0
- package/resource/integration/livekit/preset/live/ios/prepare-integration.md +218 -0
- package/resource/integration/livekit/preset/live/vue/live-list-integration.md +4 -7
- package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +5 -12
- package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +4 -11
- package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +250 -482
- package/resource/integration/roomkit/preset/vue/integration.md +399 -106
- package/resource/knowledge/callkit/best-practice/web/callengine-invitation.md +80 -0
- package/resource/knowledge/callkit/best-practice/web/callengine-log-control.md +20 -0
- package/resource/knowledge/callkit/best-practice/web/callkit-call-vs-calls.md +116 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +11 -15
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +10 -13
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +2 -4
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +10 -17
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +11 -17
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +11 -20
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +10 -15
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +9 -14
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +12 -18
- package/resource/knowledge/callkit/core-sdk/miniprogram/call-engine.md +390 -0
- package/resource/knowledge/callkit/core-sdk/miniprogram/call-event.md +317 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +16 -22
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +17 -23
- package/resource/knowledge/callkit/core-sdk/web/call-engine.md +39 -0
- package/resource/knowledge/callkit/core-sdk/web/call-event.md +341 -0
- package/resource/knowledge/callkit/core-sdk/web/callengine-api-overview.md +39 -0
- package/resource/knowledge/callkit/faq/android.md +1 -5
- package/resource/knowledge/callkit/faq/common.md +10 -12
- package/resource/knowledge/callkit/faq/ios.md +5 -7
- package/resource/knowledge/callkit/faq/uniapp-app.md +7 -7
- package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +9 -12
- package/resource/knowledge/callkit/faq/web.md +2 -12
- package/resource/knowledge/callkit/preset/android/api.md +5 -8
- package/resource/knowledge/callkit/preset/ios/api.md +4 -6
- package/resource/knowledge/callkit/preset/miniprogram/api.md +295 -0
- package/resource/knowledge/callkit/preset/react/api.md +622 -0
- package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +475 -0
- package/resource/knowledge/callkit/preset/vue/api.md +622 -0
- package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +587 -0
- package/resource/knowledge/callkit/preset/web/api.md +1 -1
- package/resource/knowledge/chat/best-practice/web/image-message-url-handling.md +16 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +1 -1
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +0 -1
- package/resource/knowledge/chat/preset/android/features/language.md +2 -4
- package/resource/knowledge/chat/preset/android/features/message-input.md +1 -1
- package/resource/knowledge/chat/preset/android/features/message-list.md +1 -2
- package/resource/knowledge/chat/preset/android/features/search.md +0 -1
- package/resource/knowledge/chat/preset/android/features/theme.md +1 -1
- package/resource/knowledge/chat/preset/android-view/integration.md +35 -10
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +0 -1
- package/resource/knowledge/chat/preset/flutter/features/language.md +1 -1
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +0 -1
- package/resource/knowledge/chat/preset/flutter/features/search.md +4 -5
- package/resource/knowledge/chat/preset/flutter/features/theme.md +1 -1
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +1 -1
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +0 -1
- package/resource/knowledge/chat/preset/ios/features/language.md +2 -5
- package/resource/knowledge/chat/preset/ios/features/message-list.md +0 -1
- package/resource/knowledge/chat/preset/ios/features/search.md +0 -1
- package/resource/knowledge/chat/preset/ios/features/theme.md +1 -1
- package/resource/knowledge/chat/preset/ios-uikit/integration.md +57 -166
- package/resource/knowledge/chat/preset/react/features/chat-setting.md +0 -1
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +3 -3
- package/resource/knowledge/chat/preset/react/features/conversation-list.md +3 -3
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +1 -1
- package/resource/knowledge/chat/preset/react/features/message-input.md +2 -3
- package/resource/knowledge/chat/preset/react/features/search.md +0 -1
- package/resource/knowledge/chat/preset/vue/features/chat-header.md +1 -1
- package/resource/knowledge/chat/preset/vue/features/chat-setting.md +3 -4
- package/resource/knowledge/chat/preset/vue/features/conversation-list.md +4 -4
- package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +1 -1
- package/resource/knowledge/chat/preset/vue/features/message-input.md +2 -2
- package/resource/knowledge/chat/preset/vue/features/message-list.md +2 -2
- package/resource/knowledge/chat/preset/vue/features/search.md +0 -1
- package/resource/knowledge/chat/preset/vue/features/theme.md +4 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +2 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +12 -15
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +3 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +12 -15
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +2 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +3 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/vue/capability-matrix.md +82 -0
- package/resource/knowledge/livekit/core-sdk/{voice/android/voice-audio-effect.md → features/android/audio-effect.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/{live/android/live-barrage.md → features/android/barrage.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{live/android/live-base-beauty.md → features/android/base-beauty.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{voice/android/voice-gift.md → features/android/gift.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/{live/android/live-live-list.md → features/android/live-list.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{live/flutter/live-audio-effect.md → features/flutter/audio-effect.md} +0 -2
- package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-barrage.md → features/flutter/barrage.md} +3 -3
- package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-gift.md → features/flutter/gift.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-room-list.md → features/flutter/live-list.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-audience-list.md → features/ios/audience-list.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-audio-effect.md → features/ios/audio-effect.md} +1 -3
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-barrage.md → features/ios/barrage.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/{live/ios/live-base-beauty.md → features/ios/base-beauty.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{live/ios/live-gift.md → features/ios/gift.md} +8 -9
- package/resource/knowledge/livekit/core-sdk/{live/ios/live-live-list.md → features/ios/live-list.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-audio-effect.md → features/uni-app/audio-effect.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-barrage.md → features/uni-app/barrage.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/features/uni-app/base-beauty.md +145 -0
- package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-gift.md → features/uni-app/gift.md} +6 -7
- package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-room-list.md → features/uni-app/live-list.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/live/android/{live-co-guest-interaction.md → co-guest-interaction.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/live/android/{live-host-interaction.md → host-interaction.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/live/android/{live-integration.md → integration.md} +6 -9
- package/resource/knowledge/livekit/core-sdk/live/flutter/{live-host-interaction.md → host-interaction.md} +1 -3
- package/resource/knowledge/livekit/core-sdk/live/flutter/{live-integration.md → integration.md} +1 -6
- package/resource/knowledge/livekit/core-sdk/live/ios/{live-co-guest-interaction.md → co-guest-interaction.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/live/ios/{live-host-interaction.md → host-interaction.md} +3 -5
- package/resource/knowledge/livekit/core-sdk/live/ios/{live-integration.md → integration.md} +7 -10
- package/resource/knowledge/livekit/core-sdk/live/uni-app/co-guest-interaction.md +561 -0
- package/resource/knowledge/livekit/core-sdk/live/uni-app/host-interaction.md +323 -0
- package/resource/knowledge/livekit/core-sdk/live/uni-app/integration.md +312 -0
- package/resource/knowledge/livekit/core-sdk/voice/android/{voice-co-guest-interaction.md → co-guest-interaction.md} +3 -3
- package/resource/knowledge/livekit/core-sdk/voice/android/{voice-host-interaction.md → host-interaction.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/voice/android/{voice-integration.md → integration.md} +11 -14
- package/resource/knowledge/livekit/core-sdk/voice/flutter/{voice-co-guest-interaction.md → co-guest-interaction.md} +0 -1
- package/resource/knowledge/livekit/core-sdk/voice/flutter/{voice-integration.md → integration.md} +1 -4
- package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-co-guest-interaction.md → co-guest-interaction.md} +3 -3
- package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-host-interaction.md → host-interaction.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-integration.md → integration.md} +7 -10
- package/resource/knowledge/livekit/core-sdk/voice/uni-app/{voice-co-guest-interaction.md → co-guest-interaction.md} +6 -6
- package/resource/knowledge/livekit/core-sdk/voice/uni-app/{voice-integration.md → integration.md} +6 -7
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +2 -3
- package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +1 -1
- package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +1 -1
- package/resource/knowledge/push/api-reference/android.md +337 -0
- package/resource/knowledge/push/api-reference/donut.md +190 -0
- package/resource/knowledge/push/api-reference/flutter.md +176 -0
- package/resource/knowledge/push/api-reference/harmonyos.md +140 -0
- package/resource/knowledge/push/api-reference/ios.md +537 -0
- package/resource/knowledge/push/api-reference/react-native.md +154 -0
- package/resource/knowledge/push/api-reference/uni-app.md +148 -0
- package/resource/knowledge/push/api-reference/unity.md +119 -0
- package/resource/knowledge/push/api-reference/unreal-engine.md +123 -0
- package/resource/knowledge/push/config/android/fcm.md +1 -8
- package/resource/knowledge/push/config/android/honor.md +3 -7
- package/resource/knowledge/push/config/android/huawei.md +0 -5
- package/resource/knowledge/push/config/android/meizu.md +0 -5
- package/resource/knowledge/push/config/android/oppo.md +0 -4
- package/resource/knowledge/push/config/android/vivo.md +0 -4
- package/resource/knowledge/push/config/android/xiaomi.md +0 -2
- package/resource/knowledge/push/config/donut.md +33 -46
- package/resource/knowledge/push/config/harmonyos.md +6 -9
- package/resource/knowledge/push/config/ios.md +2 -9
- package/resource/knowledge/push/config/react-native.md +17 -25
- package/resource/knowledge/push/config/unity.md +16 -24
- package/resource/knowledge/push/config/unreal-engine.md +16 -24
- package/resource/knowledge/push/integration/android.md +21 -21
- package/resource/knowledge/push/integration/donut.md +24 -34
- package/resource/knowledge/push/integration/flutter.md +12 -1
- package/resource/knowledge/push/integration/harmonyos.md +2 -1
- package/resource/knowledge/push/integration/ios.md +16 -10
- package/resource/knowledge/push/integration/react-native.md +10 -14
- package/resource/knowledge/push/integration/uni-app.md +10 -6
- package/resource/knowledge/push/integration/unity.md +19 -22
- package/resource/knowledge/push/integration/unreal-engine.md +7 -9
- package/resource/knowledge/push/overview/prepare.md +2 -2
- package/resource/knowledge/roomkit/core-sdk/android/capability-matrix.md +46 -0
- package/resource/knowledge/roomkit/core-sdk/android/unsupported-features.md +82 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/capability-matrix.md +46 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/flutter/unsupported-features.md +82 -0
- package/resource/knowledge/roomkit/core-sdk/ios/capability-matrix.md +46 -0
- package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/ios/unsupported-features.md +82 -0
- package/resource/knowledge/roomkit/core-sdk/vue/call-user-to-room.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +2 -5
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +0 -3
- package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +2 -6
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +0 -1
- package/resource/knowledge/roomkit/core-sdk/vue/schedule-room.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +2 -4
- package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +2 -3
- package/resource/knowledge/roomkit/preset/android/integration.md +14 -16
- package/resource/knowledge/roomkit/preset/flutter/integration.md +9 -17
- package/resource/knowledge/roomkit/preset/ios/integration.md +9 -17
- package/resource/knowledge/roomkit/preset/react/integration.md +0 -4
- package/resource/knowledge/trtc/android/TRTCCloud.md +97 -180
- package/resource/knowledge/trtc/android/TRTCCloudDef.md +20 -20
- package/resource/knowledge/trtc/android/TRTCCloudListener.md +43 -77
- package/resource/knowledge/trtc/android/TRTCStatistics.md +1 -1
- package/resource/knowledge/trtc/android/TXAudioEffectManager.md +4 -24
- package/resource/knowledge/trtc/android/TXDeviceManager.md +2 -2
- package/resource/knowledge/trtc/android/TXLiteAVCode.md +1 -1
- package/resource/knowledge/trtc/c++/ITRTCCloud.md +96 -189
- package/resource/knowledge/trtc/c++/ITRTCStatistics.md +1 -1
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +1 -21
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +4 -6
- package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +42 -76
- package/resource/knowledge/trtc/c++/TRTCTypeDef.md +18 -19
- package/resource/knowledge/trtc/c++/TXLiteAVCode.md +1 -1
- package/resource/knowledge/trtc/ios/TRTCCloud.md +95 -181
- package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +43 -78
- package/resource/knowledge/trtc/ios/TRTCStatistics.md +1 -1
- package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +1 -20
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +4 -6
- package/resource/knowledge/trtc/ios/TXLiteAVCode.md +1 -1
- package/resource/knowledge/trtc/ios/TXLiveSDKTypeDef.md +20 -20
- package/server-config.js +7 -4
- package/server.js +2 -2
- package/tools/common/finalize_answer.js +1 -1
- package/tools/common/present_framework_choice.js +2 -2
- package/tools/common/search_trtc_knowledge.js +3 -3
- package/tools/common/submit_feedback.js +1 -1
- package/tools/definitions/get_native_live_uikit_integration_def.js +60 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js +1 -1
- package/tools/definitions/present_framework_choice_def.js +2 -2
- package/tools/definitions/search_trtc_knowledge_def.js +5 -5
- package/tools/index.js +2 -0
- package/tools/live/get_native_live_uikit_integration.js +69 -0
- package/tools/live/get_native_livekit_core_integration.js +6 -6
- package/utils/is-valid-sdkappid.js +4 -0
- package/utils/report-cls-client.js +1 -1
- package/utils/report-es-client.js +1 -1
- package/resource/index/component-slugs.json +0 -1
- package/resource/index/doc-source-urls.json +0 -1
- package/resource/index/manifest.json +0 -1
- package/resource/knowledge/livekit/core-sdk/live/android/live-audio-effect.md +0 -229
- package/resource/knowledge/livekit/core-sdk/live/android/live-gift.md +0 -459
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-barrage.md +0 -506
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-gift.md +0 -427
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-live-list.md +0 -726
- package/resource/knowledge/livekit/core-sdk/live/ios/live-audience-list.md +0 -265
- package/resource/knowledge/livekit/core-sdk/live/ios/live-audio-effect.md +0 -214
- package/resource/knowledge/livekit/core-sdk/live/ios/live-barrage.md +0 -427
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-audience-list.md +0 -272
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-barrage.md +0 -486
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +0 -523
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audience-list.md +0 -262
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audio-effect.md +0 -600
- package/resource/knowledge/livekit/core-sdk/voice/ios/voice-gift.md +0 -411
- package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +0 -404
- /package/resource/knowledge/livekit/core-sdk/api-reference/{web → vue}/index.md +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/android/live-audience-list.md → features/android/audience-list.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/flutter/live-audience-list.md → features/flutter/audience-list.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/flutter/live-base-beauty.md → features/flutter/base-beauty.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-audience-list.md → features/uni-app/audience-list.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/live/flutter/{live-co-guest-interaction.md → co-guest-interaction.md} +0 -0
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
## 接口概览
|
|
2
|
+
| API | 描述 |
|
|
3
|
+
| --- | --- |
|
|
4
|
+
| <code>registerPush</code> | 注册推送服务, (必须在 App 用户同意了隐私政策后,再调用该接口使用推送服务)。 |
|
|
5
|
+
| <code>unRegisterPush</code> | 反注册关闭推送服务。 |
|
|
6
|
+
| <code>setRegistrationID</code> | 设置推送设备标识 ID。<br>- RegistrationID 是推送接收设备的唯一标识 ID。默认情况下,注册推送服务成功时自动生成该 ID,同时也支持您自定义设置。<strong>请注意!如您调用此接口,请务必在</strong> <code>registerPush</code> <strong>前调用</strong>。<br>- 适用场景举例:<br>若您同时集成了消息服务(Chat)和推送服务(Push),在某个设备上,用户登录 Chat 的 userID 假设为 "user123",如果您想指定向 "user123" 推送消息,则需要调用此接口设置设备标识 ID,如下:<br><code>Push.setRegistrationID("user123", () => {});</code> |
|
|
7
|
+
| <code>getRegistrationID</code> | 在成功注册推送服务后,调用此接口可获取推送接收设备的唯一标识 ID,即 RegistrationID。 |
|
|
8
|
+
| <code>getNotificationExtInfo</code> | 收到离线推送时,点击通知栏拉起 App,调用此接口可获取推送扩展信息。 |
|
|
9
|
+
| <code>addPushListener</code> | 添加 Push 监听器。 |
|
|
10
|
+
| <code>removePushListener</code> | 移除 Push 监听器。 |
|
|
11
|
+
| <code>disablePostNotificationInForeground</code> | 应用在前台时,开/关通知栏通知(默认开)。 |
|
|
12
|
+
| <code>createNotificationChannel</code> | 创建客户端通知 channel。此接口可在 Android 平台上实现自定义铃音功能。 |
|
|
13
|
+
|
|
14
|
+
## 接口详情
|
|
15
|
+
|
|
16
|
+
### 注册推送服务
|
|
17
|
+
|
|
18
|
+
#### 接口
|
|
19
|
+
``` javascript
|
|
20
|
+
registerPush(SDKAppID: number, appKey: string, onSuccess: (data: string) => void, onError?: (errCode: number, errMsg: string) => void);
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
#### 参数说明:
|
|
24
|
+
| 参数 | 类型 | 说明 | 获取路径 |
|
|
25
|
+
| --- | --- | --- | --- |
|
|
26
|
+
| SDKAppID | Number | 推送服务 Push 的 SDKAppID。 | <a href="https://console.cloud.tencent.com/im/push-plugin-push-identifier">IM 控制台 > 推送服务 Push > 概览</a> |
|
|
27
|
+
| appKey | String | 推送服务 Push 的客户端密钥。 | |
|
|
28
|
+
| onSuccess | Function | 注册推送成功的回调。 | - |
|
|
29
|
+
| onError | Function |undefined | 注册推送失败的回调。 | - |
|
|
30
|
+
|
|
31
|
+
### 反注册关闭推送服务
|
|
32
|
+
|
|
33
|
+
#### 接口
|
|
34
|
+
``` javascript
|
|
35
|
+
unRegisterPush(onSuccess: () => void, onError?: (errCode: number, errMsg: string) => void): void;
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
#### 参数说明:
|
|
39
|
+
|
|
40
|
+
|参数|类型|说明|
|
|
41
|
+
|---------|---------|---------|
|
|
42
|
+
|onSuccess|Function|反注册推送成功的回调。|
|
|
43
|
+
|onError|Function |undefined|反注册推送失败的回调。|
|
|
44
|
+
|
|
45
|
+
### 设置推送 ID 标识 RegistrationID
|
|
46
|
+
|
|
47
|
+
> **说明:**
|
|
48
|
+
>
|
|
49
|
+
> 需要在注册推送服务之前调用。
|
|
50
|
+
>
|
|
51
|
+
|
|
52
|
+
#### 接口
|
|
53
|
+
``` javascript
|
|
54
|
+
setRegistrationID(registrationID: string, onSuccess: () => void): void;
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
#### 参数说明:
|
|
58
|
+
|
|
59
|
+
|参数|类型|说明|
|
|
60
|
+
|---------|---------|---------|
|
|
61
|
+
|registrationID|String|自定义的推送 ID 标识。|
|
|
62
|
+
|onSuccess|Function|设置自定义推送 ID 标识成功后的回调。|
|
|
63
|
+
|
|
64
|
+
### 获取推送 ID 标识 RegistrationID
|
|
65
|
+
|
|
66
|
+
> **说明:**
|
|
67
|
+
>
|
|
68
|
+
> - 需要在注册推送服务成功之后调用。
|
|
69
|
+
> - 若您调用过 `setRegistrationID` 接口设置标识 ID,此接口将返回您设置的标识 ID,否则返回由 Push SDK 生成的随机值。
|
|
70
|
+
|
|
71
|
+
#### 接口
|
|
72
|
+
``` javascript
|
|
73
|
+
getRegistrationID(onSuccess: (registrationID: string) => void): void;
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
#### 参数说明:
|
|
77
|
+
|
|
78
|
+
|参数|类型|说明|
|
|
79
|
+
|---------|---------|---------|
|
|
80
|
+
|onSuccess|Function|获取推送 ID 标识成功的回调。|
|
|
81
|
+
|
|
82
|
+
### 获取点击透传的内容
|
|
83
|
+
|
|
84
|
+
> **说明:**
|
|
85
|
+
>
|
|
86
|
+
> 收到离线推送时,点击通知栏拉起 App,调用此接口可获取推送扩展信息。
|
|
87
|
+
>
|
|
88
|
+
|
|
89
|
+
#### 接口
|
|
90
|
+
``` javascript
|
|
91
|
+
getNotificationExtInfo(onSuccess: (extInfo: string) => void): void;
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
#### 参数说明:
|
|
95
|
+
|
|
96
|
+
|参数|类型|说明|
|
|
97
|
+
|---------|---------|---------|
|
|
98
|
+
|onSuccess|Function|获取点击透传的内容成功的回调。|
|
|
99
|
+
|
|
100
|
+
### 添加 Push 监听器。
|
|
101
|
+
|
|
102
|
+
#### 接口
|
|
103
|
+
``` javascript
|
|
104
|
+
addPushListener(eventName: string, listener: (data: any) => void);
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
#### 参数说明:
|
|
108
|
+
|
|
109
|
+
|参数|类型|说明|
|
|
110
|
+
|---------|---------|---------|
|
|
111
|
+
|eventName|String|推送事件类型。|
|
|
112
|
+
|listener|Function|推送事件处理方法。|
|
|
113
|
+
|
|
114
|
+
### 移除 Push 监听器。
|
|
115
|
+
|
|
116
|
+
#### 接口
|
|
117
|
+
``` javascript
|
|
118
|
+
removePushListener(eventName: string, listener?: (data: any) => void);
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
#### 参数说明:
|
|
122
|
+
|
|
123
|
+
|参数|类型|说明|
|
|
124
|
+
|---------|---------|---------|
|
|
125
|
+
|eventName|String|推送事件类型。|
|
|
126
|
+
|listener|Function \| undefined|推送事件处理方法。|
|
|
127
|
+
|
|
128
|
+
### 应用在前台时,开/关通知栏通知。
|
|
129
|
+
|
|
130
|
+
#### 接口
|
|
131
|
+
``` javascript
|
|
132
|
+
disablePostNotificationInForeground(disable: boolean);
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
#### 参数说明:
|
|
136
|
+
| 参数 | 类型 | 说明 |
|
|
137
|
+
| --- | --- | --- |
|
|
138
|
+
| disable | boolean | 应用在前台时,开/关通知栏通知,默认开:<br>- true: 应用在前台时,关闭通知栏通知。<br>- false: 应用在前台时,开启通知栏通知。 |
|
|
139
|
+
|
|
140
|
+
### 创建客户端通知 channel。
|
|
141
|
+
|
|
142
|
+
#### 接口
|
|
143
|
+
``` javascript
|
|
144
|
+
createNotificationChannel(options: any, onSuccess: (data: any) => void);
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
#### 参数说明:
|
|
148
|
+
| 参数 | 类型 | 说明 |
|
|
149
|
+
| --- | --- | --- |
|
|
150
|
+
| options.channelID | String | 自定义 channel 的 ID。<br>- OPPO:<a href="https://console.cloud.tencent.com/im/push-plugin-push-identifier">控制台 > 接入配置</a> 中 channelID。 |
|
|
151
|
+
| options.channelName | String | 自定义 channel 的名称。 |
|
|
152
|
+
| options.channelDesc | String \\| undefined | 自定义 channel 的描述。 |
|
|
153
|
+
| options.channelSound | String \\| undefined | 自定义 channel 的铃音,音频文件名,不带后缀,音频文件需要放到 <code>MyReactNativeApp/android/app/src/main/res/raw</code> 中。<br>例如:<br><code>options.channelSound = private_ring</code>,即设置 <code>MyReactNativeApp/android/app/src/main/res/raw/private_ring.mp3</code> 为自定义铃音。 |
|
|
154
|
+
| onSuccess | Function | 接口调用成功的回调函数。 |
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
## 接口概览
|
|
2
|
+
| API | 描述 |
|
|
3
|
+
| --- | --- |
|
|
4
|
+
| <code>registerPush</code> | 注册推送服务, (必须在 App 用户同意了隐私政策后,再调用该接口使用推送服务)。 |
|
|
5
|
+
| <code>unRegisterPush</code> | 反注册关闭推送服务。 |
|
|
6
|
+
| <code>setRegistrationID</code> | 设置推送设备标识 ID。<br>- RegistrationID 是推送接收设备的唯一标识 ID。默认情况下,注册推送服务成功时自动生成该 ID,同时也支持您自定义设置。<strong>请注意!如果您调用此接口,请务必在</strong> <code>registerPush</code> <strong>前调用</strong>。<br>- 适用场景举例:<br>若您同时集成了消息服务(Chat)和推送服务(Push),在某个设备上,用户登录 Chat 的 userID 假设为 "user123",如果您想指定向 "user123" 推送消息,则需要调用此接口设置设备标识 ID,如下:<br><code>Push.setRegistrationID("user123", () => {});</code> |
|
|
7
|
+
| <code>getRegistrationID</code> | 在成功注册推送服务后,调用此接口可获取推送接收设备的唯一标识 ID,即 RegistrationID。 |
|
|
8
|
+
| <code>getNotificationExtInfo</code> | 收到离线推送时,点击通知栏拉起 App,调用此接口可获取推送扩展信息。 |
|
|
9
|
+
| <code>addPushListener</code> | 添加 Push 监听器。 |
|
|
10
|
+
| <code>removePushListener</code> | 移除 Push 监听器。 |
|
|
11
|
+
| <code>disablePostNotificationInForeground</code> | 应用在前台时,开/关通知栏通知(默认开)。 |
|
|
12
|
+
| <code>createNotificationChannel</code> | 创建客户端通知 channel。此接口可在 Android 平台上实现自定义铃音功能。 |
|
|
13
|
+
|
|
14
|
+
## 接口详情
|
|
15
|
+
|
|
16
|
+
### 注册推送服务
|
|
17
|
+
|
|
18
|
+
#### 接口
|
|
19
|
+
``` javascript
|
|
20
|
+
registerPush(SDKAppID, appKey, onSuccess, onError)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
#### 参数说明:
|
|
24
|
+
| 参数 | 类型 | 说明 | 获取路径 |
|
|
25
|
+
| --- | --- | --- | --- |
|
|
26
|
+
| SDKAppID | Number | 推送服务 Push 的 SDKAppID。 | <a href="https://console.cloud.tencent.com/im/push-plugin-push-identifier">IM 控制台 > 推送服务 Push > 概览</a> |
|
|
27
|
+
| appKey | String | 推送服务 Push 的客户端密钥。 | |
|
|
28
|
+
| onSuccess | Function | 注册推送成功的回调。 | - |
|
|
29
|
+
| onError | Function |undefined | 注册推送失败的回调。 | - |
|
|
30
|
+
|
|
31
|
+
### 反注册关闭推送服务
|
|
32
|
+
|
|
33
|
+
#### 接口
|
|
34
|
+
``` javascript
|
|
35
|
+
unRegisterPush(onSuccess, onError)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
#### 参数说明:
|
|
39
|
+
|
|
40
|
+
|参数|类型|说明|
|
|
41
|
+
|---------|---------|---------|
|
|
42
|
+
|onSuccess|Function|反注册推送成功的回调。|
|
|
43
|
+
|onError|Function |undefined|反注册推送失败的回调。|
|
|
44
|
+
|
|
45
|
+
### 设置推送 ID 标识 RegistrationID
|
|
46
|
+
|
|
47
|
+
> **说明:**
|
|
48
|
+
>
|
|
49
|
+
> 1. 如果您调用此接口,请务必在 `registerPush` 前调用。
|
|
50
|
+
|
|
51
|
+
#### 接口
|
|
52
|
+
``` javascript
|
|
53
|
+
setRegistrationID(registrationID, onSuccess)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
#### 参数说明:
|
|
57
|
+
|
|
58
|
+
|参数|类型|说明|
|
|
59
|
+
|---------|---------|---------|
|
|
60
|
+
|registrationID|String|自定义的推送 ID 标识。|
|
|
61
|
+
|onSuccess|Function|设置自定义推送 ID 标识成功后的回调。|
|
|
62
|
+
|
|
63
|
+
### 获取推送 ID 标识 RegistrationID
|
|
64
|
+
|
|
65
|
+
> **说明:**
|
|
66
|
+
>
|
|
67
|
+
> 若您调用过 `setRegistrationID` 接口设置标识 ID,此接口将返回您设置的标识 ID,否则返回由 Push SDK 生成的随机值。
|
|
68
|
+
>
|
|
69
|
+
|
|
70
|
+
#### 接口
|
|
71
|
+
``` javascript
|
|
72
|
+
getRegistrationID(onSuccess)
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
#### 参数说明:
|
|
76
|
+
|
|
77
|
+
|参数|类型|说明|
|
|
78
|
+
|---------|---------|---------|
|
|
79
|
+
|onSuccess|Function|获取推送 ID 标识成功的回调。|
|
|
80
|
+
|
|
81
|
+
### 获取推送扩展信息
|
|
82
|
+
|
|
83
|
+
#### 接口
|
|
84
|
+
``` javascript
|
|
85
|
+
getNotificationExtInfo(onSuccess)
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
#### 参数说明:
|
|
89
|
+
|
|
90
|
+
|参数|类型|说明|
|
|
91
|
+
|---------|---------|---------|
|
|
92
|
+
|onSuccess|Function|获取点击透传的内容成功的回调。|
|
|
93
|
+
|
|
94
|
+
### 添加 Push 监听器
|
|
95
|
+
|
|
96
|
+
#### 接口
|
|
97
|
+
``` javascript
|
|
98
|
+
addPushListener(eventName: string, listener: (data: any) => void);
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
#### 参数说明:
|
|
102
|
+
|
|
103
|
+
|参数|类型|说明|
|
|
104
|
+
|---------|---------|---------|
|
|
105
|
+
|eventName|String|推送事件类型。|
|
|
106
|
+
|listener|Function|推送事件处理方法。|
|
|
107
|
+
|
|
108
|
+
### 移除 Push 监听器
|
|
109
|
+
|
|
110
|
+
#### 接口
|
|
111
|
+
``` javascript
|
|
112
|
+
removePushListener(eventName: string, listener?: (data: any) => void);
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
#### 参数说明:
|
|
116
|
+
|
|
117
|
+
|参数|类型|说明|
|
|
118
|
+
|---------|---------|---------|
|
|
119
|
+
|eventName|String|推送事件类型。|
|
|
120
|
+
|listener|Function \| undefined|推送事件处理方法。|
|
|
121
|
+
|
|
122
|
+
### 应用在前台时,开/关通知栏通知
|
|
123
|
+
|
|
124
|
+
#### 接口
|
|
125
|
+
``` javascript
|
|
126
|
+
disablePostNotificationInForeground(disable: boolean);
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
#### 参数说明:
|
|
130
|
+
| 参数 | 类型 | 说明 |
|
|
131
|
+
| --- | --- | --- |
|
|
132
|
+
| disable | boolean | 应用在前台时,开/关通知栏通知,默认开:<br>- true: 应用在前台时,关闭通知栏通知。<br>- false: 应用在前台时,开启通知栏通知。 |
|
|
133
|
+
|
|
134
|
+
### 创建客户端通知 channel
|
|
135
|
+
|
|
136
|
+
#### 接口
|
|
137
|
+
``` javascript
|
|
138
|
+
createNotificationChannel(options: any, listener: (data: any) => void);
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
#### 参数说明:
|
|
142
|
+
| 参数 | 类型 | 说明 |
|
|
143
|
+
| --- | --- | --- |
|
|
144
|
+
| options.channelID | String | 自定义 channel 的 ID。<br>OPPO:<a href="https://console.cloud.tencent.com/im/push-plugin-push-identifier">控制台 > 接入配置</a> 中 channelID。 |
|
|
145
|
+
| options.channelName | String | 自定义 channel 的名称。 |
|
|
146
|
+
| options.channelDesc | String \\| undefined | 自定义 channel 的描述。 |
|
|
147
|
+
| options.channelSound | String \\| undefined | 自定义 channel 的铃音,音频文件名,不带后缀,音频文件需要放到 <code>xxx/nativeResources/android/res/raw</code> 中。<br>例如:<br><code>options.channelSound = private_ring</code>,即设置 <code>xxx/nativeResources/android/res/raw/private_ring.mp3</code> 为自定义铃音 |
|
|
148
|
+
| listener | Function | 接口调用成功的回调函数。 |
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
## PushManager
|
|
2
|
+
|
|
3
|
+
public class PushManager:推送插件接口类。
|
|
4
|
+
|
|
5
|
+
### 接口概览
|
|
6
|
+
|
|
7
|
+
#### 注册/反注册推送服务接口
|
|
8
|
+
|
|
9
|
+
|API|描述|
|
|
10
|
+
|---------|---------|
|
|
11
|
+
|RegisterPush|注册推送服务(必须在 App 用户同意了隐私政策后,再调用该接口使用推送服务)。|
|
|
12
|
+
|UnRegisterPush|关闭推送服务。|
|
|
13
|
+
|SetRegistrationID|RegistrationID 是推送接收设备的唯一标识 ID。默认情况下,注册推送服务成功时自动生成该 ID,同时也支持您自定义设置。您可根据 RegistrationID 向指定设备推送消息。需要注意的是,卸载并重新安装设备会更改 RegistrationID,因此需要在注册推送服务之前调用 setRegistrationID 接口。|
|
|
14
|
+
|GetRegistrationID|在成功注册推送服务后,可通过调用 getRegistrationID 接口获取推送接收设备的唯一标识 ID,即RegistrationID。您可根据 RegistrationID 向指定设备推送消息。|
|
|
15
|
+
|
|
16
|
+
#### Push 全局监听接口
|
|
17
|
+
|
|
18
|
+
|API|描述|
|
|
19
|
+
|---------|---------|
|
|
20
|
+
|AddPushListener|添加 Push 监听器。|
|
|
21
|
+
|RemovePushListener|移除 Push 监听器。|
|
|
22
|
+
|
|
23
|
+
#### 自定义配置接口
|
|
24
|
+
|
|
25
|
+
|API|描述|
|
|
26
|
+
|---------|---------|
|
|
27
|
+
|ForceUseFCMPushChannel|指定设备离线推送使用 FCM 通道,需要在注册推送服务之前调用。|
|
|
28
|
+
|DisablePostNotificationInForeground|关闭 App 在前台时弹出通知栏。|
|
|
29
|
+
|
|
30
|
+
### 接口详情
|
|
31
|
+
|
|
32
|
+
#### 成员函数说明
|
|
33
|
+
|
|
34
|
+
##### abstract void RegisterPush(Context context, int sdkAppId, String appKey, PushCallback callback)
|
|
35
|
+
|
|
36
|
+
注册推送服务,请正确传递 sdkAppId 和 appKey 两个参数,即可注册推送服务。
|
|
37
|
+
|
|
38
|
+
参数说明:
|
|
39
|
+
| 参数 | 描述 | 获取路径 |
|
|
40
|
+
| --- | --- | --- |
|
|
41
|
+
| sdkAppId | IM 控制台为您分配的应用 ID。 | |
|
|
42
|
+
| appKey | IM 控制台为您分配的客户端密钥。 | |
|
|
43
|
+
|
|
44
|
+
##### abstract void UnRegisterPush(PushCallback callback)
|
|
45
|
+
|
|
46
|
+
反注册关闭推送服务。
|
|
47
|
+
|
|
48
|
+
##### abstract void SetRegistrationID(String registrationID, PushCallback callback)
|
|
49
|
+
|
|
50
|
+
设置注册推送服务使用的推送 ID 标识, 即 RegistrationID,需要在注册推送服务之前调用。
|
|
51
|
+
|
|
52
|
+
参数说明:
|
|
53
|
+
|
|
54
|
+
|参数|描述|
|
|
55
|
+
|---------|---------|
|
|
56
|
+
|registrationID|设备的推送唯一标识 ID,卸载重装会改变。|
|
|
57
|
+
|
|
58
|
+
##### abstract void GetRegistrationID(PushCallback callback)
|
|
59
|
+
|
|
60
|
+
注册推送服务成功后,获取推送 ID 标识,即 RegistrationID。
|
|
61
|
+
|
|
62
|
+
##### abstract void AddPushListener(PushListener listener)
|
|
63
|
+
|
|
64
|
+
添加 Push 监听器
|
|
65
|
+
|
|
66
|
+
##### abstract void RemovePushListener(PushListener listener)
|
|
67
|
+
|
|
68
|
+
移除 Push 监听器
|
|
69
|
+
|
|
70
|
+
##### abstract void ForceUseFCMPushChannel(boolean enable)
|
|
71
|
+
|
|
72
|
+
指定设备离线推送使用 FCM 通道,需要在注册推送服务之前调用。
|
|
73
|
+
|
|
74
|
+
参数说明:
|
|
75
|
+
| 参数 | 描述 |
|
|
76
|
+
| --- | --- |
|
|
77
|
+
| enable | - true:使用 FCM 通道。<br>- false:使用本机通道。 |
|
|
78
|
+
|
|
79
|
+
##### abstract void DisablePostNotificationInForeground(boolean disable)
|
|
80
|
+
|
|
81
|
+
关闭 App 在前台时弹出通知栏。推送 SDK 收到在线推送时,会自动向通知栏增加 Notification 提示,如果您想自己处理在线推送消息,可以调用该接口关闭自动弹通知栏提示的特性。
|
|
82
|
+
|
|
83
|
+
参数说明:
|
|
84
|
+
| 参数 | 描述 |
|
|
85
|
+
| --- | --- |
|
|
86
|
+
| disable | - true:关闭<br>- false:开启 |
|
|
87
|
+
|
|
88
|
+
## PushListener
|
|
89
|
+
|
|
90
|
+
public class PushListener:Push 监听器类
|
|
91
|
+
|
|
92
|
+
### 接口概览
|
|
93
|
+
|
|
94
|
+
|API|描述|
|
|
95
|
+
|---------|---------|
|
|
96
|
+
|onRecvPushMessage|收到 Push 消息。|
|
|
97
|
+
|onRevokePushMessage|收到 Push 消息撤回的通知。|
|
|
98
|
+
|onNotificationClicked|点击通知栏消息回调。|
|
|
99
|
+
|
|
100
|
+
### 接口详情
|
|
101
|
+
|
|
102
|
+
#### 成员函数说明
|
|
103
|
+
|
|
104
|
+
##### void onRecvPushMessage(TIMPushMessage message)
|
|
105
|
+
|
|
106
|
+
收到 Push 消息,message 消息。
|
|
107
|
+
|
|
108
|
+
##### void onRevokePushMessage(string messageID)
|
|
109
|
+
|
|
110
|
+
收到 Push 消息撤回的通知,messageID 消息唯一标识。
|
|
111
|
+
|
|
112
|
+
##### void onNotificationClicked(String ext)
|
|
113
|
+
|
|
114
|
+
点击通知栏消息回调。
|
|
115
|
+
|
|
116
|
+
> **注意:**
|
|
117
|
+
>
|
|
118
|
+
> 控制台推送证书需要配置为"打开应用内指定界面",并使用默认填充值生效。
|
|
119
|
+
>
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
## TIMPush - PushManager
|
|
2
|
+
|
|
3
|
+
class PushManager:推送插件接口类。
|
|
4
|
+
|
|
5
|
+
### 接口概览
|
|
6
|
+
|
|
7
|
+
#### 注册/反注册推送服务接口
|
|
8
|
+
|
|
9
|
+
|API|描述|
|
|
10
|
+
|---------|---------|
|
|
11
|
+
|RegisterPush|注册推送服务(必须在 App 用户同意了隐私政策后,再调用该接口使用推送服务)。|
|
|
12
|
+
|UnRegisterPush|关闭推送服务。|
|
|
13
|
+
|SetRegistrationID|RegistrationID 是推送接收设备的唯一标识 ID。默认情况下,注册推送服务成功时自动生成该 ID,同时也支持您自定义设置。您可根据 RegistrationID 向指定设备推送消息。需要注意的是,卸载并重新安装设备会更改 RegistrationID,因此需要在注册推送服务之前调用 setRegistrationID 接口。|
|
|
14
|
+
|GetRegistrationID|在成功注册推送服务后,可通过调用 getRegistrationID 接口获取推送接收设备的唯一标识 ID,即RegistrationID。您可根据 RegistrationID 向指定设备推送消息。|
|
|
15
|
+
|
|
16
|
+
#### Push 全局监听接口
|
|
17
|
+
|
|
18
|
+
|API|描述|
|
|
19
|
+
|---------|---------|
|
|
20
|
+
|AddPushListener|添加 Push 监听器。|
|
|
21
|
+
|RemovePushListener|移除 Push 监听器。|
|
|
22
|
+
|
|
23
|
+
#### 自定义配置接口
|
|
24
|
+
|
|
25
|
+
|API|描述|
|
|
26
|
+
|---------|---------|
|
|
27
|
+
|ForceUseFCMPushChannel|指定设备离线推送使用 FCM 通道,需要在注册推送服务之前调用。|
|
|
28
|
+
|DisablePostNotificationInForeground|关闭 App 在前台时弹出通知栏。|
|
|
29
|
+
|
|
30
|
+
### 接口详情
|
|
31
|
+
|
|
32
|
+
#### 静态 Public 成员函数
|
|
33
|
+
|
|
34
|
+
static PushManager* GetInstance():获取 PushManager 管理器实例。
|
|
35
|
+
|
|
36
|
+
#### 成员函数说明
|
|
37
|
+
|
|
38
|
+
##### virtual void RegisterPush(int sdkAppId, const FString& appKey, PushValueCallback<FString>* callback) = 0;
|
|
39
|
+
|
|
40
|
+
注册推送服务,请正确传递 sdkAppId 和 appKey 两个参数,即可注册推送服务。
|
|
41
|
+
|
|
42
|
+
参数说明:
|
|
43
|
+
| 参数 | 描述 | 获取路径 |
|
|
44
|
+
| --- | --- | --- |
|
|
45
|
+
| sdkAppId | IM 控制台为您分配的应用 ID。 | |
|
|
46
|
+
| appKey | IM 控制台为您分配的客户端密钥。 | |
|
|
47
|
+
|
|
48
|
+
##### virtual void UnRegisterPush(PushCallback* callback) = 0;
|
|
49
|
+
|
|
50
|
+
反注册关闭推送服务。
|
|
51
|
+
|
|
52
|
+
##### virtual void SetRegistrationID(const FString& registrationID, PushCallback* callback) = 0;
|
|
53
|
+
|
|
54
|
+
设置注册推送服务使用的推送 ID 标识, 即 RegistrationID,需要在注册推送服务之前调用。
|
|
55
|
+
|
|
56
|
+
参数说明:
|
|
57
|
+
|
|
58
|
+
|参数|描述|
|
|
59
|
+
|---------|---------|
|
|
60
|
+
|registrationID|设备的推送唯一标识 ID,卸载重装会改变。|
|
|
61
|
+
|
|
62
|
+
##### virtual void GetRegistrationID(PushValueCallback<FString>* callback) = 0;
|
|
63
|
+
|
|
64
|
+
注册推送服务成功后,获取推送 ID 标识,即 RegistrationID。
|
|
65
|
+
|
|
66
|
+
##### virtual void AddPushListener(PushListener* listener) = 0;
|
|
67
|
+
|
|
68
|
+
添加 Push 监听器
|
|
69
|
+
|
|
70
|
+
##### virtual void RemovePushListener(PushListener* listener) = 0;
|
|
71
|
+
|
|
72
|
+
移除 Push 监听器
|
|
73
|
+
|
|
74
|
+
##### virtual void ForceUseFCMPushChannel(bool enable) = 0;
|
|
75
|
+
|
|
76
|
+
指定设备离线推送使用 FCM 通道,需要在注册推送服务之前调用。
|
|
77
|
+
|
|
78
|
+
参数说明:
|
|
79
|
+
| 参数 | 描述 |
|
|
80
|
+
| --- | --- |
|
|
81
|
+
| enable | - true:使用 FCM 通道。<br>- false:使用本机通道。 |
|
|
82
|
+
|
|
83
|
+
##### virtual void DisablePostNotificationInForeground(bool disable) = 0;
|
|
84
|
+
|
|
85
|
+
关闭 App 在前台时弹出通知栏。推送 SDK 收到在线推送时,会自动向通知栏增加 Notification 提示,如果您想自己处理在线推送消息,可以调用该接口关闭自动弹通知栏提示的特性。
|
|
86
|
+
|
|
87
|
+
参数说明:
|
|
88
|
+
| 参数 | 描述 |
|
|
89
|
+
| --- | --- |
|
|
90
|
+
| disable | - true:关闭<br>- false:开启 |
|
|
91
|
+
|
|
92
|
+
## PushListener
|
|
93
|
+
|
|
94
|
+
class PushListener:Push 监听器类
|
|
95
|
+
|
|
96
|
+
### 接口概览
|
|
97
|
+
|
|
98
|
+
|API|描述|
|
|
99
|
+
|---------|---------|
|
|
100
|
+
|OnRecvPushMessage|收到 Push 消息。|
|
|
101
|
+
|OnRevokePushMessage|收到 Push 消息撤回的通知。|
|
|
102
|
+
|OnNotificationClicked|点击通知栏消息回调。|
|
|
103
|
+
|
|
104
|
+
### 接口详情
|
|
105
|
+
|
|
106
|
+
#### 成员函数说明
|
|
107
|
+
|
|
108
|
+
##### virtual void OnRecvPushMessage(const PushMessage& message) {}
|
|
109
|
+
|
|
110
|
+
收到 Push 消息,message 消息。
|
|
111
|
+
|
|
112
|
+
##### virtual void OnRevokePushMessage(const FString& messageID) {}
|
|
113
|
+
|
|
114
|
+
收到 Push 消息撤回的通知,messageID 消息唯一标识。
|
|
115
|
+
|
|
116
|
+
##### virtual void OnNotificationClicked(const FString& ext) {}
|
|
117
|
+
|
|
118
|
+
点击通知栏消息回调。
|
|
119
|
+
|
|
120
|
+
> **注意:**
|
|
121
|
+
>
|
|
122
|
+
> 控制台推送证书需要配置为"打开应用内指定界面",并使用默认填充值生效。
|
|
123
|
+
>
|
|
@@ -17,7 +17,6 @@
|
|
|
17
17
|
|
|
18
18
|
> **提示:**
|
|
19
19
|
>
|
|
20
|
-
|
|
21
20
|
> 本文配置流程可对照 Firebase 官方 [将 Firebase 添加到 Android 项目](https://firebase.google.cn/docs/android/setup) 操作。
|
|
22
21
|
>
|
|
23
22
|
|
|
@@ -30,7 +29,6 @@
|
|
|
30
29
|
|
|
31
30
|
> **说明:**
|
|
32
31
|
>
|
|
33
|
-
|
|
34
32
|
> Firebase 会根据项目名称生成项目 ID。项目创建后,项目 ID 无法更改,请在创建前确认命名和用途。创建项目时,建议启用 Google Analytics,以便后续使用 FCM 消息传送报告能力。
|
|
35
33
|
>
|
|
36
34
|
|
|
@@ -40,7 +38,6 @@
|
|
|
40
38
|
|
|
41
39
|
> **注意:**
|
|
42
40
|
>
|
|
43
|
-
|
|
44
41
|
> Android 软件包名称区分大小写,且 Firebase Android 应用注册后无法更改。请确保填写的包名与 Android 工程的 `applicationId` 完全一致。
|
|
45
42
|
>
|
|
46
43
|
|
|
@@ -48,7 +45,6 @@
|
|
|
48
45
|
|
|
49
46
|
> **注意:**
|
|
50
47
|
>
|
|
51
|
-
|
|
52
48
|
> 后续 SDK 接入时,需将 `google-services.json` 放置到 Android 工程的**模块(应用级)根目录**,例如 `app/google-services.json`,不要放到项目根目录。
|
|
53
49
|
>
|
|
54
50
|
|
|
@@ -59,17 +55,15 @@
|
|
|
59
55
|
|
|
60
56
|
> **注意:**
|
|
61
57
|
>
|
|
62
|
-
|
|
63
58
|
> 服务账号私钥用于服务端向 FCM 鉴权,请妥善保存。不要将私钥提交到代码仓库、客户端安装包或公开渠道。
|
|
64
59
|
>
|
|
65
60
|
|
|
66
61
|
### 确认 FCM API V1 状态
|
|
67
62
|
|
|
68
|
-
在 Firebase 控制台**项目设置 > Cloud Messaging
|
|
63
|
+
在 Firebase 控制台**项目设置 > Cloud Messaging** 中,确认 **Firebase Cloud Messaging API (V1)**已启用。新接入场景请使用 HTTP v1 API 和服务账号私钥进行 FCM 鉴权。
|
|
69
64
|
|
|
70
65
|
> **注意:**
|
|
71
66
|
>
|
|
72
|
-
|
|
73
67
|
> FCM 旧版 Server Key(HTTP/XMPP)已被弃用。TIMPush 的 Google FCM 通道应使用 HTTP v1 API 和服务账号私钥,请勿混用旧版 Server Key 凭据。
|
|
74
68
|
>
|
|
75
69
|
|
|
@@ -96,7 +90,6 @@ FCM 支持通知消息和数据消息。腾讯云控制台默认选择通知消
|
|
|
96
90
|
|
|
97
91
|
> **注意:**
|
|
98
92
|
>
|
|
99
|
-
|
|
100
93
|
> FCM 数据消息能力仅支持 TIMPush 7.8 及以上版本的 Pixel 手机,其他厂商设备需自测支持情况。
|
|
101
94
|
>
|
|
102
95
|
|
|
@@ -16,7 +16,6 @@
|
|
|
16
16
|
|
|
17
17
|
> **提示:**
|
|
18
18
|
>
|
|
19
|
-
|
|
20
19
|
> 本文配置流程可对照荣耀官方 [推送服务上架申请指南](https://developer.honor.com/cn/docs/11002/guides/app-registration) 操作。
|
|
21
20
|
>
|
|
22
21
|
|
|
@@ -31,9 +30,9 @@
|
|
|
31
30
|
|
|
32
31
|
> **说明:**
|
|
33
32
|
>
|
|
34
|
-
>
|
|
35
|
-
>
|
|
36
|
-
>
|
|
33
|
+
> - 必须添加打包的 [SHA256 证书指纹](https://developer.honor.com/cn/docs/11002/guides/android-generate-appsign),SHA256 证书指纹需与实际打包证书一致。如有多套打包证书,需要全部填写。
|
|
34
|
+
> - `mcs-services.json` 用于后续 Android 工程接入阶段,请保存到 Android 项目中。
|
|
35
|
+
> - 修改项目、应用信息或开发服务设置后,需要重新下载并更新 `mcs-services.json`。
|
|
37
36
|
|
|
38
37
|
### 开通推送服务
|
|
39
38
|
1. 进入**管理中心 > 生态服务 > 应用服务 > 推送服务**,进入推送服务列表页面。
|
|
@@ -44,7 +43,6 @@
|
|
|
44
43
|
|
|
45
44
|
> **警告:**
|
|
46
45
|
>
|
|
47
|
-
|
|
48
46
|
> 应用包名字符长度需为 `4-64`。SHA256 证书指纹必须与实际打包证书一致,如有多个证书指纹需要全部填写。包名或证书指纹不一致可能导致后续设备注册失败或离线推送无法触达。
|
|
49
47
|
>
|
|
50
48
|
|
|
@@ -80,7 +78,6 @@
|
|
|
80
78
|
|
|
81
79
|
> **警告:**
|
|
82
80
|
>
|
|
83
|
-
|
|
84
81
|
> 如果消息分类与实际内容不符,可能导致消息被厂商降级、限频或影响通道权限。营销、广告类消息不建议配置为服务通讯类。
|
|
85
82
|
>
|
|
86
83
|
|
|
@@ -88,7 +85,6 @@
|
|
|
88
85
|
|
|
89
86
|
> **说明:**
|
|
90
87
|
>
|
|
91
|
-
|
|
92
88
|
> 荣耀推送和系统版本有关。当前荣耀通道仅支持国内 Magic UI 4.0 及以上和境外 Magic UI 4.2 及以上荣耀设备使用,低于上述版本的荣耀设备可以按华为厂商接入推送。
|
|
93
89
|
>
|
|
94
90
|
|
|
@@ -16,7 +16,6 @@
|
|
|
16
16
|
|
|
17
17
|
> **提示:**
|
|
18
18
|
>
|
|
19
|
-
|
|
20
19
|
> 本文配置流程可对照华为官方 [推送服务](https://developer.huawei.com/consumer/cn/doc/HMSCore-Guides/service-introduction-0000001050040060) 操作。
|
|
21
20
|
>
|
|
22
21
|
|
|
@@ -39,7 +38,6 @@
|
|
|
39
38
|
|
|
40
39
|
> **注意:**
|
|
41
40
|
>
|
|
42
|
-
|
|
43
41
|
> 应用包名与 Android 工程的 `applicationId` 需要保持一致。
|
|
44
42
|
>
|
|
45
43
|
|
|
@@ -49,7 +47,6 @@
|
|
|
49
47
|
|
|
50
48
|
> **警告:**
|
|
51
49
|
>
|
|
52
|
-
|
|
53
50
|
> 必须添加打包的 [SHA256 证书指纹](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/android-config-agc-0000001050170137#section193351110105114),SHA256 证书指纹需与自己的打包证书一致,**否则可能导致无法正常接收离线推送消息**。
|
|
54
51
|
>
|
|
55
52
|
|
|
@@ -68,7 +65,6 @@
|
|
|
68
65
|
|
|
69
66
|
> **注意:**
|
|
70
67
|
>
|
|
71
|
-
|
|
72
68
|
> 华为推送证书 ID <= 11344 时,使用华为推送 v2 版本接口,不支持触达和点击回执,请重新生成更新证书 ID 。
|
|
73
69
|
>
|
|
74
70
|
|
|
@@ -83,7 +79,6 @@
|
|
|
83
79
|
|
|
84
80
|
> **警告:**
|
|
85
81
|
>
|
|
86
|
-
|
|
87
82
|
> 如果消息分类与实际内容不符,**可能导致消息被厂商降级、限频或影响通道权限**。营销、广告类消息不建议配置为服务与通讯类。
|
|
88
83
|
>
|
|
89
84
|
|