@tencent-rtc/mcp 1.3.9 → 1.4.0

package/resource/doc/{chatuikit → chatkit}/android/faq.md

@@ -7,7 +7,6 @@ Yes.
 
 - 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:
@@ -17,7 +16,6 @@ If the 6013 "SDK Not Initialized" error occurs, try the following troubleshootin
 
 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.
@@ -31,10 +29,8 @@ There are two ways to use emojis:
 
 - 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.
@@ -60,7 +56,6 @@ These errors occur because UserID and UserSig do not match. To fix it, check the
 
 - -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.
@@ -77,44 +72,40 @@ This error occurs because App Store does not support the x86_64 and i386 archite
  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"  
-   
+   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
    ```
-   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100031390357/ac95ba51e28011eeb1eb525400b5f95f.png)
 
 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).
-
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027202808/a44543c197f611ef820f525400d5f8ef.png)

package/resource/doc/{chatuikit → chatkit}/android/features/theme.md

@@ -1,28 +1,9 @@
 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:
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**Light + Default Color**</td>
-
-<td rowspan="1" colSpan="1" >**Light + Orange**</td>
-
-<td rowspan="1" colSpan="1" >**Dark + Default Color**</td>
-
-<td rowspan="1" colSpan="1" >**Dark + Green Theme**</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027983637/1dcc10b9bee511f08863525400e889b2.png)</td>
-
-<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027983637/34013fd4bee511f0a808525400bf7822.png)</td>
-
-<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027983637/4d036798bee511f0b4c35254001c06ec.png)</td>
-
-<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027983637/61fff637bee511f08863525400e889b2.png)</td>
-</tr>
-</table>
-
+| **Light + Default Color** | **Light + Orange** | **Dark + Default Color** | **Dark + Green Theme** |
+| --- | --- | --- | --- |
+|  |  |  |  |
 
 ## Core Capabilities
 
@@ -33,7 +14,6 @@ Taking the message list as an example, the effects of custom theme modes and the
 
 - Follow System: Automatically follows system appearance settings.
 
-
    **Theme Color Customization**
 
 - Preset Theme Colors: Provides standard colors like blue, green, red, orange, etc.
@@ -44,121 +24,36 @@ Taking the message list as an example, the effects of custom theme modes and the
 
 - 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
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >Method</td>
-
-<td rowspan="1" colSpan="1" >Parameters</td>
-
-<td rowspan="1" colSpan="1" >Return Value</td>
-
-<td rowspan="1" colSpan="1" >Description</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`setThemeMode`</td>
-
-<td rowspan="1" colSpan="1" >`ThemeMode`</td>
-
-<td rowspan="1" colSpan="1" >`Unit`</td>
-
-<td rowspan="1" colSpan="1" >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.</td>
-</tr>
-</table>
-
+| 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
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >Method</td>
-
-<td rowspan="1" colSpan="1" >Parameters</td>
-
-<td rowspan="1" colSpan="1" >Return Value</td>
-
-<td rowspan="1" colSpan="1" >Description</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`setPrimaryColor`</td>
-
-<td rowspan="1" colSpan="1" >`String`</td>
-
-<td rowspan="1" colSpan="1" >`Unit`</td>
-
-<td rowspan="1" colSpan="1" >Sets the theme color, requires Hex format (e.g., "#1C66E5").</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`clearPrimaryColor`</td>
-
-<td rowspan="1" colSpan="1" >None</td>
-
-<td rowspan="1" colSpan="1" >`Unit`</td>
-
-<td rowspan="1" colSpan="1" >Clears custom theme color and restores default blue.</td>
-</tr>
-</table>
-
+| 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:
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >Property</td>
-
-<td rowspan="1" colSpan="1" >Type</td>
-
-<td rowspan="1" colSpan="1" >Description</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`currentMode`</td>
-
-<td rowspan="1" colSpan="1" >`ThemeMode`</td>
-
-<td rowspan="1" colSpan="1" >Current theme mode.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`currentPrimaryColor`</td>
-
-<td rowspan="1" colSpan="1" >`String?`</td>
-
-<td rowspan="1" colSpan="1" >Current theme color (Hex format).</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`hasCustomPrimaryColor`</td>
-
-<td rowspan="1" colSpan="1" >`Boolean`</td>
-
-<td rowspan="1" colSpan="1" >Whether a custom theme color is set.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`isDarkMode`</td>
-
-<td rowspan="1" colSpan="1" >`Boolean`</td>
-
-<td rowspan="1" colSpan="1" >Whether currently in dark mode.</td>
-</tr>
-</table>
-
+| 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
 
@@ -170,9 +65,6 @@ AppBuilder is a convenient feature and UI customization configuration tool, mana
 
 You can experience the AppBuilder feature at [Chat Web Demo](https://trtc.io/demo/homepage/#/detail?scene=messenger), experience entry:
 
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027983637/321d5873b88211f09a6b525400454e06.png)
-
-
 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:
@@ -180,14 +72,10 @@ Next, we'll introduce how to apply custom configurations to mobile projects afte
 
 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:
 
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027983637/3205aa68b88211f0a808525400bf7822.png)
-
-
 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
 {
@@ -229,46 +117,15 @@ The `appConfig.json` file content is shown below, corresponding one-to-one with
 ```
 
 **Configuration Options**
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >Parameter</td>
-
-<td rowspan="1" colSpan="1" >Type</td>
-
-<td rowspan="1" colSpan="1" >Options</td>
-
-<td rowspan="1" colSpan="1" >Description</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`mode`</td>
-
-<td rowspan="1" colSpan="1" >String</td>
-
-<td rowspan="1" colSpan="1" >`"system"`, `"light"`, `"dark"`</td>
-
-<td rowspan="1" colSpan="1" >Theme mode</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`primaryColor`</td>
-
-<td rowspan="1" colSpan="1" >String</td>
-
-<td rowspan="1" colSpan="1" >Hex color value, e.g., `"#0ABF77"`</td>
-
-<td rowspan="1" colSpan="1" >Theme color</td>
-</tr>
-</table>
-
+| 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:
 
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027983637/ce0dba6fb88a11f0a808525400bf7822.png)
-
-
 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
@@ -317,11 +174,10 @@ Column {
 ```
 
 > **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?**