@tencent-rtc/mcp 1.4.6 → 1.6.0-beta.1

package/resource/doc/chatkit/android/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).

package/resource/doc/chatkit/android/features/theme.md

@@ -1,219 +0,0 @@
-TUIKit Compose provides powerful appearance customization capabilities, supporting custom theme modes (Light/Dark/Follow System) and theme colors for your application. Through simple configuration, developers can easily implement app-level theme switching and brand color customization.
-
-Taking the message list as an example, the effects of custom theme modes and theme colors are shown below:
-| **Light + Default Color** | **Light + Orange** | **Dark + Default Color** | **Dark + Green Theme** |
-| --- | --- | --- | --- |
-|  |  |  |  |
-
-## Core Capabilities
-
-**Mode Switching**
-- Light Mode: Bright interface suitable for daytime use.
-
-- Dark Mode: Dark interface suitable for nighttime use.
-
-- Follow System: Automatically follows system appearance settings.
-
-   **Theme Color Customization**
-
-- Preset Theme Colors: Provides standard colors like blue, green, red, orange, etc.
-
-- Custom Theme Colors: Supports any Hex format color.
-
-- Smart Palette Generation: Automatically generates a complete palette of 10 color shades.
-
-- Clear Customization: One-click restore to default theme color.
-
-## API Reference
-
-The above functionalities are based on a set of concise APIs provided by `ThemeState` for theme configuration and information queries.
-
-### Set Theme Mode
-| Method | Parameters | Return Value | Description |
-| --- | --- | --- | --- |
-| `setThemeMode` | `ThemeMode` | `Unit` | Sets the display mode, automatically saves and refreshes.<br>• `ThemeMode.SYSTEM`: Follow system appearance.<br>• `ThemeMode.LIGHT`: Force light mode.<br>• `ThemeMode.DARK`: Force dark mode. |
-
-### Set Theme Color
-| Method | Parameters | Return Value | Description |
-| --- | --- | --- | --- |
-| `setPrimaryColor` | `String` | `Unit` | Sets the theme color, requires Hex format (e.g., "#1C66E5"). |
-| `clearPrimaryColor` | None | `Unit` | Clears custom theme color and restores default blue. |
-
-> **Note:**
->
-> - After calling `setThemeMode` or `setPrimaryColor`, the configuration is automatically saved to persistent storage without manual saving. It will automatically load on next app launch.
-> - Cache is automatically cleared when modifying theme configuration, ensuring the color scheme updates in real-time. Developers don't need to manage cache.
-> - Avoid frequently switching themes when using settings APIs (e.g., calling in a loop).
-
-### Query ThemeState Information
-
-The following read-only properties can be used to query the current theme configuration status and information:
-| Property | Type | Description |
-| --- | --- | --- |
-| `currentMode` | `ThemeMode` | Current theme mode. |
-| `currentPrimaryColor` | `String?` | Current theme color (Hex format). |
-| `hasCustomPrimaryColor` | `Boolean` | Whether a custom theme color is set. |
-| `isDarkMode` | `Boolean` | Whether currently in dark mode. |
-
-## Usage
-
-This section introduces how to integrate and use theme and theme color customization features in your application, providing three approaches from simple to complex.
-
-### Approach 1: Using AppBuilder Configuration (Recommended)
-
-AppBuilder is a convenient feature and UI customization configuration tool, managed through JSON configuration files, suitable for scenarios where Web + Native dual-platform applications need to maintain a unified appearance.
-
-You can experience the AppBuilder feature at [Chat Web Demo](https://trtc.io/demo/homepage/#/detail?scene=messenger), experience entry:
-
-Although the Chat Web Demo currently cannot preview mobile configuration effects in real-time, mobile platforms already support AppBuilder's configuration capabilities.
-
-Next, we'll introduce how to apply custom configurations to mobile projects after setting up AppBuilder in the Web demo. The process is quite simple, with only 2 steps:
-1. Download the configuration file.
-
-2. Drag the configuration file appConfig.json into your Android project.
-
-####  1. Download Configuration File
-
-Visit [Chat Web Demo](https://trtc.io/demo/homepage/#/detail?scene=messenger) and download the appConfig.json configuration file. The download path is:
-
-The `appConfig.json` file content is shown below, corresponding one-to-one with the configuration items on the AppBuilder page. The appearance-related configurations are `theme` and its subfields:
-``` json
-{
-  "theme": {
-    "mode": "light", // Theme mode: light-Light mode, dark-Dark mode, system-Follow system
-    "primaryColor": "#E65100" // Primary color, hex color value
-  },
-  "messageList": {
-    "alignment": "two-sided",
-    "enableReadReceipt": false,
-    "messageActionList": [
-        "copy",
-        "recall",
-        "quote",
-        "forward",
-        "delete"
-    ]
-  },
-  "conversationList": {
-    "enableCreateConversation": true,
-    "conversationActionList": [
-      "delete",
-      "mute",
-      "pin",
-      "markUnread"
-    ]
-  },
-  "messageInput": {
-    "hideSendButton": false,
-    "attachmentPickerMode": "collapsed"
-  },
-  "search": {
-    "hideSearch": false
-  },
-  "avatar": {
-    "shape": "circular"
-  }
-}
-```
-
-**Configuration Options**
-| Parameter | Type | Options | Description |
-| --- | --- | --- | --- |
-| `mode` | String | `"system"`, `"light"`, `"dark"` | Theme mode |
-| `primaryColor` | String | Hex color value, e.g., `"#0ABF77"` | Theme color |
-
-#### 2. Add Configuration File to Project
-
-Drag appConfig.json into your project. Taking the GitHub open source Demo [TUIKit Android Compose](https://github.com/Tencent-RTC/TUIKit_Android_Compose/blob/main/chat/demo/app/src/main/assets/appConfig.json) project as an example, appConfig.json is located in the demo/app's assets folder:
-
-After this, without writing additional code, when you launch the app, the mode and theme color of TUIKit Compose components will automatically display the values you set in appConfig.json.
-
-### Approach 2: Set Theme Mode via Code
-
-You can directly set the theme mode through the API `setThemeMode`. Example code:
-``` swift
-val themeState = ThemeState.shared
-Column {
-    Button(onClick = {
-        themeState.setThemeMode(ThemeMode.SYSTEM)
-    }) { Text(text = "Follow System") }
-    Button(onClick = {
-        themeState.setThemeMode(ThemeMode.LIGHT)
-    }) { Text(text = "Light Mode") }
-    Button(onClick = {
-        themeState.setThemeMode(ThemeMode.DARK)
-    }) { Text(text = "Dark Mode") }
-}
-```
-
-### Approach 3: Set Theme Color via Code
-
-You can set the theme color through the API `setPrimaryColor` by passing a primary color value. The entire TUIKit Compose component will automatically adapt a set of similar color values in the same color scheme based on this primary color value to render the interface, without the need for manual UI adaptation. Example code:
-``` swift
-Column {
-    var text: String by remember { mutableStateOf("#1C66E5") }
-
-    fun isValidHexColor(): Boolean {
-        return text.matches(Regex("^#[0-9A-Fa-f]{6}$"))
-    }
-    BasicTextField(
-        value = text,
-        onValueChange = { text = it },
-        modifier = Modifier
-            .fillMaxWidth()
-            .padding(16.dp)
-    )
-    Button(
-        enabled = isValidHexColor(),
-        onClick = {
-            themeState.setPrimaryColor(text)
-        }) {
-        Text("Apply Theme Color")
-    }
-}
-```
-
-> **Usage Recommendations:**
->
-> - For most applications, it's recommended to use the JSON configuration file approach, which is simple, reliable, and supports multi-platform uniformity.
-> - Consistently use colors from `themeState.colors` throughout the application to ensure interface consistency when switching themes.
-
-## FAQ
-
-### **How to determine if currently in dark mode?**
-``` java
-if themeState.isDarkMode {
-    // Currently in dark mode
-} else {
-    // Currently in light mode
-}
-```
-
-### **Can I set transparency?**
-
-Not supported. Theme colors only support 6-digit Hex format (RGB), not 8-digit format (RGBA).
-
-### **How to restore default theme?**
-``` swift
-themeState.clearPrimaryColor()  // Clear custom theme color
-themeState.setThemeMode(ThemeMode.SYSTEM)  // Restore follow system
-```
-
-### **Where is theme configuration stored?**
-
-Stored in the app's persistent storage. It will be lost after uninstalling the app and will restore to default configuration after reinstalling.
-
-### **How to get the complete current theme configuration?**
-``` swift
-val config = themeState.currentTheme
-print("Mode: ${config.mode}")
-print("Theme Color: ${config.primaryColor ?: "Default"}")
-```
-
-### **Can I set mode and theme color simultaneously?**
-
-Yes, you can call both methods separately, and the system will automatically merge the configurations:
-``` swift
-themeState.setThemeMode(ThemeMode.DARK)
-themeState.setPrimaryColor("#0ABF77")
-```