@tencent-rtc/mcp 1.4.7 → 1.6.0

package/resource/doc/chatkit/flutter/integration.md

@@ -1,344 +0,0 @@
-TUIKit Flutter is a set of Flutter UI component libraries based on Tencent Cloud IM SDK, providing complete solutions for instant messaging features such as chat, conversation list, and contact management. This document introduces how to manually integrate these components and implement core features.
-
-## Key Concepts
-
-TUIKit provides a complete set of instant messaging UI components, relying on the AtomicXCore data layer at the bottom and allowing construction of various functional Pages at the top.
-- Page Layer: Complete functional pages encapsulated based on TUIKit components: ChatPage, ContactsPage, ConversationsPage, which you can use directly.
-
-- TUIKit Flutter (UI Component Layer): Flutter components built on AtomicXCore, which you can embed into your existing App pages.
-
-- AtomicXCore (Data Layer): Provides data management and business logic, including various Stores and Managers.
-
-## Prerequisites
-- Flutter >= 3.29.0, Dart >= 3.7.0, Kotlin >= 1.9.
-
-- Android Studio Ladybug | 2024.2.1 or higher, Android Gradle plugin 7.3.1 or higher, JDK 17.
-
-- Xcode 12.0 or higher.
-
-- A valid Tencent Cloud account and Chat application. Refer to [Activate Service](https://trtc.io/document/45907?product=chat&menulabel=uikit&platform=flutter) to obtain the following information from the console:
-
-  - SDKAppID: The ID of the Chat application obtained from the console, serving as the unique identifier for the application.
-
-  - SDKSecretKey: The application's secret key.
-
-      > **Note:**
-      >
->     - This project currently only supports manual integration and does not support integration via pub.dev.
->     - To ensure a stable build environment, please strictly follow the official compatibility requirements for configuration:
->     - For compatibility between Gradle, Android Gradle Plugin, JDK, and Android Studio, please refer to the Android official documentation: [Version Notes](https://developer.android.com/build/releases/gradle-plugin#updating-gradle).
->     - For version correspondence between Kotlin, Android Gradle Plugin, and Gradle, please refer to the Kotlin official documentation: [Kotlin-Gradle Plugin Compatibility](https://kotlinlang.org/docs/gradle-configure-project.html#apply-the-plugin).
->     - Use JDK 17, as other versions may cause compilation failures. Refer to: [Java Version Switching](https://developer.android.com/build/jdks#kts).
-
-      > We recommend that you choose a version combination that fully matches the project requirements according to the above guidelines.
-      >
-
-## Integration and Import Components
-
-### Download Source Code
-
-1. Download [TUIKit Flutter](https://github.com/Tencent-RTC/TUIKit_Flutter) source code from GitHub:
-``` xml
-git clone https://github.com/Tencent-RTC/TUIKit_Flutter.git
-```
-
-Project directory structure explanation:
-``` bash
-atomic-x/
-├── lib/                  # UI component source code (required integration)
-│   ├── messagelist/      # Message list component
-│   ├── messageinput/     # Message input component
-│   ├── conversationlist/ # Conversation list component
-│   ├── contactlist/      # Contact list component
-│   ├── basecomponent/    # Base components
-│   └── ...               # Other UI components
-├── call_assets/          # Call resource files (required integration)
-├── chat_assets/          # Chat resource files (required integration)
-chat/
-├── uikit/                # Page components (reference implementation)
-│   ├── lib/
-│      ├── chat_page.dart
-│      ├── contacts_page.dart
-│      └── conversations_page.dart
-└── demo/                 # Example application (optional reference)
-```
-
-### Integrate Components
-1. Copy the complete component directory to your Flutter project, as shown below. Here flutter_demo is the example project, and TUIKit_Flutter is the component source code downloaded from GitHub:
-
-2. Add TUIKit Flutter components to your pubspec.yaml file. Note that TUIKit_Flutter can be placed anywhere, as long as the relative path is correctly set in pubspec.yaml:
-
-   ``` bash
-     tuikit_atomic_x:
-       path: ../TUIKit_Flutter/atomic-x
-   ```
-
-   > **Note:**
-   >
->   - When using the local integration solution, if you need to upgrade, you need to obtain the latest component code from GitHub and overwrite the TUIKit_Flutter directory in your local project.
->   - When there are conflicts between private modifications and remote changes, you need to manually merge and resolve conflicts.
-
-### Configure Project
-
-Add necessary permission configurations on the iOS side. Open ios/Podfile and add the following permission code at the end of the file:
-``` objectivec
-post_install do |installer|
-  installer.pods_project.targets.each do |target|
-    flutter_additional_ios_build_settings(target)
-    target.build_configurations.each do |config|
-          config.build_settings['EXCLUDED_ARCHS[sdk=iphonesimulator*]'] = 'arm64'
-          config.build_settings['ENABLE_BITCODE'] = 'NO'
-          config.build_settings["ONLY_ACTIVE_ARCH"] = "NO"
-        end
-    target.build_configurations.each do |config|
-          config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= [
-            '$(inherited)',
-            'PERMISSION_MICROPHONE=1',
-            'PERMISSION_CAMERA=1',
-            'PERMISSION_PHOTOS=1',
-          ]
-        end
-  end
-end
-
-```
-
-## Integration Steps
-
-### Step 1: Configure User Authentication
-
-Obtain UserSig according to UserID in the [Chat Console](https://console.trtc.io/usersig) for subsequent user authentication during login.
-
-### Step 2: User Login
-
-After login authentication, you can use the component features normally. You can call the login interface and pass the SDKAPPID, userID, and userSig obtained above for login authentication:
-``` java
-final result = await LoginStore.shared.login(
-      sdkAppID: SDKAPPID,
-      userID: userID,
-      userSig: userSig,
-    );
-if (result.errorCode == 0) {
-    // Login successful, can navigate to chat or conversation page
-} else {
-    // Login failed, can display error popup
-}
-```
-
-> **Note:**
->
-
-> In a formal production environment, it is recommended to generate UserSig on your server. When UserSig is needed, your App should send a request to your business server to obtain dynamic UserSig for authentication. See [Generate UserSig on Server](https://trtc.io/document/34385).
->
-
-### Step 3: Build Conversation List Interface
-
-You can build a conversation list page based on the ConversationList component in TUIKit Flutter. Built-in features of ConversationList include:
-- Display the user's conversation list, including one-on-one and group conversations
-
-- Support user operations on individual conversations: pin, delete, clear conversation messages, etc.
-
-   You can integrate ConversationList directly into your existing App page, or build a complete new conversation list page. One assembled UI effect is shown below:
-
-   To encapsulate ConversationList as a conversation list page, refer to the implementation in the `chat/uikit/lib/conversations_page.dart` file. `ConversationsPage` mainly does the following:
-
-1. Adds AppBar above ConversationList.
-
-2. Implements click events for conversation list cells.
-
-3. Supports creating conversations and groups:
-
-  1. Click the button in the upper right corner to create new conversations or groups
-
-  2. Supports selecting friends from the contact list to create one-on-one chats
-
-  3. Supports selecting multiple friends to create group chats
-
-      Core example code is as follows:
-
-      ``` java
-        @override
-        Widget build(BuildContext context) {
-          return Scaffold(
-            appBar: AppBar(
-              backgroundColor: colorsTheme.bgColorOperate,
-              title: Text(atomicLocale.chat, style: TextStyle(fontSize: 34, fontWeight: FontWeight.w600)),
-              centerTitle: false,
-              scrolledUnderElevation: 0,
-              actions: [],
-            ),
-            body: Column(
-              children: [
-                Expanded(
-                  child: ConversationList(
-                    onConversationClick: (conversation) {
-                      Navigator.push(
-                        context,
-                        MaterialPageRoute(
-                          builder: (context) => ChatPage(
-                            conversation: conversation,
-                          ),
-                        ),
-                      );
-                    },
-                  ),
-                ),
-              ],
-            ),
-          );
-        }
-      ```
-
-### Step 4: Build Chat Interface
-
-You can build a chat page based on the MessageList and MessageInput components in TUIKit Flutter.
-
-Built-in features of MessageList include:
-- Display one-on-one or group message lists.
-
-- Support operations on individual messages: view large images for image messages, play video or voice messages, copy text messages, recall messages, delete messages, etc.
-
-   Built-in features of MessageInput include:
-
-- Support users in composing and sending various types of messages: text, emoji, image, voice, video, file, etc.
-
-   You can integrate MessageList and MessageInput directly into your existing App page, or build a complete new chat page. One assembled UI effect is shown below:
-
-   To assemble MessageList and MessageInput as a chat page, refer to the implementation in the `chat/uikit/lib/chat_page.dart` file. `ChatPage` mainly does the following:
-
-1. Adds AppBar at the top to display the conversation name.
-
-2. Vertically combines MessageList and MessageInput according to mobile user habits.
-
-   Core example code is as follows:
-
-   ``` java
-     @override
-     Widget build(BuildContext context) {
-       return Scaffold(
-         appBar: AppBar(
-             backgroundColor: colorsTheme.bgColorOperate,
-             titleSpacing: 4.0,
-             centerTitle: false,
-             title: GestureDetector(
-               onTap: _onTitleTap,
-               child: Row(
-                 mainAxisSize: MainAxisSize.min,
-                 children: [
-                   Padding(
-                     padding: const EdgeInsets.only(right: 8.0),
-                     child: Avatar.image(
-                       name: widget.conversation.title,
-                       url: widget.conversation.avatarURL,
-                     ),
-                   ),
-                   Expanded(
-                     child: Text(
-                       widget.conversation.title ?? atomicLocale.chat,
-                       style: TextStyle(fontSize: 14, fontWeight: FontWeight.w600),
-                       overflow: TextOverflow.ellipsis,
-                       maxLines: 1,
-                     ),
-                   ),
-                 ],
-               ),
-             ),
-             scrolledUnderElevation: 0.0,
-             leading: IconButton.buttonContent(
-               content: IconOnlyContent(Icon(Icons.arrow_back_ios, color: colorsTheme.buttonColorPrimaryDefault)),
-               type: ButtonType.noBorder,
-               size: ButtonSize.l,
-               onClick: () => Navigator.of(context).pop(),
-             ),
-             actions: []),
-         body: Column(
-           children: [
-             MessageList(
-               conversationID: widget.conversation.conversationID,
-               locateMessage: widget.message,
-               onUserClick: (String userID) => _onUserClick(userID),
-             ),
-             MessageInput(
-               conversationID: widget.conversation.conversationID,
-             ),
-           ],
-         ),
-       );
-     }
-   ```
-
-### Step 5: Build Contact Interface
-
-You can build a contact page based on the ContactList component in TUIKit Flutter. Built-in features of ContactList include:
-- View friend request list.
-
-- View list of joined groups.
-
-- Handle group invitations and applications.
-
-- Manage blocklist.
-
-- View friends.
-
-   You can integrate ContactList directly into your existing App, or build a complete new contact list page. One assembled UI effect is shown below:
-
-   To encapsulate ContactList as a contact list page, refer to the implementation in the `chat/uikit/lib/contacts_page.dart` file. `ContactsPage` mainly does the following:
-
-1. Adds AppBar above ContactList.
-
-2. Implements click events for contact list cells.
-
-3. Supports adding contacts and groups:
-
-  1. Click the "+" button in the upper right corner to add contacts or groups
-
-  2. Supports searching for target contacts by UserID
-
-  3. Supports searching for target groups by GroupID
-
-      Core example code is as follows:
-
-      ``` java
-        @override
-        Widget build(BuildContext context) {
-          AtomicLocalizations atomicLocale = AtomicLocalizations.of(context);
-          SemanticColorScheme colorsScheme = BaseThemeProvider.colorsOf(context);
-          return Scaffold(
-            appBar: AppBar(
-              backgroundColor: colorsScheme.bgColorOperate,
-              title: Text(atomicLocale.contact, style: TextStyle(fontSize: 34, fontWeight: FontWeight.w600),),
-              centerTitle: false,
-              scrolledUnderElevation: 0,
-              actions: [],
-            ),
-            body: ContactList(
-              onGroupClick: (ContactInfo contactInfo) {
-                _onGroupClick(context, contactInfo);
-              },
-              onContactClick: (ContactInfo contactInfo) {
-                _onContactClick(context, contactInfo);
-              },
-            ),
-          );
-        }
-      ```
-
-### Step 6: Complete Navigation Logic Between Interfaces
-
-ConversationsPage, ChatPage, and ContactsPage implement default user click events. You can customize events to implement interactions between pages:
-| Page | Callback | Suggested Navigation Logic |
-| --- | --- | --- |
-| **ConversationsPage** | `onConversationClick: (conversation) {}` | Triggered when clicking a conversation in the conversation list, recommended to navigate to the chat page (ChatPage). |
-| **ContactsPage** | `onContactClick: (ContactInfo contactInfo) {}` | Triggered when clicking a contact cell, recommended to navigate to the user info page (C2CChatSetting). |
-| `onGroupClick: (ContactInfo contactInfo) {}` | Triggered when clicking a group cell, recommended to navigate to the group chat page (ChatPage). |  |
-| **ChatPage** | `onUserClick: (String userID) {}` | Triggered when clicking a user avatar or nickname in a message, recommended to navigate to the user info page (C2CChatSetting). |
-| `onChatHeaderClick: () {}` | Triggered when clicking the avatar in the navigation bar, recommended to navigate to the user info page (C2CChatSetting) or group chat info page (GroupChatSetting) |  |
-| `onBackClick: () {}` | Triggered when clicking the back button, recommended to return to the previous page. |  |
-
-You can refer to the above callback descriptions and reference code to implement interaction logic between Pages.
-
-## FAQ
-
-### **After integrating the tuikit_atomic_x component, what should I do about errors related to **`theme_state`** and **`atomic_localizations`**?**
-
-The component supports theme color and internationalized string switching. You need to use `ComponentTheme` to wrap the root `widget` in the `main.dart` file in the project root directory, and add the `AtomicLocalizations.delegate` configuration to the `localizationsDelegates` of `MaterialApp`. You can refer to the `main.dart` file in the source code Demo for usage.

package/resource/doc/chatkit/ios/faq.md

@@ -1,111 +0,0 @@
-### Does TUIKit source code support Androidx?
-
-Yes.
-
-### Why do I encounter a 6012 error or "TLSSDK exchange ticket fail" upon login?
-- The initialization API and the login API must be called separately and cannot be called successively because there are asynchronous operations in the initialization method.
-
-- If you are using Chat Free edition and upgrade to Chat Pro Edition, after the upgrade, you can configure your SDKAppID in the console to ensure proper login. For pricing details, see [Pricing](https://intl.cloud.tencent.com/document/product/1047/34350).
-
-### Why do I encounter a 6013 "SDK Not Initialized" error?
-
-If the 6013 "SDK Not Initialized" error occurs, try the following troubleshooting methods:
-1. Check whether you performed other operations such as receiving and sending messages before logging in successfully.
-
-2. Check whether you were forced offline when logging in by an account already logged in on another device. By default, the Chat SDK allows one account to log in on one device at a time. For more information, see [Multi-Device Login](https://intl.cloud.tencent.com/document/product/1047/33518).
-
-3. For Android, verify that all library files have been loaded or repossessed by the system during use.
-
-### Why do I encounter "code: 6205 desc: QALSERVICE not ready" error?
-
-This error is caused by calling `stopQALService` after initialization. To fix it, refer to the [configuration method](https://blog.csdn.net/qq_16131393/article/details/54895733) shared by one of our customers.
-
-### Why do not emojis appear or appear as gibberish in messages?
-
-Chat does not provide emoji packs. You must align the actual parsing by yourself.
-
-There are two ways to use emojis:
-- Use index in TIMFaceElem to identify the index of the emojis. For example, an Android device and an iOS device have the same set of emojis and index 2 represents the smile emoji. When index=2, both devices send and receive the same indexed emoji.
-
-- Use data in TIMFaceElem. For example, the names of emoji images are string-type. Use the word "smile" to represent the smile emoji, and store "smile" in data. Then, both iOS and Android devices use data as the key to retrieve and display the corresponding emoji.
-
-   You can also use the two fields at the same time. For example, use data to specify the emoji set and index to indicate the specific index in this emoji set. This way, you can implement many different emoji effects as in QQ. It is possible to store more complex data structures in data as long as the devices follow the same parsing rules.
-
-### Why do I encounter error 10002 during operations?
-
-This status code is returned when a network exception, timeout, or ticket switching failure occurs during server-side authentication. If you see this status code, wait a moment and try again.
-
-### Why do I encounter error 6200 or 6201 when receiving or sending messages?
-
-This status code is returned when the client is offline, times out, or is disconnected. Error 6200 is defined as no network connection during request sending, whereas error 6201 is defined as no network connection during response sending. When you encounter this status code, check the network condition or wait for the network to restore and try again.
-
-### Why do I encounter error 20003 when receiving and sending messages?
-
-This error code is returned when UserID is invalid or UserID has not been imported to Chat. To fix it, check whether UserID has been imported to Tencent Cloud.
-
-### Why do I encounter error 6010 when playing audio messages?
-
-This error code is returned when audio messages that are no longer retained by the roaming server are requested. To fix it, you can [increase the message roaming duration](https://intl.cloud.tencent.com/document/product/1047/34419) or download audio files to local storage and play them. However, expired files cannot be restored. Different SDK versions allow you to increase the retention duration for different message types. For more information, see [Message Storage](https://intl.cloud.tencent.com/document/product/1047/33524).
-
-### Why do I encounter errors 70001, 70003, 70009, and 70013 during account authentication?
-
-These errors occur because UserID and UserSig do not match. To fix it, check the validity of UserID and UserSig. Among them, error 70001 means UserSig has expired, error 70003 means a verification failure due to a truncated UserSig, error 70009 means UserSig verification failed (possibly due to mixing the keys or private keys of other SDKAppIDs when generating UserSig), and error 70013 means UserID does not match.
-
-### Why do I encounter the error code -2 or -5 when the web client app is using the Chat SDK?
-- -2: Indicates that a web app request to the server failed, usually due to network problems. Web apps send requests to the server by using the HTTP Long Polling method, and this status code is returned when a network problem occurs. To fix it, check your network or try again.
-
-- -5: When the login attempt is not completed and the SDK has not received the a2key and tinyID returned by the server, directly calling other APIs returns the "tinyid or a2 is empty" error message and -5 error code.
-
-### What should I do when the SDK on the armeabi platform reports "java.lang.UnsatisfiedLinkError: No implementation found for"?
-
-Copy jni/armeabi-v7a/libImSDK.so in the Chat SDK’s aar file to the src/main/jniLibs/armeabi directory in your source code project and load it in build.gradle.
-
-### How can I resolve x86_64 and i386 architecture errors when the app has been launched in App Store?
-
-This error occurs because App Store does not support the x86_64 and i386 architecture. The solution is as follows:
-1. Clear the project compilation cache:
- Select **Product** > **clean**, press Alt until "clean build Folder..." appears and wait for the operation to complete.
-
-2. Remove the x86_64 and i386 architecture not supported by App Store:
- a. Select **TARGETS** > **Build Phases**.
- b. Click the plus sign and select **New Run Script Phase**.
- c. Add the following code:
-
-   ``` bash
-   APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"
-
-   # This script loops through the frameworks embedded in the application and
-
-   # removes unused architectures.
-
-    find "$APP_PATH" -name '*.framework' -type d | while read -r FRAMEWORK
-    do
-    FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
-    FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
-    echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"
-
-    EXTRACTED_ARCHS=()
-
-    for ARCH in $ARCHS
-    do
-    echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"
-    lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
-    EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
-    done
-
-    echo "Merging extracted architectures: ${ARCHS}"
-    lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
-    rm "${EXTRACTED_ARCHS[@]}"
-
-    echo "Replacing original executable with thinned version"
-    rm "$FRAMEWORK_EXECUTABLE_PATH"
-    mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"
-
-    done
-   ```
-
-3. Package the app and upload it again.
-
-### Can developers directly utilize the emoticon packs demonstrated in the Chat various client demos/TUIKit projects?
-
-To respect the copyright of emoji designs, the Chat Demo/TUIKit project does not include cutouts of large emoji elements. Please replace them with your own designs or other emoji packs for which you hold the copyright before officially launching for commercial use. **The default smiley face emoji pack shown below is copyrighted by Tencent RTC** and is available for licensed use for a fee. If you need to obtain a license, please [contact us](https://trtc.io/contact).