@tencent-rtc/mcp 1.4.7 → 1.6.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cursor-setting.png +0 -0
- package/knowledge/bm25-cache.js +74 -0
- package/knowledge/bm25-cache.js.map +1 -0
- package/knowledge/bm25.js +148 -0
- package/knowledge/bm25.js.map +1 -0
- package/knowledge/build-index.js +70 -0
- package/knowledge/build-index.js.map +1 -0
- package/knowledge/chunker.js +168 -0
- package/knowledge/chunker.js.map +1 -0
- package/knowledge/content-loader.js +40 -0
- package/knowledge/content-loader.js.map +1 -0
- package/knowledge/doc-url-resolver.js +143 -0
- package/knowledge/doc-url-resolver.js.map +1 -0
- package/knowledge/extractors.js +26 -0
- package/knowledge/extractors.js.map +1 -0
- package/knowledge/path-meta.js +185 -0
- package/knowledge/path-meta.js.map +1 -0
- package/knowledge/search/exact-lookup.js +498 -0
- package/knowledge/search/exact-lookup.js.map +1 -0
- package/knowledge/search/filter-pool.js +105 -0
- package/knowledge/search/filter-pool.js.map +1 -0
- package/knowledge/search/product-scope-intent.js +41 -0
- package/knowledge/search/product-scope-intent.js.map +1 -0
- package/knowledge/search/requires-framework.js +82 -0
- package/knowledge/search/requires-framework.js.map +1 -0
- package/knowledge/search/search-knowledge.js +230 -0
- package/knowledge/search/search-knowledge.js.map +1 -0
- package/mcp-server-prompt.png +0 -0
- package/package.json +1 -1
- package/resource/_schema/feature-aliases.yaml +10 -0
- package/resource/_schema/goal-tags.yaml +72 -0
- package/resource/_schema/products.yaml +19 -0
- package/resource/_schema/trtc-intents.yaml +27 -0
- package/resource/_schema/types.yaml +43 -0
- package/resource/index/component-slugs.json +1 -0
- package/resource/index/doc-source-urls.json +1 -0
- package/resource/index/manifest.json +1 -0
- package/resource/{doc → integration}/callkit/preset/android/integration.md +34 -28
- package/resource/integration/callkit/preset/flutter/integration.md +346 -0
- package/resource/integration/callkit/preset/ios/integration.md +408 -0
- package/resource/integration/callkit/preset/react/integration.md +362 -0
- package/resource/integration/callkit/preset/vue/integration.md +356 -0
- package/resource/integration/chat/preset/android/integration.md +500 -0
- package/resource/integration/chat/preset/flutter/integration.md +370 -0
- package/resource/integration/chat/preset/ios/integration.md +566 -0
- package/resource/integration/chat/preset/react/integration.md +490 -0
- package/resource/integration/chat/preset/vue/integration.md +504 -0
- package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +26 -22
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +22 -18
- package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +309 -0
- package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +47 -39
- package/resource/integration/roomkit/preset/vue/integration.md +562 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +828 -0
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +897 -0
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +363 -0
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1111 -0
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1132 -0
- package/resource/{doc → knowledge}/callkit/core-sdk/flutter/offline-push.md +174 -151
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1084 -0
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1252 -0
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +534 -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 +92 -0
- package/resource/{doc/callkit/faq/android-faq.md → knowledge/callkit/faq/common.md} +11 -12
- package/resource/knowledge/callkit/faq/error-code.md +67 -0
- package/resource/knowledge/callkit/faq/flutter.md +52 -0
- package/resource/knowledge/callkit/faq/ios.md +104 -0
- package/resource/knowledge/callkit/faq/web.md +74 -0
- package/resource/knowledge/callkit/preset/android/api.md +412 -0
- package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
- package/resource/knowledge/callkit/preset/ios/api.md +234 -0
- package/resource/knowledge/callkit/preset/web/api.md +83 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +74 -0
- package/resource/knowledge/chat/preset/android/features/contact-list.md +43 -0
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +117 -0
- package/resource/knowledge/chat/preset/android/features/language.md +136 -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/knowledge/chat/preset/android/features/theme.md +222 -0
- package/resource/knowledge/chat/preset/android-view/integration.md +300 -0
- package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +64 -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 +158 -0
- package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
- package/resource/knowledge/chat/preset/flutter/features/theme.md +261 -0
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +94 -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 +125 -0
- package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
- package/resource/knowledge/chat/preset/ios/features/message-list.md +162 -0
- package/resource/knowledge/chat/preset/ios/features/search.md +93 -0
- package/resource/knowledge/chat/preset/ios/features/theme.md +270 -0
- package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +160 -158
- package/resource/knowledge/chat/preset/react/features/chat-setting.md +101 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +43 -41
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +215 -0
- package/resource/knowledge/chat/preset/react/features/conversation-list.md +339 -0
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +101 -0
- package/resource/knowledge/chat/preset/react/features/conversation-search.md +61 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +117 -156
- package/resource/knowledge/chat/preset/react/features/message-list.md +297 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/search.md +65 -59
- package/resource/knowledge/chat/preset/react/features/theme.md +93 -0
- package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
- package/resource/knowledge/chat/preset/vue/features/chat-setting.md +79 -0
- package/resource/knowledge/chat/preset/vue/features/contact-list.md +277 -0
- package/resource/knowledge/chat/preset/vue/features/conversation-actions.md +234 -0
- package/resource/knowledge/chat/preset/vue/features/conversation-list.md +331 -0
- package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +216 -0
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +13 -13
- package/resource/knowledge/chat/preset/vue/features/message-input.md +551 -0
- package/resource/knowledge/chat/preset/vue/features/message-list.md +350 -0
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +79 -73
- package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
- package/resource/knowledge/chat/urls/error-code.md +17 -0
- package/resource/knowledge/chat/urls/product.md +43 -0
- package/resource/knowledge/chat/urls/restapi.md +204 -0
- package/resource/knowledge/chat/urls/sdk/android.md +80 -0
- package/resource/knowledge/chat/urls/sdk/flutter.md +71 -0
- package/resource/knowledge/chat/urls/sdk/ios.md +80 -0
- package/resource/knowledge/chat/urls/sdk/web.md +80 -0
- package/resource/knowledge/chat/urls/webhook.md +68 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +286 -0
- 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/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +55 -0
- 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/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +51 -0
- 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 +488 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +219 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +282 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +153 -0
- 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 +426 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +52 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +150 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +438 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +190 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +291 -0
- 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/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +51 -0
- 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 +487 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +183 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +736 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +53 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +22 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +17 -15
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +19 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +102 -89
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +41 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +45 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +23 -20
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +41 -41
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +70 -69
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +68 -71
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +43 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +59 -56
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +103 -105
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-host-interaction.md +869 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +84 -87
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +43 -40
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +11 -10
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +22 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +15 -14
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +19 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +54 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +41 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +40 -40
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +19 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +53 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +22 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +41 -33
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +94 -81
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +35 -30
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +45 -42
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-room-list.md +23 -20
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audience-list.md +260 -0
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audio-effect.md +598 -0
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-barrage.md +490 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +65 -59
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-gift.md +424 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +69 -76
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-room-list.md +726 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +11 -10
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +22 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +41 -33
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +54 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +35 -30
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +49 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-room-list.md +19 -18
- package/resource/knowledge/livekit/faq/error-code.md +193 -0
- package/resource/{doc/livekit/preset/live/vue/components → knowledge/livekit/preset/live/vue/features}/barrage.md +56 -53
- package/resource/{doc/livekit/preset/live/vue/components → knowledge/livekit/preset/live/vue/features}/live-audience-list.md +22 -21
- package/resource/{doc/livekit/preset/live/vue/components → knowledge/livekit/preset/live/vue/features}/live-view.md +34 -32
- package/resource/knowledge/push/config/android.md +92 -0
- package/resource/knowledge/push/config/harmonyos.md +83 -0
- package/resource/knowledge/push/config/ios.md +254 -0
- package/resource/knowledge/push/config/react-native.md +254 -0
- package/resource/knowledge/push/config/unity.md +209 -0
- package/resource/knowledge/push/config/unreal-engine.md +194 -0
- package/resource/knowledge/push/integration/android.md +404 -0
- package/resource/knowledge/push/integration/flutter.md +465 -0
- package/resource/knowledge/push/integration/harmonyos.md +63 -0
- package/resource/knowledge/push/integration/ios.md +246 -0
- package/resource/knowledge/push/integration/react-native.md +366 -0
- package/resource/knowledge/push/integration/uni-app.md +208 -0
- package/resource/knowledge/push/integration/unity.md +389 -0
- package/resource/knowledge/push/integration/unreal-engine.md +390 -0
- package/resource/knowledge/push/overview/prepare.md +60 -0
- package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +241 -0
- package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +588 -0
- package/resource/knowledge/roomkit/core-sdk/android/room-state.md +364 -0
- package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +340 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +797 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md +325 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md +325 -0
- package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md +233 -0
- package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +569 -0
- package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +325 -0
- package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md +322 -0
- package/resource/knowledge/roomkit/core-sdk/vue/call-user-to-room.md +221 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +49 -48
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +461 -0
- package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +216 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +370 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/room-participant-state.md +61 -60
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +280 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/room-view.md +57 -56
- package/resource/knowledge/roomkit/core-sdk/vue/schedule-room.md +319 -0
- package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +267 -0
- package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +261 -0
- package/resource/knowledge/roomkit/preset/android/integration.md +396 -0
- package/resource/knowledge/roomkit/preset/flutter/integration.md +404 -0
- package/resource/knowledge/roomkit/preset/ios/integration.md +369 -0
- package/resource/knowledge/roomkit/preset/react/integration.md +576 -0
- package/resource/knowledge/rtcengine/web/how_to_run_web_sdk_demo.md +44 -0
- package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +8 -2
- package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +19 -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 +8 -8
- 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 +6 -6
- package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +3 -3
- package/resource/{doc → knowledge}/rtcengine/web/plugin/29-advanced-water-mark.md +18 -0
- package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/34-advanced-proxy.md +2 -2
- package/resource/{doc → knowledge}/rtcengine/web/plugin/35-advanced-ai-denoiser.md +1 -1
- package/resource/knowledge/trtc/android/TRTCCloud.md +1915 -0
- package/resource/knowledge/trtc/android/TRTCCloudDef.md +1029 -0
- package/resource/knowledge/trtc/android/TRTCCloudListener.md +1095 -0
- package/resource/knowledge/trtc/android/TRTCStatistics.md +68 -0
- package/resource/knowledge/trtc/android/TXAudioEffectManager.md +502 -0
- package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
- package/resource/knowledge/trtc/android/TXDeviceManager.md +169 -0
- package/resource/knowledge/trtc/android/TXLiteAVCode.md +125 -0
- package/resource/knowledge/trtc/c++/ITRTCCloud.md +2069 -0
- package/resource/knowledge/trtc/c++/ITRTCStatistics.md +73 -0
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +391 -0
- package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +1191 -0
- package/resource/knowledge/trtc/c++/TRTCTypeDef.md +931 -0
- package/resource/knowledge/trtc/c++/TXLiteAVCode.md +127 -0
- package/resource/knowledge/trtc/ios/TRTCCloud.md +2118 -0
- package/resource/knowledge/trtc/ios/TRTCCloudDef.md +975 -0
- package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +1131 -0
- package/resource/knowledge/trtc/ios/TRTCStatistics.md +68 -0
- package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +423 -0
- package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +387 -0
- package/resource/knowledge/trtc/ios/TXLiteAVCode.md +127 -0
- package/server.js +35 -11
- package/server.js.map +1 -1
- package/tools/call/get_native_call_uikit_integration.js +2 -3
- package/tools/call/get_native_call_uikit_integration.js.map +1 -1
- package/tools/call/get_native_callkit_core_integration.js +2 -5
- package/tools/call/get_native_callkit_core_integration.js.map +1 -1
- package/tools/call/get_web_call_uikit_integration.js +2 -3
- package/tools/call/get_web_call_uikit_integration.js.map +1 -1
- package/tools/chat/get_native_chat_uikit_integration.js +2 -3
- package/tools/chat/get_native_chat_uikit_integration.js.map +1 -1
- package/tools/chat/get_web_chat_uikit_integration.js +2 -3
- package/tools/chat/get_web_chat_uikit_integration.js.map +1 -1
- package/tools/common/present_framework_choice.js +19 -13
- package/tools/common/present_framework_choice.js.map +1 -1
- package/tools/common/record_answer.js +19 -25
- package/tools/common/record_answer.js.map +1 -1
- package/tools/common/record_feedback.js +17 -30
- package/tools/common/record_feedback.js.map +1 -1
- package/tools/common/search_trtc_knowledge.js +45 -0
- package/tools/common/search_trtc_knowledge.js.map +1 -0
- package/tools/definitions/get_native_call_uikit_integration_def.js +3 -1
- package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_callkit_core_integration_def.js +5 -3
- package/tools/definitions/get_native_callkit_core_integration_def.js.map +1 -1
- package/tools/definitions/get_native_chat_uikit_integration_def.js +5 -2
- package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_livekit_core_integration_def.js +6 -5
- package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js +4 -2
- package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js +2 -0
- package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js +5 -5
- package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_room_core_integration_def.js +50 -0
- package/tools/definitions/get_web_room_core_integration_def.js.map +1 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +5 -4
- package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
- package/tools/definitions/integration-boundary.js +6 -0
- package/tools/definitions/integration-boundary.js.map +1 -0
- package/tools/definitions/present_framework_choice_def.js +12 -10
- package/tools/definitions/present_framework_choice_def.js.map +1 -1
- package/tools/definitions/record_answer_def.js +19 -17
- package/tools/definitions/record_answer_def.js.map +1 -1
- package/tools/definitions/record_feedback_def.js +14 -13
- package/tools/definitions/record_feedback_def.js.map +1 -1
- package/tools/definitions/search_trtc_knowledge_def.js +40 -0
- package/tools/definitions/search_trtc_knowledge_def.js.map +1 -0
- package/tools/index.js +5 -36
- package/tools/index.js.map +1 -1
- package/tools/live/get_native_livekit_core_integration.js +1 -3
- package/tools/live/get_native_livekit_core_integration.js.map +1 -1
- package/tools/live/get_web_live_uikit_integration.js +2 -4
- package/tools/live/get_web_live_uikit_integration.js.map +1 -1
- package/tools/room/get_web_room_core_integration.js +48 -0
- package/tools/room/get_web_room_core_integration.js.map +1 -0
- package/tools/room/get_web_room_uikit_integration.js +2 -3
- package/tools/room/get_web_room_uikit_integration.js.map +1 -1
- package/utils/generate-structured-result.js +24 -30
- package/utils/generate-structured-result.js.map +1 -1
- package/utils/get-doc-content.js +14 -8
- package/utils/get-doc-content.js.map +1 -1
- package/utils/report-cls-client.js +18 -20
- package/utils/report-cls-client.js.map +1 -1
- package/utils/report-es-client.js +1 -1
- package/resource/doc/callkit/core-sdk/.gitkeep +0 -0
- package/resource/doc/callkit/core-sdk/android/answer-call.md +0 -852
- package/resource/doc/callkit/core-sdk/android/make-call.md +0 -954
- package/resource/doc/callkit/core-sdk/android/offline-push.md +0 -361
- package/resource/doc/callkit/core-sdk/flutter/answer-call.md +0 -1160
- package/resource/doc/callkit/core-sdk/flutter/make-call.md +0 -1205
- package/resource/doc/callkit/core-sdk/ios/answer-call.md +0 -1090
- package/resource/doc/callkit/core-sdk/ios/make-call.md +0 -1248
- package/resource/doc/callkit/core-sdk/ios/offline-push.md +0 -485
- package/resource/doc/callkit/core-sdk/uni-app/answer-call.md +0 -950
- package/resource/doc/callkit/core-sdk/uni-app/make-call.md +0 -1052
- package/resource/doc/callkit/faq/common/error-code.md +0 -47
- package/resource/doc/callkit/faq/flutter-faq.md +0 -115
- package/resource/doc/callkit/faq/ios-faq.md +0 -115
- package/resource/doc/callkit/faq/web-faq.md +0 -36
- package/resource/doc/callkit/preset/android/api.md +0 -296
- package/resource/doc/callkit/preset/flutter/api.md +0 -410
- package/resource/doc/callkit/preset/flutter/integration.md +0 -164
- package/resource/doc/callkit/preset/ios/api.md +0 -80
- package/resource/doc/callkit/preset/ios/integration.md +0 -187
- package/resource/doc/callkit/preset/react/api.md +0 -501
- package/resource/doc/callkit/preset/react/integration.md +0 -86
- package/resource/doc/callkit/preset/vue/api.md +0 -501
- package/resource/doc/callkit/preset/vue/integration.md +0 -83
- package/resource/doc/chatkit/android/faq.md +0 -111
- package/resource/doc/chatkit/android/features/theme.md +0 -219
- package/resource/doc/chatkit/android/integration.md +0 -490
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +0 -281
- package/resource/doc/chatkit/faq/common/product.md +0 -7
- package/resource/doc/chatkit/faq/common/server.md +0 -44
- package/resource/doc/chatkit/faq/common/server_error_code.md +0 -74
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +0 -199
- package/resource/doc/chatkit/faq/flutter_sdk/faq.md +0 -53
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +0 -235
- package/resource/doc/chatkit/faq/web_sdk/error_code.md +0 -47
- package/resource/doc/chatkit/faq/web_sdk/faq.md +0 -287
- package/resource/doc/chatkit/flutter/faq.md +0 -23
- package/resource/doc/chatkit/flutter/features/theme.md +0 -235
- package/resource/doc/chatkit/flutter/integration.md +0 -344
- package/resource/doc/chatkit/ios/faq.md +0 -111
- package/resource/doc/chatkit/ios/features/theme.md +0 -267
- 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 -57
- package/resource/doc/chatkit/react/components/chat.md +0 -38
- package/resource/doc/chatkit/react/components/component-list.md +0 -37
- package/resource/doc/chatkit/react/components/conversation-actions.md +0 -174
- package/resource/doc/chatkit/react/components/conversation-list.md +0 -333
- package/resource/doc/chatkit/react/components/conversation-preview.md +0 -118
- package/resource/doc/chatkit/react/components/conversation-search.md +0 -60
- package/resource/doc/chatkit/react/components/message-list.md +0 -293
- package/resource/doc/chatkit/react/components/tuikit.md +0 -34
- package/resource/doc/chatkit/react/faq.md +0 -26
- package/resource/doc/chatkit/react/integration.md +0 -416
- package/resource/doc/chatkit/vue/components/avatar.md +0 -104
- package/resource/doc/chatkit/vue/components/chat-header.md +0 -148
- package/resource/doc/chatkit/vue/components/chat-setting.md +0 -62
- package/resource/doc/chatkit/vue/components/chat.md +0 -45
- package/resource/doc/chatkit/vue/components/component-list.md +0 -87
- package/resource/doc/chatkit/vue/components/contact-list.md +0 -271
- package/resource/doc/chatkit/vue/components/conversation-actions.md +0 -228
- package/resource/doc/chatkit/vue/components/conversation-list.md +0 -320
- package/resource/doc/chatkit/vue/components/conversation-preview.md +0 -213
- package/resource/doc/chatkit/vue/components/message-input.md +0 -1054
- package/resource/doc/chatkit/vue/components/message-list.md +0 -433
- package/resource/doc/chatkit/vue/components/tuikit.md +0 -31
- package/resource/doc/chatkit/vue/components/userpicker.md +0 -256
- package/resource/doc/chatkit/vue/faq.md +0 -36
- package/resource/doc/chatkit/vue/integration.md +0 -428
- package/resource/doc/livekit/core-sdk/live/flutter/live-host-interaction.md +0 -866
- package/resource/doc/livekit/faq/common/error-code.md +0 -88
- package/resource/doc/livekit/preset/live/vue/api-reference/index.md +0 -780
- package/resource/doc/livekit/preset/live/vue/components/co-guest-panel.md +0 -91
- package/resource/doc/livekit/preset/live/vue/components/live-scene-panel.md +0 -112
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +0 -215
- package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +0 -300
- package/resource/doc/roomkit/faq/common/error-code.md +0 -67
- package/resource/doc/roomkit/vue/features/call-user-to-room.md +0 -220
- package/resource/doc/roomkit/vue/features/device-state.md +0 -460
- package/resource/doc/roomkit/vue/features/free-beauty-panel.md +0 -215
- package/resource/doc/roomkit/vue/features/room-chat.md +0 -369
- package/resource/doc/roomkit/vue/features/room-state.md +0 -282
- package/resource/doc/roomkit/vue/features/schedule-room.md +0 -318
- package/resource/doc/roomkit/vue/features/screen-share.md +0 -265
- package/resource/doc/roomkit/vue/features/virtual-background.md +0 -271
- package/resource/doc/roomkit/vue/integration.md +0 -315
- package/resource/doc/rtcengine/faq/common/error_code.md +0 -1
- package/resource/doc/rtcengine/faq/web_sdk/.gitkeep +0 -0
- package/resource/doc/rtcengine/web/.gitkeep +0 -0
- package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +0 -59
- package/resource/doc/trtc/C++/ITRTCCloud.md +0 -1970
- package/resource/doc/trtc/C++/ITRTCStatistics.md +0 -70
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +0 -469
- package/resource/doc/trtc/C++/ITXDeviceManager.md +0 -387
- package/resource/doc/trtc/C++/TRTCCloudCallback.md +0 -1082
- package/resource/doc/trtc/C++/TRTCTypeDef.md +0 -925
- package/resource/doc/trtc/C++/TXLiteAVCode.md +0 -129
- package/resource/doc/trtc/android/TRTCCloud.md +0 -1815
- package/resource/doc/trtc/android/TRTCCloudDef.md +0 -992
- package/resource/doc/trtc/android/TRTCCloudListener.md +0 -1004
- package/resource/doc/trtc/android/TRTCStatistics.md +0 -65
- package/resource/doc/trtc/android/TXAudioEffectManager.md +0 -469
- package/resource/doc/trtc/android/TXBeautyManager.md +0 -402
- package/resource/doc/trtc/android/TXDeviceManager.md +0 -173
- package/resource/doc/trtc/android/TXLiteAVCode.md +0 -127
- package/resource/doc/trtc/iOS/TRTCCloud.md +0 -2028
- package/resource/doc/trtc/iOS/TRTCCloudDef.md +0 -958
- package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +0 -1046
- package/resource/doc/trtc/iOS/TRTCStatistics.md +0 -65
- package/resource/doc/trtc/iOS/TXAudioEffectManager.md +0 -397
- package/resource/doc/trtc/iOS/TXBeautyManager.md +0 -403
- package/resource/doc/trtc/iOS/TXDeviceManager.md +0 -381
- package/resource/doc/trtc/iOS/TXLiteAVCode.md +0 -130
- package/tools/call/get_callkit_api.js +0 -33
- package/tools/call/get_callkit_api.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_web_chat_uikit_component_detail.js +0 -35
- package/tools/chat/get_web_chat_uikit_component_detail.js.map +0 -1
- package/tools/common/get_faq.js +0 -266
- package/tools/common/get_faq.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 -29
- package/tools/definitions/get_callkit_api_def.js.map +0 -1
- package/tools/definitions/get_faq_def.js +0 -47
- package/tools/definitions/get_faq_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_livekit_core_features_def.js +0 -34
- package/tools/definitions/get_native_livekit_core_features_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_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_livekit_api_def.js +0 -30
- package/tools/definitions/get_web_livekit_api_def.js.map +0 -1
- package/tools/definitions/get_web_livekit_component_detail_def.js +0 -32
- package/tools/definitions/get_web_livekit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_roomkit_feature_detail_def.js +0 -31
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_api_def.js +0 -27
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +0 -27
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +0 -27
- package/tools/definitions/get_web_trtc_sdk_plugin_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/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_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_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 -120
- package/utils/build-session-directives.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/report-runtime-error-cls-client.js +0 -91
- package/utils/report-runtime-error-cls-client.js.map +0 -1
- /package/resource/{doc/livekit/preset/live/vue/faq.md → knowledge/push/config/donut.md} +0 -0
- /package/resource/{doc/roomkit/vue/faq.md → knowledge/push/integration/donut.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/30-advanced-cross-room-link.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/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
|
@@ -0,0 +1,254 @@
|
|
|
1
|
+
This article will guide you to create and use **Push Certificates** and **Description Files**, provided you have a **Developer Account** and **Develop/Distribute Certificates**.
|
|
2
|
+
|
|
3
|
+
If you have any questions about the "Developer Account" or "Develop/Distribute Certificates," you can [refer to the relevant concepts in the appendices](https://www.tencentcloud.com/document/product/1047/60548).
|
|
4
|
+
|
|
5
|
+
##
|
|
6
|
+
1. APNs Push Certificate Configuration
|
|
7
|
+
|
|
8
|
+
> **Note:**
|
|
9
|
+
>
|
|
10
|
+
|
|
11
|
+
> Each vendor only supports the configuration of one certificate.
|
|
12
|
+
>
|
|
13
|
+
|
|
14
|
+
Before integrating the TIMPush component, you need to apply for an APNs push certificate from Apple, and then upload the push certificate to the Chat console. After that, you can follow the quick access steps for integration.
|
|
15
|
+
|
|
16
|
+
Apple currently offers two mainstream types of certificates for vendor configuration: p12 certificates and p8 certificates. Each has its advantages and disadvantages, so you can choose one based on your needs.
|
|
17
|
+
| | <strong>Certificate Type</strong> | <strong>Validity and Management</strong> | <strong>Security</strong> | <strong>Dynamic Island</strong> |
|
|
18
|
+
| --- | --- | --- | --- | --- |
|
|
19
|
+
| <strong>P12 Certificate</strong> | A P12 certificate is a binary file that contains a public key and a private key, used for certificate-based authentication. It bundles the public key certificate and private key into one file with an extension of .p12 or .pfx. | A P12 certificate typically has a validity period of one year and needs to be regenerated and redeployed upon expiration. Each application requires a separate P12 certificate to handle push notifications. | Certificates: A P12 Certificate uses certificate-based authentication and requires storing the private key on the Server. This may increase security risks as the private key could potentially be accessed by unauthorized users. | Not supported |
|
|
20
|
+
| <strong>P8 Certificate</strong> | A P8 Certificate is an Auth Key used for token-based authentication. It is a text file containing the private key, with an extension of .p8. | A P8 Certificate does not have an expiration date, so you don’t need to worry about certificate expiration. Additionally, using a P8 Certificate simplifies Certificate Management, as you can use one P8 Certificate to provide Push Notification Service for multiple applications. | A P8 Certificate uses token-based authentication, meaning your Server periodically generates a JSON Web Token (JWT) to establish a connection with APNs. This method is more secure as it does not require storing the private key on the Server. | Support Dynamic Island push |
|
|
21
|
+
|
|
22
|
+
### Method 1: Use p12 certificate (traditional APNs push certificate)
|
|
23
|
+
|
|
24
|
+
### Step 1: Apply for an APNs certificate
|
|
25
|
+
1. Log in to [Apple Developer Center](https://developer.apple.com/account/) website, click **Certificates, Identifiers & Profiles** or the sidebar's **Certificates, IDs & Profiles**, to enter **Certificates, IDS & Profiles** page.
|
|
26
|
+
|
|
27
|
+
2. Click Identifiers on the right-side **+**.
|
|
28
|
+
|
|
29
|
+
3. You can follow the steps below to create a new AppID, or add a `Push Notification` service to your existing AppID .
|
|
30
|
+
|
|
31
|
+
> **Note:**
|
|
32
|
+
>
|
|
33
|
+
|
|
34
|
+
> Your App's `Bundle ID` cannot use a wildcard `*`, otherwise, remote push service will not be available.
|
|
35
|
+
>
|
|
36
|
+
|
|
37
|
+
4. Select **App IDs**, click **Continue** to proceed with Next .
|
|
38
|
+
|
|
39
|
+
5. Choose **App**, click **Continue** to proceed with Next .
|
|
40
|
+
|
|
41
|
+
6. Configure `Bundle ID` and other information, click **Continue** to proceed with Next .
|
|
42
|
+
|
|
43
|
+
7. Select **Push Notifications** to activate remote push service.
|
|
44
|
+
|
|
45
|
+
#### Generating Certificate
|
|
46
|
+
1. Select your AppID, choose **Configure**.
|
|
47
|
+
|
|
48
|
+
2. You can see in the **Apple Push Notification service SSL Certificates** window, there are two `SSL Certificate`, one for the development environment (Development) and the other for the production environment (Production) remote push certificate, as shown below:
|
|
49
|
+
|
|
50
|
+
3.
|
|
51
|
+
|
|
52
|
+
First, we choose the Development **Create Certificate**; the system will prompt us that a Certificate Signing Request (CSR) is required.
|
|
53
|
+
|
|
54
|
+
4. Open **Keychain Access** on your Mac, in the menu, select **Keychain Access** > **Certificate Assistant** > **Request a Certificate From a Certificate Authority** (`Keychain Access - Certificate Assistant - Request a Certificate From a Certificate Authority`).
|
|
55
|
+
|
|
56
|
+
5. Enter the user's Email address (your email), Common Name (your name or company name), select **Save to disk**, click **continue**, and the system will generate a `*.certSigningRequest` file.
|
|
57
|
+
|
|
58
|
+
6. Return to the page on the Apple Developer website you were just at in step 3 of the above instructions, click **Choose File** to upload the `*.certSigningRequest` file.
|
|
59
|
+
|
|
60
|
+
7. Click **Continue** to generate the push certificate.
|
|
61
|
+
|
|
62
|
+
8. Click **Download** to download the `Development SSL Certificate` to your local machine.
|
|
63
|
+
|
|
64
|
+
9. Follow the steps 1 - 8 above again to download the `Production SSL Certificate` to your local machine.
|
|
65
|
+
|
|
66
|
+
> **Note:**
|
|
67
|
+
>
|
|
68
|
+
|
|
69
|
+
> Actually, this certificate is a Sandbox and Production merged certificate that applies to both the development and production environments.
|
|
70
|
+
>
|
|
71
|
+
|
|
72
|
+
10. Double-click the downloaded `SSL Certificate` for the development and production environments. The system will import it into the keychain.
|
|
73
|
+
|
|
74
|
+
11. Open the Keychain Access app, go to ** log in to **> **My Certificates**, right-click to export the recently created development environment (`Apple Development IOS Push Service`) and production environment (`Apple Push Services`) `p12` files.
|
|
75
|
+
|
|
76
|
+
> **Note:**
|
|
77
|
+
>
|
|
78
|
+
|
|
79
|
+
> When saving the `.p12` file, be sure to set a password. Step 2: Upload the certificate to the console.
|
|
80
|
+
>
|
|
81
|
+
|
|
82
|
+
### Step 2: Upload the p12 certificate to the Chat console
|
|
83
|
+
1. log in [ Chat Console](https://console.trtc.io/chat/push-plugin-push-identifier).
|
|
84
|
+
|
|
85
|
+
2. Click the target **Applications** card to go to the basic configuration page of the app.
|
|
86
|
+
|
|
87
|
+
3. click **iOS native offline push settings** on the right, click **Add Certificate**.
|
|
88
|
+
|
|
89
|
+
4. Select the certificate type, upload the iOS certificate (p12), set the certificate password, and click **Confirm**.
|
|
90
|
+
|
|
91
|
+
> **Note:**
|
|
92
|
+
>
|
|
93
|
+
> - When uploading the push certificate, make sure that the Bundle ID matches the Bundle ID of your main app.
|
|
94
|
+
> - We recommend naming the uploaded certificate in English (special characters such as brackets are not allowed).
|
|
95
|
+
> - You need to set a password for the uploaded certificate. Without a password, push notifications cannot be received.
|
|
96
|
+
> - For an app published on App Store, the environment of the certificate must be the production environment. Otherwise, push notifications cannot be received.
|
|
97
|
+
> - The uploaded .p12 certificate must be your own authentic and valid certificate.
|
|
98
|
+
|
|
99
|
+
5. After the push certificate information is generated, record the certificate** ID**.
|
|
100
|
+
|
|
101
|
+
### Method 2: Use a p8 certificate (supports Dynamic Island Push)
|
|
102
|
+
|
|
103
|
+
p8 Certificate: A p8 certificate does not have an expiration date, so you don't need to worry about certificate expiration. Additionally, using a p8 certificate can simplify certificate management since you can use a single p8 certificate to provide push notification services for multiple applications. Moreover, p8 certificate supports Dynamic Island push.
|
|
104
|
+
|
|
105
|
+
### Step 1: Apply for an APNs certificate
|
|
106
|
+
|
|
107
|
+
To create a p8 certificate file, you first need to log in to the [Apple Developer Center](https://developer.apple.com/).
|
|
108
|
+
|
|
109
|
+
1. Go to Certificates, Identifiers & Profiles: click on **Account** in the top right corner of the page, then select **Certificates, Identifiers & Profiles** from the drop-down menu.
|
|
110
|
+
|
|
111
|
+
2. Create a new App ID: click on **Identifiers** in the left menu, then click on the **+** on the right to create a new App ID. Fill in the relevant information and click on **Continue**.
|
|
112
|
+
|
|
113
|
+
3. Create a new key: In the left menu, click on **Keys**, then click the **+** on the right to create a new key. Enter the name of the key, and then check the **Apple Push Notifications service (APNs)**, click on **Continue**.
|
|
114
|
+
|
|
115
|
+
Confirm and generate the key: On the confirmation page, verify your key information, then click on **Register**. Next, you will see a page prompting you to download the key. Click on **Download** to save the generated .p8 file to your computer.
|
|
116
|
+
|
|
117
|
+
> **Note:**
|
|
118
|
+
>
|
|
119
|
+
|
|
120
|
+
> The p8 certificate can only be downloaded once, so please keep it safe.
|
|
121
|
+
>
|
|
122
|
+
|
|
123
|
+
> Please keep the downloaded p8 file safe, as you will not be able to download it again. You can use this P8 certificate to configure your iOS application to receive push notifications.
|
|
124
|
+
>
|
|
125
|
+
|
|
126
|
+
### Step 2: Upload the p8 certificate to the Chat console
|
|
127
|
+
1. log in [ Chat Console](https://console.trtc.io/chat/push-plugin-push-identifier).
|
|
128
|
+
|
|
129
|
+
2. Click the target app card to go to the basic configuration page of the app.
|
|
130
|
+
|
|
131
|
+
3. Click **iOS native offline push settings** on the right, click **Add Certificate**.
|
|
132
|
+
|
|
133
|
+
4. Select .p8 certificate
|
|
134
|
+
|
|
135
|
+
5. Select the production environment and the development environment each to upload a file (You need to prepare the same materials, only the backend assigns the APNs push environment for you)
|
|
136
|
+
|
|
137
|
+
> **Note:**
|
|
138
|
+
>
|
|
139
|
+
> - **KeyID**: This is the unique identifier for your APNs Auth Key. When you create a new APNs Auth Key in the Apple Developer Center, the system generates a Key ID for you. You can find it in the "Certificates, Identifiers & Profiles" section under "Keys".
|
|
140
|
+
> - **TeamID**: This is the unique identifier for your developer account. You can find it on the account details page in the Apple Developer Center. Click "Membership" in the top right corner, and you will find your Team ID in the "Membership Details" section.
|
|
141
|
+
> - **BundleID**: This is the unique identifier for your application, also known as the Application ID. You can find it in the "Certificates, Identifiers & Profiles" section of the Apple Developer Center. Select "Identifiers," then find the corresponding Bundle ID in your application list.
|
|
142
|
+
|
|
143
|
+
##
|
|
144
|
+
1. Create a Description File
|
|
145
|
+
|
|
146
|
+
### Step 1: Create an App ID
|
|
147
|
+
1. **Log in to Apple Developer Center:**
|
|
148
|
+
|
|
149
|
+
- Go to [Apple Developer Center](https://developer.apple.com/account/) and log in to your developer account.
|
|
150
|
+
|
|
151
|
+
2. **Create an App ID:**
|
|
152
|
+
|
|
153
|
+
- In the "Certificates, Identifiers & Profiles" section, select "Identifiers".
|
|
154
|
+
|
|
155
|
+
- Click the "+" button to create a new App ID.
|
|
156
|
+
|
|
157
|
+
- Select "App IDs" and click "Continue".
|
|
158
|
+
|
|
159
|
+
- Enter your App ID name and Bundle ID (e.g., **com.yourcompany.yourapp**).
|
|
160
|
+
|
|
161
|
+
- Ensure to select the appropriate features (e.g., Push Notifications, App Groups, etc.), then click "Continue" and confirm.
|
|
162
|
+
|
|
163
|
+
### Step 2: Create an App ID for the Service Extension (optional)
|
|
164
|
+
- Repeat the above steps to create a new App ID for your Service Extension.
|
|
165
|
+
|
|
166
|
+
- The Bundle ID is usually the main application’s Bundle ID followed by the extension identifier, e.g., com.yourcompany.yourapp.extension.
|
|
167
|
+
|
|
168
|
+
### Step 3: Create a Description File
|
|
169
|
+
1. **Create a Description File:**
|
|
170
|
+
|
|
171
|
+
- In the "Certificates, Identifiers & Profiles" section, select "Profiles".
|
|
172
|
+
|
|
173
|
+
- Click the "+" button to create a new Description File.
|
|
174
|
+
|
|
175
|
+
- Select "iOS App Development" or "App Store" (based on your needs), then click "Continue".
|
|
176
|
+
|
|
177
|
+
- Select the App ID you just created (the main application’s App ID), then click "Continue".
|
|
178
|
+
|
|
179
|
+
- Select your development certificate and device (if it's a development description file), then click "Continue".
|
|
180
|
+
|
|
181
|
+
- Enter the name of the description file, then click "Generate".
|
|
182
|
+
|
|
183
|
+
2. **Create a Description File for the Service Extension (optional):**
|
|
184
|
+
|
|
185
|
+
- Repeat the above steps to create a new Description File for your Service Extension, ensuring you select the corresponding App ID.
|
|
186
|
+
|
|
187
|
+
### Step 4: Download and install the Description File
|
|
188
|
+
1. **Download Description File:**
|
|
189
|
+
|
|
190
|
+
- After creating the description file, click the "Download" button to download the Description File.
|
|
191
|
+
|
|
192
|
+
2. **Install Description File:**
|
|
193
|
+
|
|
194
|
+
- Double-click the downloaded Description File. It will automatically install in Xcode.
|
|
195
|
+
|
|
196
|
+
##
|
|
197
|
+
1. Add push permissions in Xcode
|
|
198
|
+
|
|
199
|
+
### To add push permissions to the app, enable the push notification feature in the Xcode project.
|
|
200
|
+
|
|
201
|
+
Open **Xcode** project, navigate to the Project > Target > Capabilities page, click the plus button in the red box, and then select and add **Push Notifications **.
|
|
202
|
+
|
|
203
|
+
The result after adding is shown in the red box in the figure.
|
|
204
|
+
|
|
205
|
+
## Four, generate App GroupID (optional)
|
|
206
|
+
|
|
207
|
+
When you need to use the TIMPush component to calculate the Push Arrival Rate, it is recommended to configure the TIMPushAppGroupID, then follow the quick access instructions to use it.
|
|
208
|
+
|
|
209
|
+
App GroupID identifies the shared App Group between the Main App and Extension, which needs to be configured in the App Groups capability of the Main App's Capability.
|
|
210
|
+
|
|
211
|
+
### Step 1: log in to the [Apple Developer Center](https://developer.apple.com/account/ios/certificate/development) website, go to **[identifiers] -> [App Groups]** to create AppGroups.
|
|
212
|
+
|
|
213
|
+
### Step 2: bind the AppID of the application you want to use to the AppGroups.
|
|
214
|
+
|
|
215
|
+
### Step 3: obtain your TIMPushAppGroupID.
|
|
216
|
+
|
|
217
|
+
### Step 4: configure TIMPushAppGroupID in Xcode.
|
|
218
|
+
|
|
219
|
+
Open **Xcode** project, go to Project > Target > Capabilities page, click the plus button in the red box, and then select and add **App Groups**.
|
|
220
|
+
|
|
221
|
+
Enter the GroupID configured in step 3, such as group.com.tencent.im.pushkey:
|
|
222
|
+
|
|
223
|
+
## Appendix: Developer Account, Certificate Type, and Description File
|
|
224
|
+
|
|
225
|
+
**Apple Developer Account:**
|
|
226
|
+
|
|
227
|
+
Creating iOS certificates and profiles requires a paid Apple account. There are three types of Apple developer accounts: Individual developer, Company developer, and Enterprise developer, each with different purposes.
|
|
228
|
+
- Individual developer and Company developer accounts cost $99 per year, while Enterprise developer accounts cost $299 per year.
|
|
229
|
+
|
|
230
|
+
- Enterprise developers are generally used by large enterprises when developing internal applications and cannot be published on the App Store.
|
|
231
|
+
|
|
232
|
+
- Please ensure you already have an Individual developer or Company developer account.
|
|
233
|
+
|
|
234
|
+
**Certificate Introduction:**
|
|
235
|
+
|
|
236
|
+
Certificates come in various types and serve different purposes. Here are the classifications of iOS certificates:
|
|
237
|
+
|
|
238
|
+
| <strong>Certificate Type</strong> | <strong>Differences</strong> |
|
|
239
|
+
| --- | --- |
|
|
240
|
+
| <strong>Developer Certificate</strong> (Developer Certificate) | Used for signing and debugging applications during the development phase. The developer certificate is issued by the Apple Developer Center and requires the use of Xcode or other development tools for application and management. |
|
|
241
|
+
| <strong>Distribution Certificate</strong> (Distribution Certificate) | Used to distribute applications to other users or upload them to the App Store for review. The distribution certificate is issued by the Apple Developer Center and requires the use of Xcode or other development tools for application and management. |
|
|
242
|
+
| <strong>Push Certificate</strong> (Push Certificate) | Used to implement APNs remote push feature, allowing the application to receive push notifications from the server. The push certificate is issued by the Apple Developer Center and requires the use of Xcode or other development tools for application and management. |
|
|
243
|
+
| <strong>Enterprise Certificate</strong> (Enterprise Certificate) | Used to distribute applications to internal employees or customers. The enterprise certificate is issued by the Apple Developer Center and requires the use of Xcode or other development tools for application and management. |
|
|
244
|
+
|
|
245
|
+
**Description File Introduction:**
|
|
246
|
+
|
|
247
|
+
Provisioning Profiles are also divided into two types: Development and Distribution. The configuration file includes certificates, App ID, and devices.
|
|
248
|
+
|
|
249
|
+
The file extension is .mobileprovision. It plays a role in configuration and validation within the developer account system and is necessary for real device debugging and packaging for release.
|
|
250
|
+
|
|
251
|
+
| <strong>Description File(</strong>Provisioning Profile<strong>)</strong> | <strong>Function</strong> |
|
|
252
|
+
| --- | --- |
|
|
253
|
+
| Development | - A Provisioning Profile corresponds to one App ID (Bundle ID)<br>- The Provisioning Profile determines which key pair (public key/private key) Xcode uses to sign the application, and it will be embedded into the .ipa package when the application is packaged.<br>- The Provisioning Profile packages all this information together, making it convenient for us to use when debugging and packaging the application for release. This way, just selecting different Provisioning Profile files in different situations will suffice.<br>- Provisioning Profiles are also divided into Development and Distribution types, with a validity period similar to Certificates. The Development version of the Provisioning Profile is used for development and debugging, while the Distribution version is mainly used for submitting to the App Store for review, and does not specify devices for development testing. |
|
|
254
|
+
| Distribution | |
|
|
@@ -0,0 +1,254 @@
|
|
|
1
|
+
React Native push currently supports vendor channels such as Xiaomi, Huawei, Honor, OPPO, vivo, Meizu, APNs, OnePlus, realme, iQOO, FCM, and Apple.
|
|
2
|
+
|
|
3
|
+
> **Note:**
|
|
4
|
+
>
|
|
5
|
+
|
|
6
|
+
> Each vendor only supports the configuration of one certificate.
|
|
7
|
+
>
|
|
8
|
+
|
|
9
|
+
【iOS】
|
|
10
|
+
|
|
11
|
+
Before integrating **@tencentcloud/react-native-push**, you need to apply for an APNs push certificate from Apple and upload it to the Chat console. Then follow the Quick Connection steps to integrate.
|
|
12
|
+
|
|
13
|
+
There are currently two mainstream types of certificates for Apple Manufacturer Configuration: p12 certificates and p8 certificates. Each type of certificate has its advantages and drawbacks, and you can choose one according to your needs.
|
|
14
|
+
| | <strong>Certificate Type</strong> | <strong>Validity Period and Management</strong> | <strong>Security</strong> | <strong>Dynamic Island</strong> |
|
|
15
|
+
| --- | --- | --- | --- | --- |
|
|
16
|
+
| <strong>p12 Certificate</strong> | A p12 certificate is a binary file containing a public key and a private key, used for certificate-based authentication. It bundles the public key certificate and the private key into one file with the extension .p12 or .pfx. | A p12 certificate typically has a validity period of one year and needs to be regenerated and deployed after expiration. Each application requires a separate p12 certificate to handle push notifications. | A p12 certificate uses certificate-based authentication and requires storing the private key on the server. This may increase security risks as the private key could be accessed by unauthorized users. | Not supported. |
|
|
17
|
+
| <strong>p8 Certificate</strong> | A p8 certificate is an Auth Key used for token-based authentication. It is a text file containing a private key with the extension .p8. | A p8 certificate does not have an expiration date, so you do not need to worry about certificate expiration. Additionally, using a p8 certificate simplifies certificate management as you can use one p8 certificate to provide push notification services for multiple applications. | A p8 certificate uses token-based authentication, which means your server periodically generates a JSON Web Token (JWT) to establish a connection with APNs. This method is more secure as it does not require storing the private key on the server. | Support Dynamic Island Push |
|
|
18
|
+
|
|
19
|
+
##
|
|
20
|
+
1. Using a p12 certificate (traditional push certificate)
|
|
21
|
+
|
|
22
|
+
### Step 1: Apply for an APNs certificate
|
|
23
|
+
|
|
24
|
+
#### Enable remote push for the app
|
|
25
|
+
1. log in to [Apple Developer Center](https://developer.apple.com/account/) website, click **Certificates, Identifiers & Profiles** or the sidebar's **Certificates, IDs & Profiles**, enter the **Certificates, IDS & Profiles** page.
|
|
26
|
+
|
|
27
|
+
2. click the **+** next to Identifiers.
|
|
28
|
+
|
|
29
|
+
3. You can follow the steps below to create a new AppID or add a `Push Notification``Service` to your existing AppID.
|
|
30
|
+
|
|
31
|
+
> **Note:**
|
|
32
|
+
>
|
|
33
|
+
|
|
34
|
+
> Your App's `Bundle ID` cannot use the wildcard `*`, otherwise, the remote push service cannot be used.
|
|
35
|
+
>
|
|
36
|
+
|
|
37
|
+
4. Check the **App IDs** box, click **Continue** to proceed to the next step.
|
|
38
|
+
|
|
39
|
+
5. Select **App**, click **Continue** to proceed to the next step.
|
|
40
|
+
|
|
41
|
+
6. Configure the `Bundle ID` and other information, click **Continue** to proceed to the next step.
|
|
42
|
+
|
|
43
|
+
7. Check the **Push Notifications** box to enable the remote push service.
|
|
44
|
+
|
|
45
|
+
#### Certificate Generation
|
|
46
|
+
1. Select your AppID and choose **Configure**.
|
|
47
|
+
|
|
48
|
+
2. In the **Apple Push Notification service SSL Certificates** window, there are two `SSL Certificates` for the development environment (Development) and the production environment (Production), as shown below:
|
|
49
|
+
|
|
50
|
+
3.
|
|
51
|
+
|
|
52
|
+
We first select the **Create Certificate** for the Development environment, the system will prompt us that we need a Certificate Signing Request (CSR).
|
|
53
|
+
|
|
54
|
+
4. On a Mac, open **Keychain Access tool**, in the menu select **Keychain Access** > **Certificate Assistant** > **Request a Certificate From a Certificate Authority** (`Keychain Access - Certificate Assistant - Request a Certificate From a Certificate Authority`).
|
|
55
|
+
|
|
56
|
+
5. Enter your email address, Common Name (your name or company name), select **Save to disk**, click **continue**, the system will generate a `*.certSigningRequest` file.
|
|
57
|
+
|
|
58
|
+
6. Go back to the page on the Apple Developer website mentioned in Step 3, click **Choose File** to upload the generated `*.certSigningRequest` file.
|
|
59
|
+
|
|
60
|
+
7. Click **Continue** to generate the push certificate.
|
|
61
|
+
|
|
62
|
+
8. click **Download** to download the `Development SSL Certificate` to your local environment.
|
|
63
|
+
|
|
64
|
+
9. Repeat steps 1 - 8 above to download the `Production SSL Certificate` for the production environment to your local machine.
|
|
65
|
+
|
|
66
|
+
> **Note:**
|
|
67
|
+
>
|
|
68
|
+
|
|
69
|
+
> The certificate for the production environment is actually a combined certificate of Development (Sandbox) + Production, and it can be used as a certificate for both the development and production environments.
|
|
70
|
+
>
|
|
71
|
+
|
|
72
|
+
10. Double-click the downloaded `SSL Certificate` for the development and production environments. The system will import it into the keychain.
|
|
73
|
+
|
|
74
|
+
11. Open the Keychain App, go to **log in to** > **My Certificates**, right-click to export the newly created `Apple Development IOS Push Services` and `Apple Push Services` for the development and production environments as `p12` files respectively.
|
|
75
|
+
|
|
76
|
+
> **Note**
|
|
77
|
+
>
|
|
78
|
+
|
|
79
|
+
> Note: Set the password when saving the `.p12` file.
|
|
80
|
+
>
|
|
81
|
+
|
|
82
|
+
### Step 2: Upload the certificate to the console
|
|
83
|
+
1. Log in to the [Chat Console](https://console.trtc.io/chat/push-plugin-push-identifier).
|
|
84
|
+
|
|
85
|
+
2. Enter **Access Settings** > **Manufacturer Configuration** > **iOS**.
|
|
86
|
+
|
|
87
|
+
3. Click **Add Certificate**.
|
|
88
|
+
|
|
89
|
+
4. Select the certificate type, upload the iOS Certificate (.p12), set the certificate password, and click **Confirm**.
|
|
90
|
+
|
|
91
|
+
> **Note:**
|
|
92
|
+
>
|
|
93
|
+
> - We recommend naming the uploaded certificate in English (special characters such as brackets are not allowed).
|
|
94
|
+
> - You need to set a password for the uploaded certificate. Without a password, push notifications cannot be received.
|
|
95
|
+
> - For an app published on App Store, the environment of the certificate must be the production environment. Otherwise, push notifications cannot be received.
|
|
96
|
+
> - The uploaded .p12 certificate must be your own authentic and valid certificate.
|
|
97
|
+
|
|
98
|
+
## Second, using a p8 certificate (supports Dynamic Island push notifications)
|
|
99
|
+
|
|
100
|
+
p8 Certificate: A p8 certificate does not have an expiration date, so you don't have to worry about the certificate expiring. Moreover, using a p8 certificate can simplify certificate management, as you can use a single p8 certificate to provide push notification services for multiple applications. In addition, p8 certificates support Dynamic Island push notifications.
|
|
101
|
+
|
|
102
|
+
### Step 1: Apply for an APNs certificate
|
|
103
|
+
|
|
104
|
+
To create a p8 certificate file, first log in to [Apple Developer Center](https://developer.apple.com/).
|
|
105
|
+
|
|
106
|
+
1. Enter Certificates, Identifiers & Profiles: In the top right corner of the page, click **Account**, then select **Certificates, Identifiers & Profiles** from the dropdown menu.
|
|
107
|
+
|
|
108
|
+
2. To create a new App ID: in the left-hand menu, click **Identifiers**, then click the **+** on the right to create a new App ID. Fill in the relevant information and click **Continue**.
|
|
109
|
+
|
|
110
|
+
3. To create a new key: in the left-hand menu, click **Keys**, then click the **+** on the right to create a new key. Enter the name of the key, then check **Apple Push Notifications service (APNs)** and click **Continue**.
|
|
111
|
+
|
|
112
|
+
Confirm and generate the key: On the confirmation page, verify your key information, then click **Register**. Next, you'll see a page prompting you to download the key. Click **Download** and save the generated .p8 file to your computer.
|
|
113
|
+
|
|
114
|
+
> **Note:**
|
|
115
|
+
>
|
|
116
|
+
> - The p8 certificate can only be downloaded once; please save it properly.
|
|
117
|
+
> - Please safeguard the downloaded p8 file, as you will not be able to download it again. You can use this p8 certificate to configure your iOS applications to receive push notifications.
|
|
118
|
+
|
|
119
|
+
### Step 2: Upload the p8 certificate to the Chat console
|
|
120
|
+
1. Log in to the [Chat Console](https://console.trtc.io/chat/push-plugin-push-identifier).
|
|
121
|
+
|
|
122
|
+
2. Click the target app card to go to the basic configuration page of the app.
|
|
123
|
+
|
|
124
|
+
3. Click **iOS Native Offline Push Settings** on the right side and then click **Add Certificate**.
|
|
125
|
+
|
|
126
|
+
4. Select the .p8 certificate, upload the iOS Certificate (.p8), set **KeyID、TeamID and BundleID**, and click **Confirm**.
|
|
127
|
+
|
|
128
|
+
> **Note:**
|
|
129
|
+
>
|
|
130
|
+
> - **KeyID**: This is the unique identifier for your APNs Auth Key. When you create a new APNs Auth Key in the Apple Developer Center, a Key ID will be generated for you. You can find it in the "Certificates, Identifiers & Profiles" section under "Keys".
|
|
131
|
+
> - **TeamID**: This is the unique identifier for your developer account. You can find it on the account details page of the Apple Developer Center. Click "Membership" in the upper right corner, and you can find your Team ID in the "Membership Details" section.
|
|
132
|
+
> - **BundleID**: This is the unique identifier for your application, also known as the app ID. You can find it in the "Certificates, Identifiers & Profiles" section of the Apple Developer Center. Select "Identifiers", then find the corresponding Bundle ID in your list of applications.
|
|
133
|
+
|
|
134
|
+
【Android】
|
|
135
|
+
|
|
136
|
+
## Operation Steps
|
|
137
|
+
|
|
138
|
+
### Step 1. Register your app with vendor push platforms
|
|
139
|
+
|
|
140
|
+
Offline push requires you to register your app with each vendor's push platform to obtain parameters such as AppID and AppKey, enabling the offline push feature. Currently, the domestic smartphone vendors supported are: [Xiaomi](https://dev.mi.com/console/doc/detail), [Huawei](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/service-introduction-0000001050040060), [Honor](https://developer.hihonor.com/cn/kitdoc), [OPPO](https://open.oppomobile.com/wiki/doc#id=10195), [VIVO](https://dev.vivo.com.cn/documentCenter/doc/281), [Meizu](https://open.flyme.cn/service/3), and overseas support includes [Google FCM](https://console.firebase.google.com/u/0/).
|
|
141
|
+
|
|
142
|
+
### Step 2. Create resources in the Chat console
|
|
143
|
+
|
|
144
|
+
Log in to Tencent Cloud [Chat Console](https://console.trtc.io/chat/push-plugin-push-identifier), under **Push Management** > **Access Settings** feature tab, add the push certificates for each vendor, and configure the AppId, AppKey, AppSecret, and other parameters obtained in step one to the added push certificates.
|
|
145
|
+
|
|
146
|
+
> **Note:**
|
|
147
|
+
>
|
|
148
|
+
|
|
149
|
+
> Regarding the **Action after Click** option, to use the click-to-navigate feature provided by this plugin, please keep the default value unchanged, which is usually `Open a specified page within the app` with default settings. (Note)
|
|
150
|
+
>
|
|
151
|
+
|
|
152
|
+
> To use the reporting statistics feature, also keep this item at its default value. (Note)
|
|
153
|
+
>
|
|
154
|
+
|
|
155
|
+
【Mi】
|
|
156
|
+
|
|
157
|
+
|Vendor Push Platform|Configuring in the Chat console|
|
|
158
|
+
|---------|---------|
|
|
159
|
+
|||
|
|
160
|
+
|
|
161
|
+
【Huawei】
|
|
162
|
+
| Vendor Push Platform | Configuring in the Chat console |
|
|
163
|
+
| --- | --- |
|
|
164
|
+
| | <strong>Note:</strong><br>Client ID corresponds to AppID, and Client Secret corresponds to AppSecret. |
|
|
165
|
+
|
|
166
|
+
#### Receipt configuration
|
|
167
|
+
|
|
168
|
+
**Receipt Address:**
|
|
169
|
+
- Singapore : https://apisgp.im.qcloud.com/v3/offline_push_report/huawei
|
|
170
|
+
|
|
171
|
+
- Korea: https://apikr.im.qcloud.com/v3/offline_push_report/huawei
|
|
172
|
+
|
|
173
|
+
- USA: https://apiusa.im.qcloud.com/v3/offline_push_report/huawei
|
|
174
|
+
|
|
175
|
+
- Germany: https://apiger.im.qcloud.com/v3/offline_push_report/huawei
|
|
176
|
+
|
|
177
|
+
- Indonesia: https://apiidn.im.qcloud.com/v3/offline_push_report/huawei
|
|
178
|
+
|
|
179
|
+
- China: https://api.im.qcloud.com/v3/offline_push_report/huawei
|
|
180
|
+
|
|
181
|
+
【OPPO】
|
|
182
|
+
|
|
183
|
+
|Vendor Push Platform|Configuring in the Chat console|
|
|
184
|
+
|---------|---------|
|
|
185
|
+
|||
|
|
186
|
+
|
|
187
|
+
【vivo】
|
|
188
|
+
|
|
189
|
+
|Vendor Push Platform|Configuring in the Chat console|
|
|
190
|
+
|---------|---------|
|
|
191
|
+
|||
|
|
192
|
+
|
|
193
|
+
#### Receipt configuration
|
|
194
|
+
|
|
195
|
+
**Receipt Address:**
|
|
196
|
+
- Singapore :https://apisgp.im.qcloud.com/v3/offline_push_report/vivo
|
|
197
|
+
|
|
198
|
+
- Korea:https://apikr.im.qcloud.com/v3/offline_push_report/vivo
|
|
199
|
+
|
|
200
|
+
- USA: https://apiusa.im.qcloud.com/v3/offline_push_report/vivo
|
|
201
|
+
|
|
202
|
+
- Germany: https://apiger.im.qcloud.com/v3/offline_push_report/vivo
|
|
203
|
+
|
|
204
|
+
- Indonesia: https://apiidn.im.qcloud.com/v3/offline_push_report/vivo
|
|
205
|
+
|
|
206
|
+
- China: https://api.im.qcloud.com/v3/offline_push_report/vivo
|
|
207
|
+
|
|
208
|
+
【Meizu】
|
|
209
|
+
|
|
210
|
+
|Vendor Push Platform|Configuring in the Chat console|
|
|
211
|
+
|---------|---------|
|
|
212
|
+
|||
|
|
213
|
+
|
|
214
|
+
#### Receipt configuration
|
|
215
|
+
|
|
216
|
+
**Receipt Address:**
|
|
217
|
+
- Singapore : https://apisgp.im.qcloud.com/v3/offline_push_report/meizu
|
|
218
|
+
|
|
219
|
+
- Korea: https://apikr.im.qcloud.com/v3/offline_push_report/meizu
|
|
220
|
+
|
|
221
|
+
- USA: https://apiusa.im.qcloud.com/v3/offline_push_report/meizu
|
|
222
|
+
|
|
223
|
+
- Germany: https://apiger.im.qcloud.com/v3/offline_push_report/meizu
|
|
224
|
+
|
|
225
|
+
- Indonesia: https://apiidn.im.qcloud.com/v3/offline_push_report/meizu
|
|
226
|
+
|
|
227
|
+
- China: https://api.im.qcloud.com/v3/offline_push_report/meizu
|
|
228
|
+
|
|
229
|
+
【HONOR】
|
|
230
|
+
|
|
231
|
+
|Vendor Push Platform|Configuring in the Chat console|
|
|
232
|
+
|---------|---------|
|
|
233
|
+
|||
|
|
234
|
+
|
|
235
|
+
#### Receipt configuration
|
|
236
|
+
|
|
237
|
+
**Receipt Address:**
|
|
238
|
+
- Singapore : https://apisgp.im.qcloud.com/v3/offline_push_report/honor
|
|
239
|
+
|
|
240
|
+
- Korea: https://apikr.im.qcloud.com/v3/offline_push_report/honor
|
|
241
|
+
|
|
242
|
+
- USA: https://apiusa.im.qcloud.com/v3/offline_push_report/honor
|
|
243
|
+
|
|
244
|
+
- Germany: https://apiger.im.qcloud.com/v3/offline_push_report/honor
|
|
245
|
+
|
|
246
|
+
- Indonesia: https://apiidn.im.qcloud.com/v3/offline_push_report/honor
|
|
247
|
+
|
|
248
|
+
- China: https://api.im.qcloud.com/v3/offline_push_report/honor
|
|
249
|
+
|
|
250
|
+
【Google FCM】
|
|
251
|
+
|
|
252
|
+
|Vendor Push Platform|Configuring in the Chat console|
|
|
253
|
+
|---------|---------|
|
|
254
|
+
|||
|