@tencent-rtc/mcp 1.4.7 → 1.6.0

package/resource/knowledge/chat/preset/ios/features/language.md

@@ -0,0 +1,125 @@
+## Feature Description
+
+`TUIKit SwiftUI` includes built-in language packs for **English**, **Simplified Chinese**, **Traditional Chinese**, and **Arabic** as default interface languages.
+
+This documentation covers how to use these default language packs, customize translation entries, or add new language packs.
+
+|**English**|**Arabic**|**Simplified Chinese**|
+|---------|---------|---------|
+||||
+
+## Using Built-in Languages
+
+If your app only needs to support **English**, **Simplified Chinese**, **Traditional Chinese**, and **Arabic**, follow this section.
+
+### Following System Language
+
+To use the built-in languages, simply integrate `TUIKit SwiftUI`. No additional configuration is required. The component automatically matches the system language. If the system language is not one of the four supported languages, English is used by default.
+
+### Setting a Specific Language
+
+To manually set the interface language for `TUIKit SwiftUI`, call `setLanguage` with the desired language code. Once set, the component will not follow the system language. Example:
+``` swift
+let languageState = LanguageState()
+// Supported languages:
+// "zh-Hans" - Simplified Chinese
+// "zh-Hant" - Traditional Chinese
+// "en" - English
+// "ar" - Arabic
+languageState.setLanguage("zh-Hans")
+```
+
+## Using Additional Languages or Custom Translation Entries
+
+If you need to support additional languages or modify translation entries, follow this section.
+
+This example demonstrates how to add a Korean language pack and customize translations.
+
+### Adding Language Resource Files
+
+Create a `ko.lproj` directory and a `Localizable.strings` file under `ChatLocalizable.bundle/Localizable/`. After adding Korean, the directory structure will look like this:
+``` plaintext
+Resources/strings/ChatLocalizable.bundle/Localizable/
+├── ar.lproj/Localizable.strings
+├── en.lproj/Localizable.strings
+├── zh-Hans.lproj/Localizable.strings
+└── zh-Hant.lproj/Localizable.strings
+└── ko.lproj/Localizable.strings    // Korean translation file; "ko" is the ISO 639-1 language code for Korean
+```
+
+Refer to the keys in `en.lproj/Localizable.strings` and provide Korean translations for each entry.
+
+> **Note：**
+>
+> 1. For other bundles (such as AlbumPickerLocalizable, VideoRecorderLocalizable, RTCLocalizable, etc.), it's recommended to add `ko.lproj` as well.
+> 2. For the full list of language codes, see ISO 639-1 language codes.
+
+### Customizing Translation Content
+
+After creating `ko.lproj/Localizable.strings`, the keys are consistent across all language resource files. You can customize the translation content as needed.
+
+### Following System Language
+
+Add support for the new language in the `getSystemLanguage` function within `LanguageState.swift`.
+
+Language pack naming must follow the ISO 639-1 language code standard. The component will automatically adapt to the system language.
+``` swift
+private static func getSystemLanguage() -> String {
+    let preferredLanguage = Locale.preferredLanguages.first ?? "en"
+    if preferredLanguage.hasPrefix("en") {
+        return "en"
+    } else if preferredLanguage.hasPrefix("zh") {
+        if preferredLanguage.contains("Hans") {
+            return "zh-Hans"
+        } else {
+            return "zh-Hant"
+        }
+    } else if preferredLanguage.hasPrefix("ar") {
+        return "ar"
+    } else if preferredLanguage.hasPrefix("ko") {
+        return "ko" // Add this branch to support Korean system language
+    } else {
+        return "en"
+    }
+}
+```
+
+### Setting a Specific Language
+
+To set the `TUIKit SwiftUI` interface to Korean, call `setLanguage` with the appropriate language code. Once set, the component will not follow the system language. Example:
+``` swift
+let languageState = LanguageState()
+// Supported languages:
+// "zh-Hans" - Simplified Chinese
+// "zh-Hant" - Traditional Chinese
+// "en" - English
+// "ar" - Arabic
+languageState.setLanguage("zh-Hans")
+```
+
+Once completed, the interface will display in Korean, as shown below:
+
+## Appendix: Language Code Table
+
+|Language|Code|Language|Code|
+|---------|---------|---------|---------|
+|Arabic|ar|Bulgarian|bg|
+|Croatian|hr|Czech|cs|
+|Danish|da|German|de|
+|Greek|el|English|en|
+|Estonian|et|Spanish|es|
+|Finnish|fi|French|fr|
+|Irish|ga|Hindi|hi|
+|Hungarian|hu|Hebrew|he|
+|Italian|it|Japanese|ja|
+|Korean|ko|Latvian|lv|
+|Lithuanian|lt|Dutch|nl|
+|Norwegian|no|Polish|pl|
+|Portuguese|pt|Swedish|sv|
+|Romanian|ro|Russian|ru|
+|Serbian|sr|Slovak|sk|
+|Slovenian|sl|Thai|th|
+|Turkish|tr|Ukrainian|uk|
+|Chinese (Simplified)|zh-Hans|Chinese (Traditional)|zh-Hant|
+
+For a complete list, [see here](https://quickref.me/iso-639-1).

package/resource/knowledge/chat/preset/ios/features/message-input.md

@@ -0,0 +1,69 @@
+## Component Overview
+
+MessageInput is a SwiftUI-based message input component that enables users to compose and send a variety of message types, including text, images, videos, files, and voice messages. It features an integrated emoji picker, supports multiple style configurations, and offers extensive customization options.
+| <strong>Message Input Interface</strong> | <strong>Emoji Picker</strong> |
+| --- | --- |
+|  |  |
+
+## Component Integration
+
+MessageInput is included in TUIKit SwiftUI. To use MessageInput, integrate TUIKit SwiftUI into your project. For detailed integration steps, see the [TUIKit SwiftUI documentation](https://www.tencentcloud.com/document/product/1047/77460).
+
+## Component Structure
+
+MessageInput consists of the main input component and a style configuration protocol, providing message input capabilities and supporting customization.
+
+#### Initialization Parameters
+
+|Parameter|Type|Description|
+|---------|---------|---------|
+|`conversationID`|`String`|Conversation ID used to identify the current chat session|
+|`config`|`MessageInputConfigProtocol`|Input style configuration that controls which function buttons are displayed|
+
+#### Public API
+
+|Method|Parameters|Description|
+|---------|---------|---------|
+|`init`|`conversationID: String, config: MessageInputConfigProtocol`|Initializes the message input component|
+
+## Basic Usage
+
+To get started, initialize the MessageInput component with a conversation ID:
+``` swift
+import AtomicX
+import SwiftUI
+
+struct ChatView: View {
+    var body: some View {
+        VStack {
+            Spacer()
+
+            MessageInput(
+                conversationID: "conversation_123"
+            )
+        }
+    }
+}
+```
+
+## Customization
+
+You can control which feature buttons appear on the input bar:
+``` swift
+// Customize the displayed function buttons
+MessageInput(
+    text: $inputText,
+    conversationID: conversationID,
+    config: ChatMessageInputConfig(
+        isShowAudioRecorder: false,  // Hide audio recording
+        isShowPhotoTaker: true,      // Show photo capture
+        isShowMore: true,            // Show "More" options
+        isShowSendButton: true       // Show send button
+    )
+)
+```
+
+The following images show different customization effects:
+| <strong>Default Input Box</strong> | <strong>Input Box with Audio Recording Hidden</strong> | <strong>Input Box with All Features Hidden</strong> |
+| --- | --- | --- |
+|  |  |  |

package/resource/knowledge/chat/preset/ios/features/message-list.md

@@ -0,0 +1,162 @@
+## Component Overview
+
+MessageList is a SwiftUI-based component designed for displaying and managing chat messages. It supports a wide range of message types and offers flexible customization options:
+- Supported message types: text, image, video, audio, file, system notification, emoji, and more.
+
+- Message actions: Includes long-press menu actions such as copy, delete, recall, and custom actions.
+
+- Highly customizable: Configure styles like bubble color, corner radius, font, and add custom action items.
+
+| <strong>Chat Message List</strong> | <strong>Message Long-Press Menu</strong> |
+| --- | --- |
+|  |  |
+
+## Component Integration
+
+MessageList is part of TUIKit SwiftUI. To use MessageList, first integrate TUIKit SwiftUI. For detailed integration steps, see the [TUIKit SwiftUI documentation](https://www.tencentcloud.com/document/product/1047/77460).
+
+## Component Structure
+
+MessageList exposes only its initialization method; all other logic is encapsulated within the component.
+
+#### Public Methods
+| Method | Parameters | Description |
+| --- | --- | --- |
+| <code>init</code> | <code>conversationID: String</code> | Initializes the component and sets the conversation ID. |
+| <code>config: MessageListConfigProtocol & MessageActionConfigProtocol = ChatMessageListConfig()</code> | Initializes the component and sets the message list style. |  |
+| <code>locateMessage: MessageInfo? = nil</code> | Initializes the component and sets the located message. Typically used when navigating from the message search results page to the message page and locating the target message. |  |
+| <code>onUserClick: ((String) -> Void)? = nil</code> | Initializes the component and sets the event handler for clicking on the user avatar. |  |
+| <code>customActions: [MessageCustomAction] = []</code> | Initializes the component and sets custom message menu options. |  |
+
+## Basic Usage
+
+Initialize the MessageList component directly with a conversation ID. For best results, implement the onUserClick handler during initialization.
+``` swift
+import AtomicX
+import SwiftUI
+
+struct ContentView: View {
+    var body: some View {
+        MessageList(
+            conversationID: "conversation_123",
+            onUserClick: { userID in
+                // Handle user avatar click event
+            }
+        )
+    }
+}
+```
+
+## Customization
+
+You can customize both the style and actions of the message list using the following methods.
+
+#### Custom Styles
+
+Implement the `MessageListConfigProtocol` protocol to define a custom style:
+``` swift
+struct MyCustomConfig: MessageListConfigProtocol & MessageActionConfigProtocol {
+    let alignment: Int = 0
+    let isShowTimeMessage: Bool = true
+    let isShowLeftAvatar: Bool = true
+    let isShowLeftNickname: Bool = true
+    let isShowRightAvatar: Bool = true
+    let isShowRightNickname: Bool = true
+    let isSupportCopy: Bool = false
+    // ... other properties
+}
+
+// Apply custom style
+MessageList(
+    conversationID: "conversation_123",
+    config: MyCustomConfig()
+)
+```
+
+`MessageListConfigProtocol` Property Descriptions:
+| Property | Type | Description | Remarks |
+| --- | --- | --- | --- |
+| <code>alignment</code> | <code>Int</code> | Message alignment | - 1: Left align.<br>- 2: Right align.<br>- 3: Both sides align. |
+| <code>isShowTimeMessage</code> | <code>Bool</code> | Show time message | Controls whether to display message timestamps. |
+| <code>isShowLeftAvatar</code> | <code>Bool</code> | Show left avatar | Controls whether to display sender avatar for received messages. |
+| <code>isShowLeftNickname</code> | <code>Bool</code> | Show left nickname | Controls whether to display sender nickname for received messages. |
+| <code>isShowRightAvatar</code> | <code>Bool</code> | Show right avatar | Controls whether to display your own avatar for sent messages. |
+| <code>isShowRightNickname</code> | <code>Bool</code> | Show right nickname | Controls whether to display your own nickname for sent messages. |
+| <code>isShowTimeInBubble</code> | <code>Bool</code> | Show time inside bubble | Controls whether the timestamp is displayed inside the message bubble. |
+| <code>cellSpacing</code> | <code>CGFloat</code> | Message spacing | Controls the spacing between adjacent messages. |
+| <code>isShowSystemMessage</code> | <code>Bool</code> | Show system notification | Controls whether to display system notification messages. |
+| <code>isShowUnsupportMessage</code> | <code>Bool</code> | Show unsupported messages | Controls whether to display unsupported message types. |
+| <code>horizontalPadding</code> | <code>CGFloat</code> | Horizontal padding | Controls the left and right padding of the message list. |
+| <code>avatarSpacing</code> | <code>CGFloat</code> | Avatar spacing | Controls the spacing between the avatar and message content. |
+
+`MessageActionConfigProtocol` Property Descriptions:
+| Property Name | Type | Description |
+| --- | --- | --- |
+| <code>isSupportCopy</code> | <code>Bool</code> | Whether to enable copy function in the message action menu:<br>- <code>true</code>: Display the copy action.<br>- <code>false</code>: Do not display the copy action. |
+| <code>isSupportDelete</code> | <code>Bool</code> | Whether to enable the delete function in the message action menu:<br>- <code>true</code>: Display the delete action.<br>- <code>false</code>: Do not display the delete action. |
+| <code>isSupportRecall</code> | <code>Bool</code> | Whether to enable the recall function in the message action menu:<br>- <code>true</code>: Display the recall action.<br>- <code>false</code>: Do not display the recall action. |
+
+### Custom Actions
+
+You can customize the long-press message menu items using several approaches.
+
+#### Method 1. Show Action Items Locally
+
+Set `isSupportCopy`, `isSupportDelete`, and `isSupportRecall` in the config when initializing MessageList to control which actions are shown:
+``` swift
+struct CustomMessageView: View {
+    var body: some View {
+        MessageList(
+            conversationID: "conversation_123",
+            config: ChatMessageListConfig(isSupportCopy: false)
+        )
+    }
+}
+```
+
+#### Method 2. Add Custom Action Items Locally
+
+Pass `customActions` when initializing MessageList. Your custom actions will be appended to the default action list:
+``` swift
+struct CustomMessageView: View {
+    var body: some View {
+        MessageList(
+            conversationID: "conversation_123",
+            // Add custom action
+            customActions: [
+                MessageCustomAction(title: "Share", iconName: "forward_icon_figma", systemIconFallback: "square.and.arrow.up") { _ in
+                    print("share Message")
+                }
+            ]
+        )
+    }
+}
+```
+
+#### Method 3. Configure Action Items Globally
+
+Set global configuration using `AppBuilderConfig`:
+``` swift
+// Configure at app launch
+AppBuilderConfig.shared.messageActionList = [
+    .copy,      // Enable copy
+    .delete,    // Enable delete
+    .recall     // Enable recall
+]
+
+// Then initialize MessageList; all MessageList instances will use this configuration
+MessageList(
+    conversationID: "conversation_123"
+)
+```
+
+> **Note：**
+>
+
+> Local configuration overrides global configuration.
+>
+
+The following images show the customization effects:
+| <strong>Message List Actions</strong><br><strong> (Default Options)</strong> | <strong>Message List Actions </strong><br><strong>(Hide Copy Option)</strong> | <strong>Message List Actions </strong><br><strong>(Add Share Option)</strong> |
+| --- | --- | --- |
+|  |  |  |

package/resource/knowledge/chat/preset/ios/features/search.md

@@ -0,0 +1,93 @@
+## Component Overview
+
+Search is a search component that provides users with a complete set of features, including a search box, search result display, and interface navigation. This component supports user search, group search, and message search, and offers a comprehensive set of interactive webhook interfaces.
+
+> **Note：**
+>
+
+> Search function is available only in the Pro Edition or Enterprise Edition. You can use this feature after purchasing the Pro Edition or Enterprise Edition package. For details, see [Pricing Information](https://trtc.io/document/67650).
+>
+
+| <strong>Search Entry</strong> | <strong>Search Results</strong> |
+| --- | --- |
+|  |  |
+
+## Component Integration
+
+The Search component is included in TUIKit SwiftUI. To use the Search component, integrate TUIKit SwiftUI into your project. For detailed integration steps, refer to the [TUIKit SwiftUI](https://www.tencentcloud.com/document/product/1047/77460) documentation and complete the login process.
+
+## Component Structure
+
+`SearchBar` serves as the entry point for search functionality. Only the initialization method of the search component is exposed externally; all other logic is encapsulated within `SearchBar`.
+
+|Method|Parameter|Description|
+|---------|---------|---------|
+|`init`|`onTapItem: @escaping (Any) -> Void`|Webhook triggered when a search result is clicked, including friend, group, message, and conversation result items.|
+
+## Basic Usage
+
+The routing and navigation logic for `SearchBar` search results is as follows:
+- **Automatic Routing:** On the search results page, clicking the More button or the chat history list will automatically navigate to the corresponding page using the internal Navigator.
+
+- **Custom Routing:** When a user clicks a specific contact, group, conversation, or message, the component triggers the `onTapItem: @escaping (Any) -> Void` webhook. Implement your custom navigation logic in this webhook (for example, navigating to your custom chat interface).
+
+   Example code:
+
+   ``` java
+   // Initialize SearchBar
+   SearchBar(onTapItem: { result in
+       handleSearchResult(result)
+   })
+
+   // Handle click events on search results
+   // The onConversationClick event is dispatched to a higher-level component. This is optional and can be adapted based on your project architecture.
+   private func handleSearchResult(_ result: Any) {
+       if let friendInfo = result as? FriendSearchInfo {
+           // Handle selection of a contact from search results
+           let conversationID = ChatUtil.getC2CConversationID(friendInfo.userID)
+           var conversation = ConversationInfo(conversationID: conversationID)
+           conversation.type = .c2c
+           conversation.title = friendInfo.friendRemark ?? friendInfo.userInfo.nickname
+           conversation.avatarURL = friendInfo.userInfo.avatarURL
+           // Dispatch event to the parent component to navigate to the C2C Chat list
+           onConversationClick?(NavigationInfo(conversation: conversation))
+       } else if let groupInfo = result as? GroupSearchInfo {
+           // Handle selection of a group from search results
+           let conversationID = ChatUtil.getGroupConversationID(groupInfo.groupID)
+           var conversation = ConversationInfo(conversationID: conversationID)
+           conversation.type = .group
+           conversation.title = groupInfo.groupName
+           conversation.avatarURL = groupInfo.groupAvatarURL
+           // Dispatch event to the parent component to navigate to the Group chat list
+           onConversationClick?(NavigationInfo(conversation: conversation))
+       } else if let messageDict = result as? [String: Any],
+                 let messageInfo = messageDict["message"] as? MessageInfo,
+                 let conversationID = messageDict["conversationID"] as? String
+       {
+           // Handle selection of a message result
+           var conversation = ConversationInfo(conversationID: conversationID)
+           if conversationID.hasPrefix("c2c_") {
+               conversation.type = .c2c
+           } else {
+               conversation.type = .group
+           }
+           conversation.title = messageDict["conversationName"] as? String
+           conversation.avatarURL = messageDict["conversationAvatar"] as? String
+           // Dispatch event to the parent component to navigate to the conversation and highlight the selected message
+           onConversationClick?(NavigationInfo(conversation: conversation, locateMessage: messageInfo))
+       } else if let conversationDict = result as? [String: Any],
+                 let conversationID = conversationDict["conversationID"] as? String {
+           // Handle selection of a conversation result
+           var conversation = ConversationInfo(conversationID: conversationID)
+           if conversationID.hasPrefix("c2c_") {
+               conversation.type = .c2c
+           } else {
+               conversation.type = .group
+           }
+           conversation.title = conversationDict["conversationName"] as? String
+           conversation.avatarURL = conversationDict["conversationAvatar"] as? String
+           // Dispatch event to the parent component to navigate to the conversation
+           onConversationClick?(NavigationInfo(conversation: conversation))
+       }
+   }
+   ```