@tencent-rtc/mcp 1.0.1 → 1.0.2

package/resource/doc/chatuikit/iOS/quick_start_iOS.md

@@ -0,0 +1,163 @@
+This document will guide you through integrating TUIKit and successfully sending your first message.
+
+## Environment Requirements
+- Xcode 10 or later
+
+- iOS 9.0 or later
+
+
+## Create an Application
+
+Before integrating TUIKit, you need to create a Chat application in the console. The steps are as follows:
+1. Register a console account.
+
+2. Go to `Applications`, click `Create Application`, and an application information input box will pop up.
+
+3. Fill in the application name, select the product as Chat, and choose an appropriate region.
+
+
+   After the operation is complete, you will see the application you just created in the `My Applications` list.
+   
+
+   > **Note:**
+   > 
+
+   > Note down the SDKAppID of this application, as it will be used in subsequent steps. Also, keep the SDKSecretKey strictly confidential and do not disclose it to irrelevant personnel.
+   > 
+
+
+   The steps are illustrated as follows:
+
+   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027639409/0ff0f1b5142511ef83b95254002977b6.png)
+
+
+## Create User Accounts
+
+Creating an application only ensures you can initialize the SDK normally. To successfully send messages, you also need to create a user account in the application. There are many ways to create an account, such as directly creating it in the console or registering via API on the client. You may choose any method that suits you best.
+
+> **Note:**
+> 
+
+> Sending messages involves at least two users, so at this step, you need to create at least two accounts. Note down the userID of these two accounts for subsequent steps.
+> 
+
+
+If you need to create an account in the console, follow these steps:
+1. Click to enter the application you created above, and you will see the Chat on the left sidebar. Click to enter.
+
+2. On the Chat submenu, click `Users` to go to the Account Management page.
+
+3. Click `Create account`, and an account creation dialog box will pop up. It is recommended to select `General` for a regular member. Although `Nickname` is not required, we still recommend setting it. If `userID` is not displayed on the UI, you can identify different users through `Nickname`.
+
+
+   The details are as follows:
+
+   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027639409/0fd9f952142511efa09b525400762795.png)
+
+
+   If you need to register through the client, no additional operations are needed. You just need to input a new `userID` in the section "Log In to TUIKit" below, and TUIKit will automatically register that `userID` for you.
+
+
+## Install TUIKit
+
+The feature of sending messages in chat interactions is implemented by `TUIChat`. You need to integrate at least `TUIChat` to properly send and receive messages. Other components, such as `TUIConversation`, `TUIContact`, and `TUIGroup`, can be integrated as needed.
+- If you need multiple UI components, you can integrate TUIKit. For details, see [Install TUIKit](https://www.tencentcloud.com/document/product/1047/50056#cocoapods-.E9.9B.86.E6.88.90).
+
+- If you only need to integrate TUIChat, see [Install TUIChat Only](https://www.tencentcloud.com/document/product/1047/60169#beaaa1f6-5555-42ca-b353-32ad98a620da).
+
+
+## Log In to TUIKit
+
+TUILogin provides an API to log in to TUIKit, as follows:
+``` objectivec
+// API location: TUICore/TUILogin.h
++ (void)login:(int)sdkAppID userID:(NSString *)userID userSig:(NSString *)userSig succ:(__nullable TSucc)succ fail:(__nullable TFail)fail;
+```
+
+This API requires three parameters:
+- sdkAppID, the new application's SDKAppID, which was obtained in the previous steps.
+
+- userID, user1's userID, which was obtained in the previous steps. Note that it is not the user's nickname.
+
+- userSig, user1's userSig, which can be generated in real time using the development tools provided by the console. The path is: Homepage > Development Tools > UserSig Tools > Signature (UserSig) Generator, as shown below:
+
+   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027639409/0fefcdc8142511efa09b525400762795.png)
+
+
+## Navigate to Chat Interface
+
+To send messages, the next step is:
+1. Use one of the previously registered accounts (hereinafter referred to as user1) to log in to TUIKit, and then user1 is online.
+
+2. User1 sends a message to another account (hereinafter referred to as user2). User2 does not need to log in and does not need to have any friend relationship with user1.
+   
+
+   > **Note:**
+   > 
+
+   > The following steps explain how to send a message to user2 after logging in as user1. If you wish for user1 and user2 to interact via chat, you need to use the same steps to log in as user2 and enter the chat interface with user1.
+   > 
+
+
+   You can jump to the chat interface in the callback of user1's successful login, and then you can send a message to user2.
+
+
+   The sample code is as follows, where userID needs to be user2's id.
+
+
+   
+
+
+【Swift】
+``` swift
+// Pass userID for 1v1 conversation.
+func pushToChatViewController(groupID: String?, userID: String?) {
+    // Create conversationData.
+    let conversationData = TUIChatConversationModel()
+    conversationData.userID = userID
+    
+    // Create c2c chatVC.
+    let chatVC = TUIC2CChatViewController_Minimalist()
+    chatVC.conversationData = conversationData
+    
+    // Option 1: navigate to chatVC.
+    navigationController?.pushViewController(chatVC, animated: true)
+    // Option 2: add chatVC as a childVC to your parent VC.
+    // addChild(chatVC)
+    // view.addSubview(chatVC.view)
+}
+```
+
+
+【Objective-C】
+``` objectivec
+// Pass userID for 1v1 conversation.
+- (void)pushToChatViewController:(NSString *)groupID userID:(NSString *)userID {
+    // Create conversationData.
+    TUIChatConversationModel *conversationData = [[TUIChatConversationModel alloc] init];
+    conversationData.userID = userID;
+    
+    // Create c2c chatVC.
+    TUIBaseChatViewController_Minimalist *chatVC = [[TUIC2CChatViewController_Minimalist alloc] init];
+    chatVC.conversationData = conversationData;
+    
+    // Option 1: navigate to chatVC.
+    [self.navigationController pushViewController:chatVC animated:YES];
+    // Option 2: add chatVC as a childVC to your parent VC.
+    // [self addChildViewController:vc];
+    // [self.view addSubview:vc.view];
+}
+```
+
+
+## Send Your First Message
+
+After completing the previous steps, you can jump to the following chat interface. Click the input box to send your first message:
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027639409/cea1842b2c8c11ef9130525400bf8054.png)
+
+
+## Contact Us
+
+If you have any questions about this article, feel free to join the [Telegram Technical Group](https://t.me/+EPk6TMZEZMM5OGY1), where you will receive reliable technical support.
+

package/resource/doc/chatuikit/iOS/show_typing_iOS.md

@@ -0,0 +1,52 @@
+## Description
+
+TUIKit supports showing "Typing..." in a one-to-one chat in the classic UI starting from version [6.5.2803](https://www.tencentcloud.com/zh/document/product/1047/34282#6.5.2803-.402022.07.15---.E5.A2.9E.E5.BC.BA.E7.89.88).
+
+This feature is implemented using the [Online Message](https://www.tencentcloud.com/zh/document/product/1047/48019) capability of Chat SDK.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Enabling "Typing..."</td>
+
+<td rowspan="1" colSpan="1" >Disabling "Typing..."</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027325838/2ab1cf48dc7811eebb01525400b5f95f.jpeg)</td>
+
+<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027325838/2ae9b494dc7811eebb01525400b5f95f.jpeg)</td>
+</tr>
+</table>
+
+
+## Disabling "Typing..."
+
+In the `TUIChat` component, within the `TUIChatConfig` file, a switch for the "Typing" feature, named `enableTypingStatus`, is provided. Its type is BOOL, with a default value of `YES`.
+
+To disable the typing indicator feature, simply change the default value of `enableTypingStatus` to `NO`, or call the following method before initializing the chat page.
+
+
+
+
+【Swift】
+``` swift
+TUIChatConfig.shared.enableTypingStatus = true
+```
+
+
+【Objective-C】
+``` objectivec
+TUIChatConfig.defaultConfig.enableTypingStatus = NO;
+```
+
+## FAQs
+
+### Why is there no prompt for typing after the switch is turned on?
+
+The rule for showing "Typing..." in a one-to-one chat is: the other party has sent you a message within the last 30 seconds and is currently typing.
+
+## Exchange and Feedback
+
+Join the [Telegram technical exchange group](https://t.me/+1doS9AUBmndhNGNl) or [WhatsApp discussion group](https://chat.whatsapp.com/Gfbxk7rQBqc8Rz4pzzP27A), benefit from the support of professional engineers, and solve your toughest challenges.
+
+
+

package/resource/doc/chatuikit/react/generate_UserSig.md

@@ -0,0 +1,306 @@
+This document outlines two authentication methods for Chat services, with a focus on UserSig, a security signature by Tencent Cloud to safeguard against unauthorized access. For basic cloud service usage, provide SDKAppID, UserID, and UserSig during SDK initialization or login.
+- SDKAppID is used to identify your application.
+
+- UserID is used to identify your user.
+
+- UserSig is a security signature calculated based on the first two using the HMAC SHA256 encryption algorithm. As long as attackers cannot forge the UserSig, they cannot steal your cloud service traffic.
+
+
+## Obtaining a Key
+1. Log in to the [Chat console](https://console.trtc.io/chat).
+   
+
+   > **Note: **
+   > 
+
+   > If you do not have any app, [create an app](https://intl.cloud.tencent.com/document/product/1047/45914) and then perform [step 2](https://write.woa.com/#step2).
+   > 
+
+2. Click the target app card to go to its basic configuration page.
+
+3. In the **Basic Information** section, click **Display key** to the right of **Key**.
+
+   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100026631907/9da6a1d5f4df11efa823525400e889b2.png)
+
+4. Click **Copy** to copy and save the key information.
+   
+
+   > **Note: **
+   > 
+
+   >  Store the key information properly to prevent disclosure.
+   > 
+
+
+## Calculating UserSig on the Client
+
+The `GenerateTestUserSig` open-source module provided in the sample code of the Chat SDK can help you quickly generate a UserSig. You only need to configure three member variables, including SDKAPPID (SDKAppID of the app), EXPIRETIME (UserSig expiration time), and SECRETKEY (key information), and then call the genTestUserSig() function to quickly obtain a UserSig.
+
+To simplify this process, we provide the source code for computing a UserSig for the following languages and platforms. You can directly download and integrate the source code into your client.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Programing Language</td>
+
+<td rowspan="1" colSpan="1" >Platform</td>
+
+<td rowspan="1" colSpan="1" >GenerateTestUserSig Source Code</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >Java</td>
+
+<td rowspan="1" colSpan="1" >Android</td>
+
+<td rowspan="1" colSpan="1" >[GenerateTestUserSig.java](https://github.com/tencentyun/TIMSDK/blob/master/Android/Demo/app/src/main/java/com/tencent/qcloud/tim/demo/signature/GenerateTestUserSig.java)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >Objective-C</td>
+
+<td rowspan="1" colSpan="1" >iOS</td>
+
+<td rowspan="1" colSpan="1" >[GenerateTestUserSig.h](https://github.com/tencentyun/TIMSDK/blob/master/iOS/Demo/TUIKitDemo/Private/GenerateTestUserSig.h)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >Objective-C</td>
+
+<td rowspan="1" colSpan="1" >Mac</td>
+
+<td rowspan="1" colSpan="1" >[GenerateTestUserSig.h](https://github.com/tencentyun/TIMSDK/blob/master/Mac/Demo/TUIKitDemo/Debug/GenerateTestUserSig.h)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >C++</td>
+
+<td rowspan="1" colSpan="1" >Windows</td>
+
+<td rowspan="1" colSpan="1" >[GenerateTestUserSig.h](https://github.com/tencentyun/TIMSDK/blob/master/Windows/Demo/IMApp/GenerateTestUserSig.h)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >Javascript</td>
+
+<td rowspan="1" colSpan="1" >Web</td>
+
+<td rowspan="1" colSpan="1" >[GenerateTestUserSig.js](https://github.com/TencentCloud/chat-uikit-uniapp/blob/main/TUIKit/debug/GenerateTestUserSig.js)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >Dart</td>
+
+<td rowspan="1" colSpan="1" >Flutter</td>
+
+<td rowspan="1" colSpan="1" >[GenerateTestUserSig.dart](https://github.com/TencentCloud/chat-demo-flutter/blob/main/lib/utils/GenerateTestUserSig.dart )</td>
+</tr>
+</table>
+
+
+> **Note: **
+> 
+
+> In this method, the `SECRETKEY` is vulnerable to decompilation and reverse engineering. Once your `SECRETKEY` is disclosed, attackers can steal your Tencent Cloud traffic. Therefore, **this method is only suitable for locally running a demo project and feature debugging**.
+The correct way to issue a UserSig is to integrate the UserSig computing code into your server and provide app-oriented APIs. When UserSig is needed, your app will send a request to the business server to obtain a dynamic UserSig. For more information, see [How to Calculate UserSig](https://write.woa.com/#GeneratingdynamicUserSig).
+> 
+
+
+## Calculating UserSig on the Server
+
+Generating a UserSig on the server provides maximum protection against the disclosure of the key used for calculating the UserSig. You only need to deploy the code for calculating the UserSig on your server and provide an app-oriented API. When a UserSig is needed, your app will send a request to the business server to obtain a dynamic UserSig.
+To simplify this process, we provide the source code for calculating a UserSig for the following languages and platforms. You can directly download and integrate the source code into your server.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Programming Language</td>
+
+<td rowspan="1" colSpan="1" >Key Function</td>
+
+<td rowspan="1" colSpan="1" >Download URL</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >Java</td>
+
+<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[genSig](https://github.com/Tencent-RTC/tls-sig-api-v2-java/blob/main/src/main/java/com/tencentcloud/TLSSigAPIv2.java)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >GO</td>
+
+<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[GenSig](https://github.com/Tencent-RTC/tls-sig-api-v2-golang/blob/main/tencentyun/TLSSigAPI.go)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >PHP</td>
+
+<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[genSig](https://github.com/Tencent-RTC/tls-sig-api-v2-php/blob/main/src/TLSSigAPIv2.php)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >Nodejs</td>
+
+<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[genSig](https://github.com/Tencent-RTC/tls-sig-api-v2-node/blob/main/TLSSigAPIv2.js)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >Python</td>
+
+<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[gen_sig](https://github.com/Tencent-RTC/tls-sig-api-v2-python/blob/main/TLSSigAPIv2.py)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >C#</td>
+
+<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[GenSig](https://github.com/Tencent-RTC/tls-sig-api-v2-cs/blob/main/tls-sig-api-v2-cs/TLSSigAPIv2.cs)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >C++</td>
+
+<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[gen_sig](https://github.com/Tencent-RTC/tls-sig-api-v2-cpp)</td>
+</tr>
+</table>
+
+
+Key fields in a UserSig calculation function include the SDKAppID, UserID, and UserSig validity period, as described in the following table.
+
+> **Note: **
+> 
+
+> The following table uses the field names in the Java source code as an example. The field names may be different in other languages.
+> 
+
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Field Name (Example)</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >sdkappid</td>
+
+<td rowspan="1" colSpan="1" >SDKAppID of the app. You can obtain the SDKAppID on the app card in the [Chat console](https://console.trtc.io/chat).</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >userId</td>
+
+<td rowspan="1" colSpan="1" >User ID (former name: `Identifier`).</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >expire</td>
+
+<td rowspan="1" colSpan="1" >UserSig validity period, in seconds.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >userbuf</td>
+
+<td rowspan="1" colSpan="1" >This field is set to `null` by default because APIs without UserBuf are used in Chat by default.APIs with UserBuf may be required in some TRTC use cases, for example, when entering a room. For more information, see [Enabling Advanced Permission Control](https://intl.cloud.tencent.com/document/product/647/35157).</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >key</td>
+
+<td rowspan="1" colSpan="1" >Key. You can obtain a key on the app details page in the [Chat console](https://console.trtc.io/chat). For more information, see [Obtaining a Key](https://write.woa.com/#getkey).</td>
+</tr>
+</table>
+
+
+## Old Version of Algorithm
+
+To simplify signature computing so that customers can conveniently and quickly use Tencent Cloud services, the signature algorithm of the Chat service has been upgraded from ECDSA-SHA256 to HMAC-SHA256 since July 19, 2019. This means that all SDKAppIDs created after July 19, 2019 will use the new HMAC-SHA256 algorithm.
+
+If your SDKAppID was created before July 19, 2019, we recommend that you upgrade the signature algorithm to [HMAC-SHA256](https://write.woa.com/#GeneratingdynamicUserSig). The upgrade will not affect your business. Alternatively, you can still use the signature algorithm of an earlier version. The URLs for downloading the source code for the ECDSA-SHA256 algorithm are as follows:
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Programming Language</td>
+
+<td rowspan="1" colSpan="1" >Signature Algorithm</td>
+
+<td rowspan="1" colSpan="1" >Download Link</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >Java</td>
+
+<td rowspan="1" colSpan="1" >ECDSA-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-java)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >GO</td>
+
+<td rowspan="1" colSpan="1" >ECDSA-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-golang)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >PHP</td>
+
+<td rowspan="1" colSpan="1" >ECDSA-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-php)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >Nodejs</td>
+
+<td rowspan="1" colSpan="1" >ECDSA-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-node)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >Python</td>
+
+<td rowspan="1" colSpan="1" >ECDSA-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-python)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >C#</td>
+
+<td rowspan="1" colSpan="1" >ECDSA-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-cs)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >C++</td>
+
+<td rowspan="1" colSpan="1" >ECDSA-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api)</td>
+</tr>
+</table>
+
+
+## Get UserSig from the console
+- Log in to Tencent-RTC Console, navigate to Development Tools > [UserSig Tools](https://console.trtc.io/usersig).
+
+- Under the UserSig Generation Tool, select the corresponding SDKAppID and UserID.
+
+- Click the Generate button to compute the corresponding UserSig.
+
+   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100026631907/bf1ed039f4df11ef920e5254005ef0f7.png)
+
+