@tencent-rtc/mcp 1.3.9 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +2 -2
- package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/android-faq.md} +10 -22
- package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/flutter-faq.md} +10 -22
- package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/ios-faq.md} +10 -22
- package/resource/doc/callkit/preset/android/api.md +296 -0
- package/resource/doc/{tuicallkit → callkit/preset}/android/integration.md +53 -365
- package/resource/doc/callkit/preset/flutter/api.md +410 -0
- package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +35 -97
- package/resource/doc/callkit/preset/ios/api.md +80 -0
- package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +37 -118
- package/resource/doc/callkit/preset/react/api.md +501 -0
- package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +5 -20
- package/resource/doc/callkit/preset/vue/api.md +501 -0
- package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +4 -19
- package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -38
- package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
- package/resource/doc/{chatuikit → chatkit}/android/integration.md +28 -121
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +281 -0
- package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +0 -1
- package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -1
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +199 -0
- package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +235 -0
- package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +3 -3
- package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
- package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +18 -87
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -38
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +47 -165
- package/resource/doc/{chatuikit → chatkit}/react/components/avatar.md +0 -33
- package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +8 -49
- package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +6 -35
- package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +0 -6
- package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -11
- package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +96 -502
- package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
- package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
- package/resource/doc/chatkit/react/components/conversation-preview.md +118 -0
- package/resource/doc/chatkit/react/components/conversation-search.md +60 -0
- package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -337
- package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +20 -212
- package/resource/doc/chatkit/react/components/search.md +243 -0
- package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +1 -47
- package/resource/doc/{chatuikit → chatkit}/react/integration.md +21 -81
- package/resource/doc/{chatuikit → chatkit}/vue/components/avatar.md +0 -33
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -48
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +3 -5
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +0 -5
- package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -15
- package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
- package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
- package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -492
- package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
- package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
- package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +2 -223
- package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -252
- package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
- package/resource/doc/{chatuikit → chatkit}/vue/components/tuikit.md +7 -21
- package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +3 -62
- package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
- package/resource/doc/{chatuikit → chatkit}/vue/integration.md +22 -23
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +18 -89
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +28 -141
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +20 -112
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +59 -193
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +94 -344
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +107 -515
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +33 -173
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +14 -93
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -179
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +19 -107
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -166
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -163
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +69 -443
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +107 -492
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +23 -165
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +35 -111
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +35 -193
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +31 -144
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +24 -116
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +37 -171
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +79 -459
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +69 -320
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +85 -502
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +32 -169
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md +18 -89
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audio-effect.md +34 -192
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-barrage.md +28 -141
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-co-guest-interaction.md +50 -259
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-gift.md +75 -455
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-host-interaction.md +51 -265
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-integration.md +61 -427
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-list.md +33 -173
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-co-guest-interaction.md +44 -203
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-integration.md +56 -416
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audience-list.md +35 -111
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audio-effect.md +35 -193
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-barrage.md +31 -144
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-co-guest-interaction.md +43 -252
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-gift.md +79 -459
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-host-interaction.md +46 -264
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-integration.md +61 -445
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-room-list.md +32 -169
- package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -2
- package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
- package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
- package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +10 -49
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +26 -144
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +12 -75
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +36 -227
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +215 -0
- package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
- package/resource/doc/livekit/preset/live/vue/live-list-integration.md +241 -0
- package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +299 -0
- package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +300 -0
- package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +743 -0
- package/resource/doc/roomkit/vue/faq.md +1 -0
- package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
- package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
- package/resource/doc/roomkit/vue/features/device-state.md +24 -44
- package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
- package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
- package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
- package/resource/doc/roomkit/vue/features/room-state.md +25 -34
- package/resource/doc/roomkit/vue/features/room-view.md +30 -125
- package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
- package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
- package/resource/doc/roomkit/vue/features/virtual-background.md +13 -29
- package/resource/doc/roomkit/vue/integration.md +21 -76
- package/resource/doc/rtcengine/faq/common/error_code.md +1 -0
- package/resource/doc/rtcengine/faq/web/web.md +14 -24
- package/resource/doc/rtcengine/web/api.md +1 -3
- package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +3 -10
- package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +1 -5
- package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +1 -2
- package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -4
- package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +3 -5
- package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +1 -7
- package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +0 -2
- package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -8
- package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +11 -11
- package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +12 -88
- package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -5
- package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +30 -37
- package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +13 -90
- package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -2
- package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +1 -2
- package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +19 -19
- package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
- package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -5
- package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
- package/resource/doc/trtc/C++/ITRTCCloud.md +686 -2835
- package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +202 -1022
- package/resource/doc/trtc/C++/ITXDeviceManager.md +126 -767
- package/resource/doc/trtc/C++/TRTCCloudCallback.md +579 -2147
- package/resource/doc/trtc/C++/TRTCTypeDef.md +703 -3378
- package/resource/doc/trtc/C++/TXLiteAVCode.md +116 -908
- package/resource/doc/trtc/android/TRTCCloud.md +606 -2573
- package/resource/doc/trtc/android/TRTCCloudDef.md +752 -3640
- package/resource/doc/trtc/android/TRTCCloudListener.md +581 -2008
- package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
- package/resource/doc/trtc/android/TXAudioEffectManager.md +202 -1022
- package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
- package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
- package/resource/doc/trtc/android/TXLiteAVCode.md +114 -892
- package/resource/doc/trtc/iOS/TRTCCloud.md +694 -2904
- package/resource/doc/trtc/iOS/TRTCCloudDef.md +726 -3498
- package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +543 -2028
- package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
- package/resource/doc/trtc/iOS/TXAudioEffectManager.md +174 -877
- package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
- package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
- package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
- package/server.js +1 -5
- package/server.js.map +1 -1
- package/tools/call/get_callkit_api.js +32 -0
- package/tools/call/get_callkit_api.js.map +1 -0
- package/tools/call/get_native_call_uikit_integration.js +34 -0
- package/tools/call/get_native_call_uikit_integration.js.map +1 -0
- package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
- package/tools/call/get_web_call_uikit_integration.js.map +1 -0
- package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
- package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
- package/tools/chat/get_native_chat_uikit_integration.js +45 -0
- package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
- package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
- package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
- package/tools/chat/get_web_chat_uikit_integration.js +45 -0
- package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
- package/tools/common/get_faq.js +265 -0
- package/tools/common/get_faq.js.map +1 -0
- package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
- package/tools/common/get_usersig.js.map +1 -0
- package/tools/common/present_framework_choice.js +63 -0
- package/tools/common/present_framework_choice.js.map +1 -0
- package/tools/definitions/get_callkit_api_def.js +29 -0
- package/tools/definitions/get_callkit_api_def.js.map +1 -0
- package/tools/definitions/get_faq_def.js +17 -18
- package/tools/definitions/get_faq_def.js.map +1 -1
- package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
- package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
- package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
- package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_livekit_core_features_def.js +34 -0
- package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js +34 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
- package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
- package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
- package/tools/definitions/get_usersig_def.js +17 -22
- package/tools/definitions/get_usersig_def.js.map +1 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
- package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
- package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js +15 -18
- package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_livekit_api_def.js +30 -0
- package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
- package/tools/definitions/get_web_livekit_component_detail_def.js +32 -0
- package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +15 -46
- package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_roomkit_feature_detail_def.js +31 -0
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_api_def.js +27 -0
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +27 -0
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +27 -0
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
- package/tools/definitions/present_framework_choice_def.js +24 -12
- package/tools/definitions/present_framework_choice_def.js.map +1 -1
- package/tools/index.js +47 -61
- package/tools/index.js.map +1 -1
- package/tools/live/get_native_livekit_core_features.js +65 -0
- package/tools/live/get_native_livekit_core_features.js.map +1 -0
- package/tools/live/get_native_livekit_core_integration.js +59 -0
- package/tools/live/get_native_livekit_core_integration.js.map +1 -0
- package/tools/live/get_web_live_uikit_integration.js +48 -0
- package/tools/live/get_web_live_uikit_integration.js.map +1 -0
- package/tools/live/get_web_livekit_api.js +32 -0
- package/tools/live/get_web_livekit_api.js.map +1 -0
- package/tools/live/get_web_livekit_component_detail.js +34 -0
- package/tools/live/get_web_livekit_component_detail.js.map +1 -0
- package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
- package/tools/room/get_web_room_uikit_integration.js.map +1 -0
- package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
- package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
- package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
- package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
- package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
- package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
- package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
- package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
- package/utils/generate-structured-result.js +61 -17
- package/utils/generate-structured-result.js.map +1 -1
- package/utils/report-cls-client.js +12 -1
- package/utils/report-cls-client.js.map +1 -1
- package/utils/report-es-client.js +2 -2
- package/resource/doc/chatuikit/android/workflow.md +0 -713
- package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1371
- package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -932
- package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1119
- package/resource/doc/chatuikit/flutter/workflow.md +0 -941
- package/resource/doc/chatuikit/react/components/conversation-list.md +0 -1017
- package/resource/doc/chatuikit/react/components/search.md +0 -745
- package/resource/doc/chatuikit/react/create-group.md +0 -23
- package/resource/doc/chatuikit/react/init.md +0 -26
- package/resource/doc/chatuikit/react/workflow.md +0 -258
- package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
- package/resource/doc/chatuikit/vue/create-group.md +0 -25
- package/resource/doc/chatuikit/vue/init.md +0 -40
- package/resource/doc/chatuikit/vue/workflow.md +0 -395
- package/resource/doc/livekit/live/android/workflow.md +0 -320
- package/resource/doc/livekit/live/flutter/workflow.md +0 -353
- package/resource/doc/livekit/live/ios/workflow.md +0 -454
- package/resource/doc/livekit/live/vue/components/barrage.md +0 -616
- package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -446
- package/resource/doc/livekit/live/vue/faq.md +0 -0
- package/resource/doc/livekit/live/vue/live-list-integration.md +0 -200
- package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -269
- package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -269
- package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -595
- package/resource/doc/livekit/live/vue/states/live-state.md +0 -3591
- package/resource/doc/livekit/live/vue/workflow.md +0 -218
- package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -312
- package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -430
- package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -679
- package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -671
- package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -271
- package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
- package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
- package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
- package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
- package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -865
- package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -657
- package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -437
- package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -335
- package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
- package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -327
- package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -507
- package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
- package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -659
- package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
- package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -814
- package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1000
- package/resource/doc/roomkit/vue/features/workflow.md +0 -553
- package/resource/doc/roomkit/vue/workflow.md +0 -733
- package/resource/doc/tuicallkit/android/workflow.md +0 -441
- package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -784
- package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -610
- package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -938
- package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -897
- package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -469
- package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -781
- package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -398
- package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
- package/resource/doc/tuicallkit/react/api.md +0 -1404
- package/resource/doc/tuicallkit/vue/api.md +0 -1406
- package/resource/doc/tuicallkit/vue/faq.md +0 -36
- package/tools/call/get-native-call-integration.js +0 -43
- package/tools/call/get-native-call-integration.js.map +0 -1
- package/tools/call/get-web-call-api.js +0 -27
- package/tools/call/get-web-call-api.js.map +0 -1
- package/tools/call/get-web-call-integration.js.map +0 -1
- package/tools/chat/get-native-chat-feature-detail.js +0 -30
- package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
- package/tools/chat/get-native-chat-integration.js +0 -45
- package/tools/chat/get-native-chat-integration.js.map +0 -1
- package/tools/chat/get-web-chat-component-detail.js +0 -31
- package/tools/chat/get-web-chat-component-detail.js.map +0 -1
- package/tools/chat/get-web-chat-integration.js +0 -45
- package/tools/chat/get-web-chat-integration.js.map +0 -1
- package/tools/chat/get-web-chat-uikit-init.js +0 -28
- package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
- package/tools/chat/get-web-create-group-doc.js +0 -28
- package/tools/chat/get-web-create-group-doc.js.map +0 -1
- package/tools/common/get-faq.js +0 -91
- package/tools/common/get-faq.js.map +0 -1
- package/tools/common/get-usersig.js.map +0 -1
- package/tools/common/present-framework-choice.js +0 -16
- package/tools/common/present-framework-choice.js.map +0 -1
- package/tools/common/present-scenario-choice.js +0 -16
- package/tools/common/present-scenario-choice.js.map +0 -1
- package/tools/common/record-prompt.js +0 -55
- package/tools/common/record-prompt.js.map +0 -1
- package/tools/common/record-result.js +0 -60
- package/tools/common/record-result.js.map +0 -1
- package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
- package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_native_live_api_def.js +0 -23
- package/tools/definitions/get_native_live_api_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -87
- package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
- package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
- package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
- package/tools/definitions/get_trtc_native_api_def.js +0 -16
- package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
- package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
- package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
- package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
- package/tools/definitions/get_web_create_group_doc_def.js +0 -18
- package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
- package/tools/definitions/get_web_live_state_detail_def.js +0 -19
- package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
- package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
- package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
- package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_web_room_state_detail_def.js +0 -19
- package/tools/definitions/get_web_room_state_detail_def.js.map +0 -1
- package/tools/definitions/present_scenario_choice_def.js +0 -53
- package/tools/definitions/present_scenario_choice_def.js.map +0 -1
- package/tools/definitions/record_prompt_def.js +0 -58
- package/tools/definitions/record_prompt_def.js.map +0 -1
- package/tools/definitions/record_result_def.js +0 -46
- package/tools/definitions/record_result_def.js.map +0 -1
- package/tools/live/get-native-live-uikit-integration.js +0 -177
- package/tools/live/get-native-live-uikit-integration.js.map +0 -1
- package/tools/live/get-web-live-component-detail.js +0 -31
- package/tools/live/get-web-live-component-detail.js.map +0 -1
- package/tools/live/get-web-live-state-detail.js +0 -31
- package/tools/live/get-web-live-state-detail.js.map +0 -1
- package/tools/live/get-web-live-uikit-integration.js +0 -52
- package/tools/live/get-web-live-uikit-integration.js.map +0 -1
- package/tools/live/get_native_live_uikit_extra_features.js +0 -105
- package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
- package/tools/live/get_native_live_uikit_interaction.js +0 -194
- package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
- package/tools/native_live/get-native-live-api.js +0 -31
- package/tools/native_live/get-native-live-api.js.map +0 -1
- package/tools/room/get-web-room-feature-detail.js.map +0 -1
- package/tools/room/get-web-room-integration.js.map +0 -1
- package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
- package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
- package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
- package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
- package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
- package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
- package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
- package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
- package/tools/trtc/get-trtc-native-api.js +0 -31
- package/tools/trtc/get-trtc-native-api.js.map +0 -1
- package/utils/handle-component-name.js +0 -33
- package/utils/handle-component-name.js.map +0 -1
- /package/resource/doc/{chatuikit/iOS/workflow.md → callkit/core-sdk/.gitkeep} +0 -0
- /package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +0 -0
- /package/resource/doc/{tuicallkit/react/faq.md → callkit/faq/web-faq.md} +0 -0
- /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
- /package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +0 -0
- /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
- /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
- /package/resource/doc/roomkit/faq/common/{error_code.md → error-code.md} +0 -0
|
@@ -1,1119 +0,0 @@
|
|
|
1
|
-
> **Note:**
|
|
2
|
-
>
|
|
3
|
-
|
|
4
|
-
> **Do not use APIs of new and old versions at the same time**.
|
|
5
|
-
>
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
## Initialization and Login APIs
|
|
9
|
-
|
|
10
|
-
To use the Tencent Cloud Chat service, you need to initialize the SDK and log in.
|
|
11
|
-
<table>
|
|
12
|
-
<tr>
|
|
13
|
-
<td rowspan="1" colSpan="1" >API</td>
|
|
14
|
-
|
|
15
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
16
|
-
</tr>
|
|
17
|
-
|
|
18
|
-
<tr>
|
|
19
|
-
<td rowspan="1" colSpan="1" >[initSDK](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a8035eed3a7c9b3b1c229196ac7bc5da6)</td>
|
|
20
|
-
|
|
21
|
-
<td rowspan="1" colSpan="1" >Initializes the SDK.</td>
|
|
22
|
-
</tr>
|
|
23
|
-
|
|
24
|
-
<tr>
|
|
25
|
-
<td rowspan="1" colSpan="1" >[unInitSDK](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a286e5358ec4cd0a8f9c66f4d2d7d4544)</td>
|
|
26
|
-
|
|
27
|
-
<td rowspan="1" colSpan="1" >Uninitializes the SDK</td>
|
|
28
|
-
</tr>
|
|
29
|
-
|
|
30
|
-
<tr>
|
|
31
|
-
<td rowspan="1" colSpan="1" >[addIMSDKListener](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#ac569656a58908afba491710a8cb3c8d9)</td>
|
|
32
|
-
|
|
33
|
-
<td rowspan="1" colSpan="1" >Adds the Chat listener.</td>
|
|
34
|
-
</tr>
|
|
35
|
-
|
|
36
|
-
<tr>
|
|
37
|
-
<td rowspan="1" colSpan="1" >[removeIMSDKListener](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a2e2a7e64bf51888c98636e5974a8aca7)</td>
|
|
38
|
-
|
|
39
|
-
<td rowspan="1" colSpan="1" >Removes the Chat listener.</td>
|
|
40
|
-
</tr>
|
|
41
|
-
|
|
42
|
-
<tr>
|
|
43
|
-
<td rowspan="1" colSpan="1" >[getVersion](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#ae8281def98e669d701171ede7aa3c176)</td>
|
|
44
|
-
|
|
45
|
-
<td rowspan="1" colSpan="1" >Gets the version number.</td>
|
|
46
|
-
</tr>
|
|
47
|
-
|
|
48
|
-
<tr>
|
|
49
|
-
<td rowspan="1" colSpan="1" >[getServerTime](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a4adcf2642bcb706cd6cfe7e5c5f85f06)</td>
|
|
50
|
-
|
|
51
|
-
<td rowspan="1" colSpan="1" >Gets the server time.</td>
|
|
52
|
-
</tr>
|
|
53
|
-
|
|
54
|
-
<tr>
|
|
55
|
-
<td rowspan="1" colSpan="1" >[login](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a38c42943046acdaf615915c9422af07c)</td>
|
|
56
|
-
|
|
57
|
-
<td rowspan="1" colSpan="1" >Logs in.</td>
|
|
58
|
-
</tr>
|
|
59
|
-
|
|
60
|
-
<tr>
|
|
61
|
-
<td rowspan="1" colSpan="1" >[logout](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a20b495d7f7a231ea33507ca4a79f811f)</td>
|
|
62
|
-
|
|
63
|
-
<td rowspan="1" colSpan="1" >Logs a user out</td>
|
|
64
|
-
</tr>
|
|
65
|
-
|
|
66
|
-
<tr>
|
|
67
|
-
<td rowspan="1" colSpan="1" >[getLoginUser](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a78ca7f39bca860e46620f8f766508fb0)</td>
|
|
68
|
-
|
|
69
|
-
<td rowspan="1" colSpan="1" >Gets the currently logged-in user.</td>
|
|
70
|
-
</tr>
|
|
71
|
-
|
|
72
|
-
<tr>
|
|
73
|
-
<td rowspan="1" colSpan="1" >[getLoginStatus](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#acfd2f6366780badf80ebf66d95550f89)</td>
|
|
74
|
-
|
|
75
|
-
<td rowspan="1" colSpan="1" >Gets the login status</td>
|
|
76
|
-
</tr>
|
|
77
|
-
</table>
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
## Simple Message APIs
|
|
81
|
-
|
|
82
|
-
Use the following APIs for the sending and receiving of text and signaling (custom buffer) messages.
|
|
83
|
-
<table>
|
|
84
|
-
<tr>
|
|
85
|
-
<td rowspan="1" colSpan="1" >API</td>
|
|
86
|
-
|
|
87
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
88
|
-
</tr>
|
|
89
|
-
|
|
90
|
-
<tr>
|
|
91
|
-
<td rowspan="1" colSpan="1" >[addSimpleMsgListener](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a149cdf7924aa13746692d18d605def88)</td>
|
|
92
|
-
|
|
93
|
-
<td rowspan="1" colSpan="1" >Sets an event listener for simple messages (text messages and custom messages).Do not use this API and [addAdvancedMsgListener](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#acf794752cc6bfa786aea5cd7fabadfab) at the same time.</td>
|
|
94
|
-
</tr>
|
|
95
|
-
|
|
96
|
-
<tr>
|
|
97
|
-
<td rowspan="1" colSpan="1" >[removeSimpleMsgListener](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#afa3040f676105f3fb78d4835ee3c898b)</td>
|
|
98
|
-
|
|
99
|
-
<td rowspan="1" colSpan="1" >Removes the event listener for simple messages (text messages and custom messages)</td>
|
|
100
|
-
</tr>
|
|
101
|
-
|
|
102
|
-
<tr>
|
|
103
|
-
<td rowspan="1" colSpan="1" >[sendC2CTextMessage](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a50d63810093eccc0491d058d0b883618)</td>
|
|
104
|
-
|
|
105
|
-
<td rowspan="1" colSpan="1" >Sends a one-to-one chat (C2C) text message</td>
|
|
106
|
-
</tr>
|
|
107
|
-
|
|
108
|
-
<tr>
|
|
109
|
-
<td rowspan="1" colSpan="1" >[sendC2CCustomMessage](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a5fc3b87e9782e679c08926d07e486b90)</td>
|
|
110
|
-
|
|
111
|
-
<td rowspan="1" colSpan="1" >Sends a one-to-one chat (C2C) custom (signaling) message</td>
|
|
112
|
-
</tr>
|
|
113
|
-
|
|
114
|
-
<tr>
|
|
115
|
-
<td rowspan="1" colSpan="1" >[sendGroupTextMessage](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a07788874071937fac6c7093185b145f7)</td>
|
|
116
|
-
|
|
117
|
-
<td rowspan="1" colSpan="1" >Sends a group chat text message</td>
|
|
118
|
-
</tr>
|
|
119
|
-
|
|
120
|
-
<tr>
|
|
121
|
-
<td rowspan="1" colSpan="1" >[sendGroupCustomMessage](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a537560a58d49aad36406f6d9db6ded65)</td>
|
|
122
|
-
|
|
123
|
-
<td rowspan="1" colSpan="1" >Sends a group chat custom (signaling) message</td>
|
|
124
|
-
</tr>
|
|
125
|
-
</table>
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
## Signaling APIs
|
|
129
|
-
<table>
|
|
130
|
-
<tr>
|
|
131
|
-
<td rowspan="1" colSpan="1" >API</td>
|
|
132
|
-
|
|
133
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
134
|
-
</tr>
|
|
135
|
-
|
|
136
|
-
<tr>
|
|
137
|
-
<td rowspan="1" colSpan="1" >[addSignalingListener](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Signaling_08.html#a3a7fde0d4d5a342bd93299deaf98e1d1)</td>
|
|
138
|
-
|
|
139
|
-
<td rowspan="1" colSpan="1" >Adds a signaling listener.</td>
|
|
140
|
-
</tr>
|
|
141
|
-
|
|
142
|
-
<tr>
|
|
143
|
-
<td rowspan="1" colSpan="1" >[removeSignalingListener](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Signaling_08.html#ae730297ec335735eee3c2f3c464bde33)</td>
|
|
144
|
-
|
|
145
|
-
<td rowspan="1" colSpan="1" >Removes a signaling listener.</td>
|
|
146
|
-
</tr>
|
|
147
|
-
|
|
148
|
-
<tr>
|
|
149
|
-
<td rowspan="1" colSpan="1" >[invite](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Signaling_08.html#a594071fa1a70373582ed6082c581b332)</td>
|
|
150
|
-
|
|
151
|
-
<td rowspan="1" colSpan="1" >Invites a user.</td>
|
|
152
|
-
</tr>
|
|
153
|
-
|
|
154
|
-
<tr>
|
|
155
|
-
<td rowspan="1" colSpan="1" >[inviteInGroup](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Signaling_08.html#ac01a4e703c925aaf5f78df67faca15be)</td>
|
|
156
|
-
|
|
157
|
-
<td rowspan="1" colSpan="1" >Invites certain users in a group.</td>
|
|
158
|
-
</tr>
|
|
159
|
-
|
|
160
|
-
<tr>
|
|
161
|
-
<td rowspan="1" colSpan="1" >[cancel](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Signaling_08.html#acaac35e5db28db783420b5eb39d53e6f)</td>
|
|
162
|
-
|
|
163
|
-
<td rowspan="1" colSpan="1" >Cancels an invitation.</td>
|
|
164
|
-
</tr>
|
|
165
|
-
|
|
166
|
-
<tr>
|
|
167
|
-
<td rowspan="1" colSpan="1" >[accept](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Signaling_08.html#a1ffb6daba9deed8780f869205daf7771)</td>
|
|
168
|
-
|
|
169
|
-
<td rowspan="1" colSpan="1" >Accepts an invitation.</td>
|
|
170
|
-
</tr>
|
|
171
|
-
|
|
172
|
-
<tr>
|
|
173
|
-
<td rowspan="1" colSpan="1" >[reject](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Signaling_08.html#a39e685924aaa4d22daa88f2ec96aa827)</td>
|
|
174
|
-
|
|
175
|
-
<td rowspan="1" colSpan="1" >Rejects an invitation.</td>
|
|
176
|
-
</tr>
|
|
177
|
-
|
|
178
|
-
<tr>
|
|
179
|
-
<td rowspan="1" colSpan="1" >[getSignalingInfo](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Signaling_08.html#a0b149836793b8f2d54889b1c3ae40362)</td>
|
|
180
|
-
|
|
181
|
-
<td rowspan="1" colSpan="1" >Gets the signaling information.</td>
|
|
182
|
-
</tr>
|
|
183
|
-
|
|
184
|
-
<tr>
|
|
185
|
-
<td rowspan="1" colSpan="1" >[addInvitedSignaling](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Signaling_08.html#aedfb31fdd3289af36c092b55adeed231)</td>
|
|
186
|
-
|
|
187
|
-
<td rowspan="1" colSpan="1" >Adds invitation signaling (can be used for invitation signaling triggered by offline push messages for group invitations).</td>
|
|
188
|
-
</tr>
|
|
189
|
-
|
|
190
|
-
<tr>
|
|
191
|
-
<td rowspan="1" colSpan="1" >[modifyInvitation](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Signaling_08.html#a1f1d6f5053c07996a611e284ac15cbb5)</td>
|
|
192
|
-
|
|
193
|
-
<td rowspan="1" colSpan="1" >Modifies the invitation signaling.</td>
|
|
194
|
-
</tr>
|
|
195
|
-
</table>
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
## Advanced Message APIs
|
|
199
|
-
|
|
200
|
-
If you need to send/receive rich media messages (such as image, video, and file messages) and use advanced features such as recalling messages, marking messages as read, and querying message history, use the following set of advanced message APIs. Do not use simple message APIs and advanced message APIs at the same time.
|
|
201
|
-
<table>
|
|
202
|
-
<tr>
|
|
203
|
-
<td rowspan="1" colSpan="1" >API</td>
|
|
204
|
-
|
|
205
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
206
|
-
</tr>
|
|
207
|
-
|
|
208
|
-
<tr>
|
|
209
|
-
<td rowspan="1" colSpan="1" >[addAdvancedMsgListener](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#acf794752cc6bfa786aea5cd7fabadfab)</td>
|
|
210
|
-
|
|
211
|
-
<td rowspan="1" colSpan="1" >Sets an event listener for advanced messages. Do not use this API and [addSimpleMsgListener](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a149cdf7924aa13746692d18d605def88) at the same time.</td>
|
|
212
|
-
</tr>
|
|
213
|
-
|
|
214
|
-
<tr>
|
|
215
|
-
<td rowspan="1" colSpan="1" >[removeAdvancedMsgListener](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a28aeebff4a791c9bb8f91a4f61e020e6)</td>
|
|
216
|
-
|
|
217
|
-
<td rowspan="1" colSpan="1" >Removes the listener for advanced messages</td>
|
|
218
|
-
</tr>
|
|
219
|
-
|
|
220
|
-
<tr>
|
|
221
|
-
<td rowspan="1" colSpan="1" >[createTextMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a609f4d4c374d9df3abf9974ff8112fc3)</td>
|
|
222
|
-
|
|
223
|
-
<td rowspan="1" colSpan="1" >Creates a text message</td>
|
|
224
|
-
</tr>
|
|
225
|
-
|
|
226
|
-
<tr>
|
|
227
|
-
<td rowspan="1" colSpan="1" >[createTextAtMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#aaebbd8ed9b9766d01f996ec722744346)</td>
|
|
228
|
-
|
|
229
|
-
<td rowspan="1" colSpan="1" >Creates an @ text message.</td>
|
|
230
|
-
</tr>
|
|
231
|
-
|
|
232
|
-
<tr>
|
|
233
|
-
<td rowspan="1" colSpan="1" >[createCustomMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a7a38c42f63a4e0c9e89f6c56dd0da316)</td>
|
|
234
|
-
|
|
235
|
-
<td rowspan="1" colSpan="1" >Creates a custom message</td>
|
|
236
|
-
</tr>
|
|
237
|
-
|
|
238
|
-
<tr>
|
|
239
|
-
<td rowspan="1" colSpan="1" >[createImageMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a23033a764f0d95ce83c52f3cdeea4137)</td>
|
|
240
|
-
|
|
241
|
-
<td rowspan="1" colSpan="1" >Creates an image message</td>
|
|
242
|
-
</tr>
|
|
243
|
-
|
|
244
|
-
<tr>
|
|
245
|
-
<td rowspan="1" colSpan="1" >[createSoundMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a9073007806fa186b8999ce656555032a)</td>
|
|
246
|
-
|
|
247
|
-
<td rowspan="1" colSpan="1" >Creates a voice message.</td>
|
|
248
|
-
</tr>
|
|
249
|
-
|
|
250
|
-
<tr>
|
|
251
|
-
<td rowspan="1" colSpan="1" >[createVideoMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a233a9ee5ef2ea371206005d109757f18)</td>
|
|
252
|
-
|
|
253
|
-
<td rowspan="1" colSpan="1" >Creates a video message</td>
|
|
254
|
-
</tr>
|
|
255
|
-
|
|
256
|
-
<tr>
|
|
257
|
-
<td rowspan="1" colSpan="1" >[createFileMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a9e487ae9541111038ebed900ab639d4c)</td>
|
|
258
|
-
|
|
259
|
-
<td rowspan="1" colSpan="1" >Creates a file message.</td>
|
|
260
|
-
</tr>
|
|
261
|
-
|
|
262
|
-
<tr>
|
|
263
|
-
<td rowspan="1" colSpan="1" >[createLocationMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a2a997472dd62d794cfd4e3a42cfab930)</td>
|
|
264
|
-
|
|
265
|
-
<td rowspan="1" colSpan="1" >Creates a location message</td>
|
|
266
|
-
</tr>
|
|
267
|
-
|
|
268
|
-
<tr>
|
|
269
|
-
<td rowspan="1" colSpan="1" >[createFaceMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#ab7a593be2cca1c8eddd7e73255f3f34a)</td>
|
|
270
|
-
|
|
271
|
-
<td rowspan="1" colSpan="1" >Creates an emoji message</td>
|
|
272
|
-
</tr>
|
|
273
|
-
|
|
274
|
-
<tr>
|
|
275
|
-
<td rowspan="1" colSpan="1" >[createMergerMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a2943bb31403aeb22f8582cd9966cf13e)</td>
|
|
276
|
-
|
|
277
|
-
<td rowspan="1" colSpan="1" >Creates a combined forward message.</td>
|
|
278
|
-
</tr>
|
|
279
|
-
|
|
280
|
-
<tr>
|
|
281
|
-
<td rowspan="1" colSpan="1" >[createForwardMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a05d088b7d9883e18af41355cdd3f4562)</td>
|
|
282
|
-
|
|
283
|
-
<td rowspan="1" colSpan="1" >Creates a single forward message.</td>
|
|
284
|
-
</tr>
|
|
285
|
-
|
|
286
|
-
<tr>
|
|
287
|
-
<td rowspan="1" colSpan="1" >[createTargetedGroupMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a8bddd2f566a53362b4da5448fdd18fbc)</td>
|
|
288
|
-
|
|
289
|
-
<td rowspan="1" colSpan="1" >Creates a targeted group message.</td>
|
|
290
|
-
</tr>
|
|
291
|
-
|
|
292
|
-
<tr>
|
|
293
|
-
<td rowspan="1" colSpan="1" >[createAtSignedGroupMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#adfb065794694a2061af2642f18c4aeb7)</td>
|
|
294
|
-
|
|
295
|
-
<td rowspan="1" colSpan="1" >Creates a group @ message.</td>
|
|
296
|
-
</tr>
|
|
297
|
-
|
|
298
|
-
<tr>
|
|
299
|
-
<td rowspan="1" colSpan="1" >[sendMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a681947465d6ab718da40f7f983740a21)</td>
|
|
300
|
-
|
|
301
|
-
<td rowspan="1" colSpan="1" >Sends a message. The message object can be created using a `createXXXMessage` API.</td>
|
|
302
|
-
</tr>
|
|
303
|
-
|
|
304
|
-
<tr>
|
|
305
|
-
<td rowspan="1" colSpan="1" >[setC2CReceiveMessageOpt](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#ae628f19d856921d27081c3f40005e9d9)</td>
|
|
306
|
-
|
|
307
|
-
<td rowspan="1" colSpan="1" >Sets the Mute Notifications option for one-to-one messages.</td>
|
|
308
|
-
</tr>
|
|
309
|
-
|
|
310
|
-
<tr>
|
|
311
|
-
<td rowspan="1" colSpan="1" >[getC2CReceiveMessageOpt](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a1c743a6fe1d17a21dc80e584fd1de2d1)</td>
|
|
312
|
-
|
|
313
|
-
<td rowspan="1" colSpan="1" >Gets the Mute Notifications status for one-to-one messages.</td>
|
|
314
|
-
</tr>
|
|
315
|
-
|
|
316
|
-
<tr>
|
|
317
|
-
<td rowspan="1" colSpan="1" >[setGroupReceiveMessageOpt](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a379eeef926e41ec5d48287e7fb55b80a)</td>
|
|
318
|
-
|
|
319
|
-
<td rowspan="1" colSpan="1" >Sets the Mute Notifications option for group messages.</td>
|
|
320
|
-
</tr>
|
|
321
|
-
|
|
322
|
-
<tr>
|
|
323
|
-
<td rowspan="1" colSpan="1" >[getC2CHistoryMessageList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#abca63ad64f69aa4f424cf11849a9b89e)</td>
|
|
324
|
-
|
|
325
|
-
<td rowspan="1" colSpan="1" >Gets the one-to-one chat (C2C) message history</td>
|
|
326
|
-
</tr>
|
|
327
|
-
|
|
328
|
-
<tr>
|
|
329
|
-
<td rowspan="1" colSpan="1" >[getGroupHistoryMessageList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a9e242ba327377fe74b83e8d5572d39a0)</td>
|
|
330
|
-
|
|
331
|
-
<td rowspan="1" colSpan="1" >Gets the group chat message history</td>
|
|
332
|
-
</tr>
|
|
333
|
-
|
|
334
|
-
<tr>
|
|
335
|
-
<td rowspan="1" colSpan="1" >[getHistoryMessageList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a99e8f00ee60df12e346548b743523218)</td>
|
|
336
|
-
|
|
337
|
-
<td rowspan="1" colSpan="1" >Gets the message history.</td>
|
|
338
|
-
</tr>
|
|
339
|
-
|
|
340
|
-
<tr>
|
|
341
|
-
<td rowspan="1" colSpan="1" >[revokeMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a2ef856a792923811e9d16ed7a101336a)</td>
|
|
342
|
-
|
|
343
|
-
<td rowspan="1" colSpan="1" >Recalls a message. The message object can be created using a `createXXXMessage` API.</td>
|
|
344
|
-
</tr>
|
|
345
|
-
|
|
346
|
-
<tr>
|
|
347
|
-
<td rowspan="1" colSpan="1" >[modifyMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a7609c2dd8550e43b23d24069200d37cb)</td>
|
|
348
|
-
|
|
349
|
-
<td rowspan="1" colSpan="1" >Modifies a message.</td>
|
|
350
|
-
</tr>
|
|
351
|
-
|
|
352
|
-
<tr>
|
|
353
|
-
<td rowspan="1" colSpan="1" >[markC2CMessageAsRead](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#acb3a67bd2fa131b50c611a48fa78f34d)</td>
|
|
354
|
-
|
|
355
|
-
<td rowspan="1" colSpan="1" >Marks one-to-one chat (C2C) messages as read</td>
|
|
356
|
-
</tr>
|
|
357
|
-
|
|
358
|
-
<tr>
|
|
359
|
-
<td rowspan="1" colSpan="1" >[markGroupMessageAsRead](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a7fc79e30877b8d77fbdfa24e057376dc)</td>
|
|
360
|
-
|
|
361
|
-
<td rowspan="1" colSpan="1" >Marks group messages as read</td>
|
|
362
|
-
</tr>
|
|
363
|
-
|
|
364
|
-
<tr>
|
|
365
|
-
<td rowspan="1" colSpan="1" >[markAllMessageAsRead](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a53d889a6242b5551aa3655e40967a62f)</td>
|
|
366
|
-
|
|
367
|
-
<td rowspan="1" colSpan="1" >Marks all conversations as read.</td>
|
|
368
|
-
</tr>
|
|
369
|
-
|
|
370
|
-
<tr>
|
|
371
|
-
<td rowspan="1" colSpan="1" >[deleteMessageFromLocalStorage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a2bb42528f4d166ac826914094655841c)</td>
|
|
372
|
-
|
|
373
|
-
<td rowspan="1" colSpan="1" >Deletes a message from the local storage</td>
|
|
374
|
-
</tr>
|
|
375
|
-
|
|
376
|
-
<tr>
|
|
377
|
-
<td rowspan="1" colSpan="1" >[deleteMessages](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a9e394ea720ecdc10d497b63b6f2b22c4)</td>
|
|
378
|
-
|
|
379
|
-
<td rowspan="1" colSpan="1" >Deletes messages from local storage and the cloud.</td>
|
|
380
|
-
</tr>
|
|
381
|
-
|
|
382
|
-
<tr>
|
|
383
|
-
<td rowspan="1" colSpan="1" >[clearC2CHistoryMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a005c7767172d9a3980974b68c780c33b)</td>
|
|
384
|
-
|
|
385
|
-
<td rowspan="1" colSpan="1" >Clears chat history with a user from local storage and the cloud.</td>
|
|
386
|
-
</tr>
|
|
387
|
-
|
|
388
|
-
<tr>
|
|
389
|
-
<td rowspan="1" colSpan="1" >[clearGroupHistoryMessage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a16c01c19a285e2bd11443c868c8256e6)</td>
|
|
390
|
-
|
|
391
|
-
<td rowspan="1" colSpan="1" >Clears chat history of a group from local storage and the cloud.</td>
|
|
392
|
-
</tr>
|
|
393
|
-
|
|
394
|
-
<tr>
|
|
395
|
-
<td rowspan="1" colSpan="1" >[insertGroupMessageToLocalStorage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a9b312b67e4da19978b55a7b915815dfe)</td>
|
|
396
|
-
|
|
397
|
-
<td rowspan="1" colSpan="1" >Inserts a message in a group chat.</td>
|
|
398
|
-
</tr>
|
|
399
|
-
|
|
400
|
-
<tr>
|
|
401
|
-
<td rowspan="1" colSpan="1" >[insertC2CMessageToLocalStorage](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#acc1dccd310d1965248cff0d4fd5ca45f)</td>
|
|
402
|
-
|
|
403
|
-
<td rowspan="1" colSpan="1" >Inserts a message in a one-to-one chat.</td>
|
|
404
|
-
</tr>
|
|
405
|
-
|
|
406
|
-
<tr>
|
|
407
|
-
<td rowspan="1" colSpan="1" >[findMessages](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a4a0c47d706d8784656225c1e9065f6f1)</td>
|
|
408
|
-
|
|
409
|
-
<td rowspan="1" colSpan="1" >Finds local messages by `msgID`.</td>
|
|
410
|
-
</tr>
|
|
411
|
-
|
|
412
|
-
<tr>
|
|
413
|
-
<td rowspan="1" colSpan="1" >[searchLocalMessages](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a10878d0bd326b07ec6a605c5695c7de1)</td>
|
|
414
|
-
|
|
415
|
-
<td rowspan="1" colSpan="1" >Search for local messages.</td>
|
|
416
|
-
</tr>
|
|
417
|
-
|
|
418
|
-
<tr>
|
|
419
|
-
<td rowspan="1" colSpan="1" >[searchCloudMessages](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#ab672a5d549893b7e22c555593be40322)</td>
|
|
420
|
-
|
|
421
|
-
<td rowspan="1" colSpan="1" >Search for cloud messages.</td>
|
|
422
|
-
</tr>
|
|
423
|
-
|
|
424
|
-
<tr>
|
|
425
|
-
<td rowspan="1" colSpan="1" >[sendMessageReadReceipts](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a375af7e0f3e0f0b3135ccd517de9fdd8)</td>
|
|
426
|
-
|
|
427
|
-
<td rowspan="1" colSpan="1" >Sends message read receipts.</td>
|
|
428
|
-
</tr>
|
|
429
|
-
|
|
430
|
-
<tr>
|
|
431
|
-
<td rowspan="1" colSpan="1" >[getMessageReadReceipts](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a69192bc43e551f34f5d483dae5e70410)</td>
|
|
432
|
-
|
|
433
|
-
<td rowspan="1" colSpan="1" >Gets message read receipts.</td>
|
|
434
|
-
</tr>
|
|
435
|
-
|
|
436
|
-
<tr>
|
|
437
|
-
<td rowspan="1" colSpan="1" >[getGroupMessageReadMemberList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#aa345a87cfa4da2983f878bb5385d0b82)</td>
|
|
438
|
-
|
|
439
|
-
<td rowspan="1" colSpan="1" >Gets the list of group members who have read group messages.</td>
|
|
440
|
-
</tr>
|
|
441
|
-
|
|
442
|
-
<tr>
|
|
443
|
-
<td rowspan="1" colSpan="1" >[setMessageExtensions](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a2e8b8f7ef94d02823cfab0cf5b1e1fea)</td>
|
|
444
|
-
|
|
445
|
-
<td rowspan="1" colSpan="1" >Sets message extensions.</td>
|
|
446
|
-
</tr>
|
|
447
|
-
|
|
448
|
-
<tr>
|
|
449
|
-
<td rowspan="1" colSpan="1" >[getMessageExtensions](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a3ae68d2d8aeff6abd21981914836dc1a)</td>
|
|
450
|
-
|
|
451
|
-
<td rowspan="1" colSpan="1" >Gets message extensions.</td>
|
|
452
|
-
</tr>
|
|
453
|
-
|
|
454
|
-
<tr>
|
|
455
|
-
<td rowspan="1" colSpan="1" >[deleteMessageExtensions](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#af3fad5575625e7597a482375d7a65fa6)</td>
|
|
456
|
-
|
|
457
|
-
<td rowspan="1" colSpan="1" >Deletes message extensions.</td>
|
|
458
|
-
</tr>
|
|
459
|
-
|
|
460
|
-
<tr>
|
|
461
|
-
<td rowspan="1" colSpan="1" >[addMessageReaction](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a425d818c392bef6c6daeddef8c9c0cc1)</td>
|
|
462
|
-
|
|
463
|
-
<td rowspan="1" colSpan="1" >Adds message reaction.</td>
|
|
464
|
-
</tr>
|
|
465
|
-
|
|
466
|
-
<tr>
|
|
467
|
-
<td rowspan="1" colSpan="1" >[removeMessageReaction](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#a88d3bf59edf75dd06ef9067b08b7db00)</td>
|
|
468
|
-
|
|
469
|
-
<td rowspan="1" colSpan="1" >Removes message reaction.</td>
|
|
470
|
-
</tr>
|
|
471
|
-
|
|
472
|
-
<tr>
|
|
473
|
-
<td rowspan="1" colSpan="1" >[getMessageReactions](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#ab3d6d68379e25750ba1b0154d956e62c)</td>
|
|
474
|
-
|
|
475
|
-
<td rowspan="1" colSpan="1" >Gets message reactions.</td>
|
|
476
|
-
</tr>
|
|
477
|
-
|
|
478
|
-
<tr>
|
|
479
|
-
<td rowspan="1" colSpan="1" >[getAllUserListOfMessageReaction](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#af26823c8deb12d0b0c5dc885431da182)</td>
|
|
480
|
-
|
|
481
|
-
<td rowspan="1" colSpan="1" >Gets all user list of message reaction.</td>
|
|
482
|
-
</tr>
|
|
483
|
-
|
|
484
|
-
<tr>
|
|
485
|
-
<td rowspan="1" colSpan="1" >[translateText](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Message_08.html#aee0c1e26b0401576ee82967698da35f6)</td>
|
|
486
|
-
|
|
487
|
-
<td rowspan="1" colSpan="1" >Translates a text message.</td>
|
|
488
|
-
</tr>
|
|
489
|
-
|
|
490
|
-
<tr>
|
|
491
|
-
<td rowspan="1" colSpan="1" >[pinGroupMessage](https://im.sdk.qcloud.com/doc/en/classcom_1_1tencent_1_1imsdk_1_1v2_1_1V2TIMMessageManager.html#aa345a7876bf0df29491429329a10f469)</td>
|
|
492
|
-
|
|
493
|
-
<td rowspan="1" colSpan="1" >Sets group message pinning.</td>
|
|
494
|
-
</tr>
|
|
495
|
-
|
|
496
|
-
<tr>
|
|
497
|
-
<td rowspan="1" colSpan="1" >[getPinnedGroupMessageList](https://im.sdk.qcloud.com/doc/en/classcom_1_1tencent_1_1imsdk_1_1v2_1_1V2TIMMessageManager.html#a35c28770388fa0b1c51946b314287786)</td>
|
|
498
|
-
|
|
499
|
-
<td rowspan="1" colSpan="1" >Gets pinned group message list.</td>
|
|
500
|
-
</tr>
|
|
501
|
-
</table>
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
## Group APIs
|
|
505
|
-
|
|
506
|
-
Tencent Cloud Chat SDK supports five preset group types, each of which pertains to different scenarios.
|
|
507
|
-
- Work group (Work): users can join the group only after being invited by group members. This group type is the same as private group (Private) in earlier versions.
|
|
508
|
-
|
|
509
|
-
- Public group (Public): Users can join a public group through requests, which need to be approved by the group owner or group admin.
|
|
510
|
-
|
|
511
|
-
- Meeting group (Meeting): used together with [TRTC](https://trtc.io/document) to enable scenarios such as video conferencing and online education. Users can join and leave the group freely and view the message history before they join. Same as chat room (ChatRoom) in earlier versions.
|
|
512
|
-
|
|
513
|
-
- Community: A user can join and leave a community freely. It is suitable for chat scenarios with a super large number of community members, such as knowledge sharing and game discussion. This feature is supported by a client with the SDK enhanced edition v5.8.1668 or later and the web SDK v2.17.0 or later. To use it, you need to purchase the [Pro edition 、Pro Plus edition、Enterprise edition](https://trtc.io/buy/chat), and then enable it in [Console](https://console.trtc.io/), path: Applications > Your App > Chat > Configuration > Group Configuration > Community.
|
|
514
|
-
|
|
515
|
-
- Audio-video group (AVChatRoom): An audio-video group allows users to join and leave freely and is suitable for scenarios such as live streaming and chat rooms with on-screen comments. There is no limit on the number of group members.
|
|
516
|
-
|
|
517
|
-
<table>
|
|
518
|
-
<tr>
|
|
519
|
-
<td rowspan="1" colSpan="1" >API</td>
|
|
520
|
-
|
|
521
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
522
|
-
</tr>
|
|
523
|
-
|
|
524
|
-
<tr>
|
|
525
|
-
<td rowspan="1" colSpan="1" >[setGroupListener](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a74de68e55d787fd1d4ec83b99cd1fcab)</td>
|
|
526
|
-
|
|
527
|
-
<td rowspan="1" colSpan="1" >Sets an event listener for groups. (This API is to be disused. Please use the `addGroupListener` and `removeGroupListener` APIs.)</td>
|
|
528
|
-
</tr>
|
|
529
|
-
|
|
530
|
-
<tr>
|
|
531
|
-
<td rowspan="1" colSpan="1" >[addGroupListener](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#af583b113cdec570b08ae80d682fba52c)</td>
|
|
532
|
-
|
|
533
|
-
<td rowspan="1" colSpan="1" >Adds an event listener for groups.</td>
|
|
534
|
-
</tr>
|
|
535
|
-
|
|
536
|
-
<tr>
|
|
537
|
-
<td rowspan="1" colSpan="1" >[removeGroupListener](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a2b2093489bf869f70c03be39f4ed08a1)</td>
|
|
538
|
-
|
|
539
|
-
<td rowspan="1" colSpan="1" >Removes an event listener for groups.</td>
|
|
540
|
-
</tr>
|
|
541
|
-
|
|
542
|
-
<tr>
|
|
543
|
-
<td rowspan="1" colSpan="1" >[createGroup](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a3bbcf819c1ec70e520b7f9a42cfbb989)</td>
|
|
544
|
-
|
|
545
|
-
<td rowspan="1" colSpan="1" >(Simple API) Creates a group.</td>
|
|
546
|
-
</tr>
|
|
547
|
-
|
|
548
|
-
<tr>
|
|
549
|
-
<td rowspan="1" colSpan="1" >[createGroup](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a59824434b6096180b94d8152183dcd2c)</td>
|
|
550
|
-
|
|
551
|
-
<td rowspan="1" colSpan="1" >(Advanced API) Creates a group. The group information and the initial group members can be set during group creation.</td>
|
|
552
|
-
</tr>
|
|
553
|
-
|
|
554
|
-
<tr>
|
|
555
|
-
<td rowspan="1" colSpan="1" >[joinGroup](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a4762156b7a98489eb4715de53028e12a)</td>
|
|
556
|
-
|
|
557
|
-
<td rowspan="1" colSpan="1" >Joins a group</td>
|
|
558
|
-
</tr>
|
|
559
|
-
|
|
560
|
-
<tr>
|
|
561
|
-
<td rowspan="1" colSpan="1" >[quitGroup](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#ac2a43b3ada447131df0c5f19e8079be5)</td>
|
|
562
|
-
|
|
563
|
-
<td rowspan="1" colSpan="1" >Leaves a group.</td>
|
|
564
|
-
</tr>
|
|
565
|
-
|
|
566
|
-
<tr>
|
|
567
|
-
<td rowspan="1" colSpan="1" >[dismissGroup](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a5bd55cb04867985253949d8cc78f860e)</td>
|
|
568
|
-
|
|
569
|
-
<td rowspan="1" colSpan="1" >Disbands a group. Only the group owner and group admin can disband a group.</td>
|
|
570
|
-
</tr>
|
|
571
|
-
|
|
572
|
-
<tr>
|
|
573
|
-
<td rowspan="1" colSpan="1" >[getJoinedGroupList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a4599e99791c150cc9f3e2492e8b4ce04)</td>
|
|
574
|
-
|
|
575
|
-
<td rowspan="1" colSpan="1" >Gets the list of groups the current user has joined, excluding audio-video groups.</td>
|
|
576
|
-
</tr>
|
|
577
|
-
|
|
578
|
-
<tr>
|
|
579
|
-
<td rowspan="1" colSpan="1" >[getGroupsInfo](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a9bca7e5318cfed44335566a783a6b568)</td>
|
|
580
|
-
|
|
581
|
-
<td rowspan="1" colSpan="1" >Pulls the profiles of groups</td>
|
|
582
|
-
</tr>
|
|
583
|
-
|
|
584
|
-
<tr>
|
|
585
|
-
<td rowspan="1" colSpan="1" >[searchGroups](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#ac9a960921e512621340159d82a4b5259)</td>
|
|
586
|
-
|
|
587
|
-
<td rowspan="1" colSpan="1" >Search for local group profiles</td>
|
|
588
|
-
</tr>
|
|
589
|
-
|
|
590
|
-
<tr>
|
|
591
|
-
<td rowspan="1" colSpan="1" >[searchCloudGroups](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a8c3f83c844be3c8bb13fe9cec6fd658a)</td>
|
|
592
|
-
|
|
593
|
-
<td rowspan="1" colSpan="1" >Search for cloud group profiles</td>
|
|
594
|
-
</tr>
|
|
595
|
-
|
|
596
|
-
<tr>
|
|
597
|
-
<td rowspan="1" colSpan="1" >[setGroupInfo](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#aa9519a479493e56d7920e40aba796144)</td>
|
|
598
|
-
|
|
599
|
-
<td rowspan="1" colSpan="1" >Modifies the profile of a group</td>
|
|
600
|
-
</tr>
|
|
601
|
-
|
|
602
|
-
<tr>
|
|
603
|
-
<td rowspan="1" colSpan="1" >[initGroupAttributes](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a1b3a56dfc345f1ef2a575cb36156e745)</td>
|
|
604
|
-
|
|
605
|
-
<td rowspan="1" colSpan="1" >Initializes group attributes.</td>
|
|
606
|
-
</tr>
|
|
607
|
-
|
|
608
|
-
<tr>
|
|
609
|
-
<td rowspan="1" colSpan="1" >[setGroupAttributes](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a134342ddb51d1ee83f3981ed91d26885)</td>
|
|
610
|
-
|
|
611
|
-
<td rowspan="1" colSpan="1" >Sets group attributes.</td>
|
|
612
|
-
</tr>
|
|
613
|
-
|
|
614
|
-
<tr>
|
|
615
|
-
<td rowspan="1" colSpan="1" >[deleteGroupAttributes](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#aa504ffca9492580ca27a45f78a87e2cb)</td>
|
|
616
|
-
|
|
617
|
-
<td rowspan="1" colSpan="1" >Deletes group attributes.</td>
|
|
618
|
-
</tr>
|
|
619
|
-
|
|
620
|
-
<tr>
|
|
621
|
-
<td rowspan="1" colSpan="1" >[getGroupAttributes](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#ac8a74db230669d1b49da47bb0895cbf9)</td>
|
|
622
|
-
|
|
623
|
-
<td rowspan="1" colSpan="1" >Gets group attributes.</td>
|
|
624
|
-
</tr>
|
|
625
|
-
|
|
626
|
-
<tr>
|
|
627
|
-
<td rowspan="1" colSpan="1" >[getGroupOnlineMemberCount](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#ada2eadb44f6865e9848df94fb5bae4ae)</td>
|
|
628
|
-
|
|
629
|
-
<td rowspan="1" colSpan="1" >Gets the number of online group members.</td>
|
|
630
|
-
</tr>
|
|
631
|
-
|
|
632
|
-
<tr>
|
|
633
|
-
<td rowspan="1" colSpan="1" >[getGroupMemberList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a98681b9036e73acbe8f84737b5291326)</td>
|
|
634
|
-
|
|
635
|
-
<td rowspan="1" colSpan="1" >Gets the group member list</td>
|
|
636
|
-
</tr>
|
|
637
|
-
|
|
638
|
-
<tr>
|
|
639
|
-
<td rowspan="1" colSpan="1" >[getGroupMembersInfo](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a1ab284b80811bcc697d689d7b97edf04)</td>
|
|
640
|
-
|
|
641
|
-
<td rowspan="1" colSpan="1" >Gets the profiles of specified group members</td>
|
|
642
|
-
</tr>
|
|
643
|
-
|
|
644
|
-
<tr>
|
|
645
|
-
<td rowspan="1" colSpan="1" >[searchGroupMembers](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a35ceb734976c833047cceb8b31055b18)</td>
|
|
646
|
-
|
|
647
|
-
<td rowspan="1" colSpan="1" >Search for local group members</td>
|
|
648
|
-
</tr>
|
|
649
|
-
|
|
650
|
-
<tr>
|
|
651
|
-
<td rowspan="1" colSpan="1" >[searchCloudGroupMembers](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#ae2f92bf458c5b6ef0149d66de7a01896)</td>
|
|
652
|
-
|
|
653
|
-
<td rowspan="1" colSpan="1" >Search for cloud group members</td>
|
|
654
|
-
</tr>
|
|
655
|
-
|
|
656
|
-
<tr>
|
|
657
|
-
<td rowspan="1" colSpan="1" >[setGroupMemberInfo](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a40b97ee4b138f93e1b2073d1bdff3756)</td>
|
|
658
|
-
|
|
659
|
-
<td rowspan="1" colSpan="1" >Modifies the profile of a specified group member</td>
|
|
660
|
-
</tr>
|
|
661
|
-
|
|
662
|
-
<tr>
|
|
663
|
-
<td rowspan="1" colSpan="1" >[muteGroupMember](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#aa8a0206f75d75400b517f7e0d80fe9ee)</td>
|
|
664
|
-
|
|
665
|
-
<td rowspan="1" colSpan="1" >Mutes a group member.</td>
|
|
666
|
-
</tr>
|
|
667
|
-
|
|
668
|
-
<tr>
|
|
669
|
-
<td rowspan="1" colSpan="1" >[inviteUserToGroup](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a942d75fdea66e22cdbd8c131cf18e1ea)</td>
|
|
670
|
-
|
|
671
|
-
<td rowspan="1" colSpan="1" >Invites users to a group</td>
|
|
672
|
-
</tr>
|
|
673
|
-
|
|
674
|
-
<tr>
|
|
675
|
-
<td rowspan="1" colSpan="1" >[kickGroupMember](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a0581f28fddf2ade890aa62e4318d7a97)</td>
|
|
676
|
-
|
|
677
|
-
<td rowspan="1" colSpan="1" >Removes a member from a group.</td>
|
|
678
|
-
</tr>
|
|
679
|
-
|
|
680
|
-
<tr>
|
|
681
|
-
<td rowspan="1" colSpan="1" >[setGroupMemberRole](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a0f1c341a3dc53d6a6557a438b0c64b65)</td>
|
|
682
|
-
|
|
683
|
-
<td rowspan="1" colSpan="1" >Sets a role for a group member.</td>
|
|
684
|
-
</tr>
|
|
685
|
-
|
|
686
|
-
<tr>
|
|
687
|
-
<td rowspan="1" colSpan="1" >[markGroupMemberList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a21238536e7cb2c3fd086797e7dc1b970)</td>
|
|
688
|
-
|
|
689
|
-
<td rowspan="1" colSpan="1" >Marks group members.</td>
|
|
690
|
-
</tr>
|
|
691
|
-
|
|
692
|
-
<tr>
|
|
693
|
-
<td rowspan="1" colSpan="1" >[transferGroupOwner](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a58a2ffae60505a43984fe21bf0bc1101)</td>
|
|
694
|
-
|
|
695
|
-
<td rowspan="1" colSpan="1" >Transfers the ownership of a group</td>
|
|
696
|
-
</tr>
|
|
697
|
-
|
|
698
|
-
<tr>
|
|
699
|
-
<td rowspan="1" colSpan="1" >[getGroupApplicationList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a29c36ad685159850a30d61a6b9c637e8)</td>
|
|
700
|
-
|
|
701
|
-
<td rowspan="1" colSpan="1" >Gets the list of applications to join a group</td>
|
|
702
|
-
</tr>
|
|
703
|
-
|
|
704
|
-
<tr>
|
|
705
|
-
<td rowspan="1" colSpan="1" >[acceptGroupApplication](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a51bb9b4f965cb3d01546fef348ac75e4)</td>
|
|
706
|
-
|
|
707
|
-
<td rowspan="1" colSpan="1" >Accepts an application to join a group</td>
|
|
708
|
-
</tr>
|
|
709
|
-
|
|
710
|
-
<tr>
|
|
711
|
-
<td rowspan="1" colSpan="1" >[refuseGroupApplication](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a46aa78c54986b2c0b7cc0012a3dc94ef)</td>
|
|
712
|
-
|
|
713
|
-
<td rowspan="1" colSpan="1" >Rejects a request to join a group.</td>
|
|
714
|
-
</tr>
|
|
715
|
-
|
|
716
|
-
<tr>
|
|
717
|
-
<td rowspan="1" colSpan="1" >[setGroupApplicationRead](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#ade11e93b96206ef851641c42788132d1)</td>
|
|
718
|
-
|
|
719
|
-
<td rowspan="1" colSpan="1" >Marks the application list as read</td>
|
|
720
|
-
</tr>
|
|
721
|
-
|
|
722
|
-
<tr>
|
|
723
|
-
<td rowspan="1" colSpan="1" >[getJoinedCommunityList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a17350dec83b7cd32d308a1f2b2827fdd)</td>
|
|
724
|
-
|
|
725
|
-
<td rowspan="1" colSpan="1" >Gets the list of community groups the current user has joined.</td>
|
|
726
|
-
</tr>
|
|
727
|
-
|
|
728
|
-
<tr>
|
|
729
|
-
<td rowspan="1" colSpan="1" >[createTopicInCommunity](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a8cc04d04254867787060cf1cae0fc5b8)</td>
|
|
730
|
-
|
|
731
|
-
<td rowspan="1" colSpan="1" >Creates a topic.</td>
|
|
732
|
-
</tr>
|
|
733
|
-
|
|
734
|
-
<tr>
|
|
735
|
-
<td rowspan="1" colSpan="1" >[deleteTopicFromCommunity](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a31b726136637a58b5bb246eaac41187c)</td>
|
|
736
|
-
|
|
737
|
-
<td rowspan="1" colSpan="1" >Deletes a topic.</td>
|
|
738
|
-
</tr>
|
|
739
|
-
|
|
740
|
-
<tr>
|
|
741
|
-
<td rowspan="1" colSpan="1" >[setTopicInfo](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#a237e2fa6e16e55143c516c5428a23936)</td>
|
|
742
|
-
|
|
743
|
-
<td rowspan="1" colSpan="1" >Modifies topic information.</td>
|
|
744
|
-
</tr>
|
|
745
|
-
|
|
746
|
-
<tr>
|
|
747
|
-
<td rowspan="1" colSpan="1" >[getTopicInfoList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Group_08.html#af93ad10e0e2b21d6ae3c8ec45021b159)</td>
|
|
748
|
-
|
|
749
|
-
<td rowspan="1" colSpan="1" >Gets the message list.</td>
|
|
750
|
-
</tr>
|
|
751
|
-
</table>
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
## Conversation List APIs
|
|
755
|
-
|
|
756
|
-
The conversation list is the list a user sees on the first screen after login. It includes elements such as conversation node, conversation name, group name, last message, and unread count.
|
|
757
|
-
<table>
|
|
758
|
-
<tr>
|
|
759
|
-
<td rowspan="1" colSpan="1" >API</td>
|
|
760
|
-
|
|
761
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
762
|
-
</tr>
|
|
763
|
-
|
|
764
|
-
<tr>
|
|
765
|
-
<td rowspan="1" colSpan="1" >[setConversationListener](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#a95bac7330779a8a970fc7689e436257f)</td>
|
|
766
|
-
|
|
767
|
-
<td rowspan="1" colSpan="1" >Sets a conversation listener. (This API is to be disused. Please use the `addConversationListener` and `removeConversationListener` APIs.)</td>
|
|
768
|
-
</tr>
|
|
769
|
-
|
|
770
|
-
<tr>
|
|
771
|
-
<td rowspan="1" colSpan="1" >[addConversationListener](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#a39b4f352f1740171fb56143149201cd9)</td>
|
|
772
|
-
|
|
773
|
-
<td rowspan="1" colSpan="1" >Adds a conversation listener.</td>
|
|
774
|
-
</tr>
|
|
775
|
-
|
|
776
|
-
<tr>
|
|
777
|
-
<td rowspan="1" colSpan="1" >[removeConversationListener](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#ab9e1627559fb4259228b4e547b192c83)</td>
|
|
778
|
-
|
|
779
|
-
<td rowspan="1" colSpan="1" >Removes a conversation listener.</td>
|
|
780
|
-
</tr>
|
|
781
|
-
|
|
782
|
-
<tr>
|
|
783
|
-
<td rowspan="1" colSpan="1" >[getConversationList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#ab1f5e86e270b122cb725266d234d9dd5)</td>
|
|
784
|
-
|
|
785
|
-
<td rowspan="1" colSpan="1" >Gets the conversation list</td>
|
|
786
|
-
</tr>
|
|
787
|
-
|
|
788
|
-
<tr>
|
|
789
|
-
<td rowspan="1" colSpan="1" >[getConversation](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#ad4b7b80fbe0cff25027371b416ede9f9)</td>
|
|
790
|
-
|
|
791
|
-
<td rowspan="1" colSpan="1" >Gets a specified conversation.</td>
|
|
792
|
-
</tr>
|
|
793
|
-
|
|
794
|
-
<tr>
|
|
795
|
-
<td rowspan="1" colSpan="1" >[getConversationList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#af94d9d44e90da448a395e6d92b4e512e)</td>
|
|
796
|
-
|
|
797
|
-
<td rowspan="1" colSpan="1" >Gets multiple conversations.</td>
|
|
798
|
-
</tr>
|
|
799
|
-
|
|
800
|
-
<tr>
|
|
801
|
-
<td rowspan="1" colSpan="1" >[ getConversationListByFilter](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#ac1b77eedff7f2f8742a873cf766daec9)</td>
|
|
802
|
-
|
|
803
|
-
<td rowspan="1" colSpan="1" >Gets the advanced conversation API to specify the conversation type, mark type, and group name.</td>
|
|
804
|
-
</tr>
|
|
805
|
-
|
|
806
|
-
<tr>
|
|
807
|
-
<td rowspan="1" colSpan="1" >[deleteConversation](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#a142f5289632f29a603937f1d770748c6)</td>
|
|
808
|
-
|
|
809
|
-
<td rowspan="1" colSpan="1" >Deletes a conversation</td>
|
|
810
|
-
</tr>
|
|
811
|
-
|
|
812
|
-
<tr>
|
|
813
|
-
<td rowspan="1" colSpan="1" >[setConversationDraft](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#a462cd163c03cdce230ed3647b414382b)</td>
|
|
814
|
-
|
|
815
|
-
<td rowspan="1" colSpan="1" >Sets a draft for a conversation</td>
|
|
816
|
-
</tr>
|
|
817
|
-
|
|
818
|
-
<tr>
|
|
819
|
-
<td rowspan="1" colSpan="1" >[setConversationCustomData](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#af82623b98c07f36767a47c59f5a23927)</td>
|
|
820
|
-
|
|
821
|
-
<td rowspan="1" colSpan="1" >Sets custom conversation data.</td>
|
|
822
|
-
</tr>
|
|
823
|
-
|
|
824
|
-
<tr>
|
|
825
|
-
<td rowspan="1" colSpan="1" >[pinConversation](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#a06cefb398f5a327dff4cefe6fb18c5b8)</td>
|
|
826
|
-
|
|
827
|
-
<td rowspan="1" colSpan="1" >Pins a conversation to the top.</td>
|
|
828
|
-
</tr>
|
|
829
|
-
|
|
830
|
-
<tr>
|
|
831
|
-
<td rowspan="1" colSpan="1" >[markConversation](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#a77c02a146f774979e1e04d7334cd2d06)</td>
|
|
832
|
-
|
|
833
|
-
<td rowspan="1" colSpan="1" >Marks a conversation.</td>
|
|
834
|
-
</tr>
|
|
835
|
-
|
|
836
|
-
<tr>
|
|
837
|
-
<td rowspan="1" colSpan="1" >[getTotalUnreadMessageCount](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#abe76208f616713a09df582a6c1665d38)</td>
|
|
838
|
-
|
|
839
|
-
<td rowspan="1" colSpan="1" >Gets the total unread message count.</td>
|
|
840
|
-
</tr>
|
|
841
|
-
|
|
842
|
-
<tr>
|
|
843
|
-
<td rowspan="1" colSpan="1" >[ createConversationGroup](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#a2f5f4587c881aa26fbdce3b4d469aa0a)</td>
|
|
844
|
-
|
|
845
|
-
<td rowspan="1" colSpan="1" >Creates a conversation group.</td>
|
|
846
|
-
</tr>
|
|
847
|
-
|
|
848
|
-
<tr>
|
|
849
|
-
<td rowspan="1" colSpan="1" >[ getConversationGroupList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#a037b0973be9feef207a64f2e043792ab)</td>
|
|
850
|
-
|
|
851
|
-
<td rowspan="1" colSpan="1" >Gets the list of conversation groups.</td>
|
|
852
|
-
</tr>
|
|
853
|
-
|
|
854
|
-
<tr>
|
|
855
|
-
<td rowspan="1" colSpan="1" >[ deleteConversationGroup](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#aa7b91ded9e451335bc931525839ce736)</td>
|
|
856
|
-
|
|
857
|
-
<td rowspan="1" colSpan="1" >Deletes a conversation group.</td>
|
|
858
|
-
</tr>
|
|
859
|
-
|
|
860
|
-
<tr>
|
|
861
|
-
<td rowspan="1" colSpan="1" >[ renameConversationGroup](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#a1a9492196c94450b2992079cffab96a6)</td>
|
|
862
|
-
|
|
863
|
-
<td rowspan="1" colSpan="1" >Renames a conversation group.</td>
|
|
864
|
-
</tr>
|
|
865
|
-
|
|
866
|
-
<tr>
|
|
867
|
-
<td rowspan="1" colSpan="1" >[ addConversationsToGroup](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#a37c78d27216882504d2710a066478db5)</td>
|
|
868
|
-
|
|
869
|
-
<td rowspan="1" colSpan="1" >Adds a conversation to a conversation group.</td>
|
|
870
|
-
</tr>
|
|
871
|
-
|
|
872
|
-
<tr>
|
|
873
|
-
<td rowspan="1" colSpan="1" >[ deleteConversationsFromGroup](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Conversation_08.html#a16ee46fa4b7278a0386be9ff633fa552)</td>
|
|
874
|
-
|
|
875
|
-
<td rowspan="1" colSpan="1" >Deletes a conversation from a conversation group.</td>
|
|
876
|
-
</tr>
|
|
877
|
-
</table>
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
## User Profile APIs
|
|
881
|
-
|
|
882
|
-
You can use the following APIs to query user profiles, modify your profile, and block messages from a specified user (that is, adding a specified user to the blocklist).
|
|
883
|
-
<table>
|
|
884
|
-
<tr>
|
|
885
|
-
<td rowspan="1" colSpan="1" >API</td>
|
|
886
|
-
|
|
887
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
888
|
-
</tr>
|
|
889
|
-
|
|
890
|
-
<tr>
|
|
891
|
-
<td rowspan="1" colSpan="1" >[getUsersInfo](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#ac638c1dd6ec1e5204637e4b87129cd38)</td>
|
|
892
|
-
|
|
893
|
-
<td rowspan="1" colSpan="1" >Gets users’ profiles</td>
|
|
894
|
-
</tr>
|
|
895
|
-
|
|
896
|
-
<tr>
|
|
897
|
-
<td rowspan="1" colSpan="1" >[setSelfInfo](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a328a0d2d07e8d34e12effb73937c3437)</td>
|
|
898
|
-
|
|
899
|
-
<td rowspan="1" colSpan="1" >Modifies one’s own user profile</td>
|
|
900
|
-
</tr>
|
|
901
|
-
|
|
902
|
-
<tr>
|
|
903
|
-
<td rowspan="1" colSpan="1" >[getUserStatus](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#abe44a4c51c686248d483674d77d71053)</td>
|
|
904
|
-
|
|
905
|
-
<td rowspan="1" colSpan="1" >Queries a user's status.</td>
|
|
906
|
-
</tr>
|
|
907
|
-
|
|
908
|
-
<tr>
|
|
909
|
-
<td rowspan="1" colSpan="1" >[setSelfStatus](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a7d771431a61635888bdc4def438c4328)</td>
|
|
910
|
-
|
|
911
|
-
<td rowspan="1" colSpan="1" >Sets one's own status.</td>
|
|
912
|
-
</tr>
|
|
913
|
-
|
|
914
|
-
<tr>
|
|
915
|
-
<td rowspan="1" colSpan="1" >[subscribeUserStatus](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a20e6cbe409549e0d2ff62be76914e0b3)</td>
|
|
916
|
-
|
|
917
|
-
<td rowspan="1" colSpan="1" >Subscribes to a user's status.</td>
|
|
918
|
-
</tr>
|
|
919
|
-
|
|
920
|
-
<tr>
|
|
921
|
-
<td rowspan="1" colSpan="1" >[unsubscribeUserStatus](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a3780734bb50398ebe65155c3223542f0)</td>
|
|
922
|
-
|
|
923
|
-
<td rowspan="1" colSpan="1" >Unsubscribes from a user's status.</td>
|
|
924
|
-
</tr>
|
|
925
|
-
|
|
926
|
-
<tr>
|
|
927
|
-
<td rowspan="1" colSpan="1" >[searchUsers](https://im.sdk.qcloud.com/doc/en/interfaceV2TIMManager.html#a978df4d80011f4da38dc80f8ab217f48)</td>
|
|
928
|
-
|
|
929
|
-
<td rowspan="1" colSpan="1" >Search cloud users</td>
|
|
930
|
-
</tr>
|
|
931
|
-
|
|
932
|
-
<tr>
|
|
933
|
-
<td rowspan="1" colSpan="1" >[addToBlackList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#a67d998da5085b5004bb6aa8d4322022c)</td>
|
|
934
|
-
|
|
935
|
-
<td rowspan="1" colSpan="1" >Blocks messages from a specified user, which means adding the user to the blocklist.</td>
|
|
936
|
-
</tr>
|
|
937
|
-
|
|
938
|
-
<tr>
|
|
939
|
-
<td rowspan="1" colSpan="1" >[deleteFromBlackList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#aa7e69a67185eaca658ba429cf6309a5f)</td>
|
|
940
|
-
|
|
941
|
-
<td rowspan="1" colSpan="1" >Unblocks messages from a specified user, which means removing the user from the blocklist.</td>
|
|
942
|
-
</tr>
|
|
943
|
-
|
|
944
|
-
<tr>
|
|
945
|
-
<td rowspan="1" colSpan="1" >[getBlackList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#a0d854d64c8ae936014a8424d55508fa3)</td>
|
|
946
|
-
|
|
947
|
-
<td rowspan="1" colSpan="1" >Gets the blocklist</td>
|
|
948
|
-
</tr>
|
|
949
|
-
</table>
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
## Offline Push APIs
|
|
953
|
-
|
|
954
|
-
Use the offline push service if you want your app to receive Chat service messages in real time when it is in the background.
|
|
955
|
-
<table>
|
|
956
|
-
<tr>
|
|
957
|
-
<td rowspan="1" colSpan="1" >API</td>
|
|
958
|
-
|
|
959
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
960
|
-
</tr>
|
|
961
|
-
|
|
962
|
-
<tr>
|
|
963
|
-
<td rowspan="1" colSpan="1" >[setAPNSListener](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07APNS_08.html#a62e1694cf9e1d65b76f90064cbcbb683)</td>
|
|
964
|
-
|
|
965
|
-
<td rowspan="1" colSpan="1" >Sets an APNs listener.</td>
|
|
966
|
-
</tr>
|
|
967
|
-
|
|
968
|
-
<tr>
|
|
969
|
-
<td rowspan="1" colSpan="1" >[setAPNS](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07APNS_08.html#a73bf19c0c019e5e27ec441bc753daa9e)</td>
|
|
970
|
-
|
|
971
|
-
<td rowspan="1" colSpan="1" >Configures APNs Push info.</td>
|
|
972
|
-
</tr>
|
|
973
|
-
|
|
974
|
-
<tr>
|
|
975
|
-
<td rowspan="1" colSpan="1" >[setVOIP](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07VOIP_08.html#a0bd652eed597771ca1381d0d6ea67704)</td>
|
|
976
|
-
|
|
977
|
-
<td rowspan="1" colSpan="1" >Configures VoIP Push info.</td>
|
|
978
|
-
</tr>
|
|
979
|
-
</table>
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
## Friend Management APIs
|
|
983
|
-
|
|
984
|
-
Tencent Cloud Chat SDK does not check friend relationships by default when sending and receiving messages. To achieve the interactive experience of "add friends first, then send messages", you can log in to the [Console](https://console.trtc.io/) to modify Relationship Check. When enabled, users can only send messages to their friends. When a user sends a message to a non-friend, SDK will report a 20009 error code. The configuration path is: Applications > Your App > Chat > Configuration > Login and Message > Relationship Check.
|
|
985
|
-
|
|
986
|
-
Use the following API to add or delete friends and manage friend lists.
|
|
987
|
-
<table>
|
|
988
|
-
<tr>
|
|
989
|
-
<td rowspan="1" colSpan="1" >API</td>
|
|
990
|
-
|
|
991
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
992
|
-
</tr>
|
|
993
|
-
|
|
994
|
-
<tr>
|
|
995
|
-
<td rowspan="1" colSpan="1" >[setFriendListener](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#acd403f586f3df84f56b1b757efb2d443)</td>
|
|
996
|
-
|
|
997
|
-
<td rowspan="1" colSpan="1" >Sets a contacts and friend profile listener. (This API is to be disused. Please use the `addFriendListener` and `removeFriendListener` APIs.)</td>
|
|
998
|
-
</tr>
|
|
999
|
-
|
|
1000
|
-
<tr>
|
|
1001
|
-
<td rowspan="1" colSpan="1" >[addFriendListener](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#a1de011b63b3c20b1be519dc7ba124704)</td>
|
|
1002
|
-
|
|
1003
|
-
<td rowspan="1" colSpan="1" >Adds a contacts listener.</td>
|
|
1004
|
-
</tr>
|
|
1005
|
-
|
|
1006
|
-
<tr>
|
|
1007
|
-
<td rowspan="1" colSpan="1" >[removeFriendListener](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#aed40ccbbc4e15be79154077a6d3ec085)</td>
|
|
1008
|
-
|
|
1009
|
-
<td rowspan="1" colSpan="1" >Removes a contacts listener.</td>
|
|
1010
|
-
</tr>
|
|
1011
|
-
|
|
1012
|
-
<tr>
|
|
1013
|
-
<td rowspan="1" colSpan="1" >[getFriendList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#a81131d76924a03ec2b593addd6e4e101)</td>
|
|
1014
|
-
|
|
1015
|
-
<td rowspan="1" colSpan="1" >Gets the contacts.</td>
|
|
1016
|
-
</tr>
|
|
1017
|
-
|
|
1018
|
-
<tr>
|
|
1019
|
-
<td rowspan="1" colSpan="1" >[getFriendsInfo](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#a39f6752da11b595e4a5b6dcb0eb6a584)</td>
|
|
1020
|
-
|
|
1021
|
-
<td rowspan="1" colSpan="1" >Gets the profiles of specified friends</td>
|
|
1022
|
-
</tr>
|
|
1023
|
-
|
|
1024
|
-
<tr>
|
|
1025
|
-
<td rowspan="1" colSpan="1" >[setFriendInfo](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#ac258312c000c1af69fcf51dd6898b74b)</td>
|
|
1026
|
-
|
|
1027
|
-
<td rowspan="1" colSpan="1" >Sets the profile of a specified friend</td>
|
|
1028
|
-
</tr>
|
|
1029
|
-
|
|
1030
|
-
<tr>
|
|
1031
|
-
<td rowspan="1" colSpan="1" >[searchFriends](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#a9a036dcc1bd65474a3d2e90f2bb6b9c6)</td>
|
|
1032
|
-
|
|
1033
|
-
<td rowspan="1" colSpan="1" >Searches for friends.</td>
|
|
1034
|
-
</tr>
|
|
1035
|
-
|
|
1036
|
-
<tr>
|
|
1037
|
-
<td rowspan="1" colSpan="1" >[addFriend](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#ac1ea1c7de2bfc2b0a25e5f6b3192e304)</td>
|
|
1038
|
-
|
|
1039
|
-
<td rowspan="1" colSpan="1" >Adds a friend</td>
|
|
1040
|
-
</tr>
|
|
1041
|
-
|
|
1042
|
-
<tr>
|
|
1043
|
-
<td rowspan="1" colSpan="1" >[deleteFromFriendList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#af967134fb177b32d4060fedf3663ace3)</td>
|
|
1044
|
-
|
|
1045
|
-
<td rowspan="1" colSpan="1" >Deletes a friend</td>
|
|
1046
|
-
</tr>
|
|
1047
|
-
|
|
1048
|
-
<tr>
|
|
1049
|
-
<td rowspan="1" colSpan="1" >[checkFriend](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#aad1b09fab6523d9a36147b4ed4efac67)</td>
|
|
1050
|
-
|
|
1051
|
-
<td rowspan="1" colSpan="1" >Checks relationship with specified users.</td>
|
|
1052
|
-
</tr>
|
|
1053
|
-
|
|
1054
|
-
<tr>
|
|
1055
|
-
<td rowspan="1" colSpan="1" >[getFriendApplicationList](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#acda7968f1e9adc12261a7e533d709a1c)</td>
|
|
1056
|
-
|
|
1057
|
-
<td rowspan="1" colSpan="1" >Gets the list of friend requests</td>
|
|
1058
|
-
</tr>
|
|
1059
|
-
|
|
1060
|
-
<tr>
|
|
1061
|
-
<td rowspan="1" colSpan="1" >[acceptFriendApplication](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#a51b913927028025e2e450e6e8ce848c0)</td>
|
|
1062
|
-
|
|
1063
|
-
<td rowspan="1" colSpan="1" >Accepts a friend request</td>
|
|
1064
|
-
</tr>
|
|
1065
|
-
|
|
1066
|
-
<tr>
|
|
1067
|
-
<td rowspan="1" colSpan="1" >[refuseFriendApplication](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#a406b964a6513219cfe4803f87f0f00f8)</td>
|
|
1068
|
-
|
|
1069
|
-
<td rowspan="1" colSpan="1" >Rejects a friend request</td>
|
|
1070
|
-
</tr>
|
|
1071
|
-
|
|
1072
|
-
<tr>
|
|
1073
|
-
<td rowspan="1" colSpan="1" >[deleteFriendApplication](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#a363e0622f653694999293c595d552896)</td>
|
|
1074
|
-
|
|
1075
|
-
<td rowspan="1" colSpan="1" >Deletes a friend request</td>
|
|
1076
|
-
</tr>
|
|
1077
|
-
|
|
1078
|
-
<tr>
|
|
1079
|
-
<td rowspan="1" colSpan="1" >[setFriendApplicationRead](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#ad46c70c18b8f69bf272cbf3466477a85)</td>
|
|
1080
|
-
|
|
1081
|
-
<td rowspan="1" colSpan="1" >Marks a friend request as read.</td>
|
|
1082
|
-
</tr>
|
|
1083
|
-
|
|
1084
|
-
<tr>
|
|
1085
|
-
<td rowspan="1" colSpan="1" >[createFriendGroup](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#a8b33edab15ae7d179e4e2d885e7d2b7d)</td>
|
|
1086
|
-
|
|
1087
|
-
<td rowspan="1" colSpan="1" >Creates a friend list</td>
|
|
1088
|
-
</tr>
|
|
1089
|
-
|
|
1090
|
-
<tr>
|
|
1091
|
-
<td rowspan="1" colSpan="1" >[getFriendGroups](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#a63f3eaae567586077d5a8d27c31e2229)</td>
|
|
1092
|
-
|
|
1093
|
-
<td rowspan="1" colSpan="1" >Gets the information of friend lists</td>
|
|
1094
|
-
</tr>
|
|
1095
|
-
|
|
1096
|
-
<tr>
|
|
1097
|
-
<td rowspan="1" colSpan="1" >[deleteFriendGroup](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#a2dc49f2abb1238fc2d47ce6d4f14c1e7)</td>
|
|
1098
|
-
|
|
1099
|
-
<td rowspan="1" colSpan="1" >Deletes friend lists</td>
|
|
1100
|
-
</tr>
|
|
1101
|
-
|
|
1102
|
-
<tr>
|
|
1103
|
-
<td rowspan="1" colSpan="1" >[renameFriendGroup](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#a93f6ba132d9706db7c74daff97a2abd0)</td>
|
|
1104
|
-
|
|
1105
|
-
<td rowspan="1" colSpan="1" >Modifies the name of a friend list</td>
|
|
1106
|
-
</tr>
|
|
1107
|
-
|
|
1108
|
-
<tr>
|
|
1109
|
-
<td rowspan="1" colSpan="1" >[addFriendsToFriendGroup](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#a0265241c39600c390406ca1f8f6ff75d)</td>
|
|
1110
|
-
|
|
1111
|
-
<td rowspan="1" colSpan="1" >Adds friends to a friend list</td>
|
|
1112
|
-
</tr>
|
|
1113
|
-
|
|
1114
|
-
<tr>
|
|
1115
|
-
<td rowspan="1" colSpan="1" >[deleteFriendsFromFriendGroup](https://im.sdk.qcloud.com/doc/en/categoryV2TIMManager_07Friendship_08.html#a4a14a878816c8d6a20981d1903fcf359)</td>
|
|
1116
|
-
|
|
1117
|
-
<td rowspan="1" colSpan="1" >Removes friends from a friend list.</td>
|
|
1118
|
-
</tr>
|
|
1119
|
-
</table>
|