@tencentcloud/sdk-mcp 1.0.3 → 1.0.4

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

@@ -0,0 +1,526 @@
+## 全局设置
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >API</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[switchLanguage](https://write.woa.com/document/159689293664858112)</td>
+
+<td rowspan="1" colSpan="1" >设置界面语言。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[switchTheme](https://write.woa.com/document/159689293664858112)</td>
+
+<td rowspan="1" colSpan="1" >设置界面主题。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[enableToast](https://write.woa.com/document/159689293664858112)</td>
+
+<td rowspan="1" colSpan="1" >开启默认 toast 提示。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setAvatarStyle](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置头像风格（圆形、方形）。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setAvatarCornerRadius](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置头像圆角半径。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[enableGroupGridAvatar](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置群头像九宫格展示。</td>
+</tr>
+</table>
+
+
+## 聊天界面设置接口
+
+### 功能设置接口
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >API</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[enableTypingIndicator](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >开启“正在输入”状态指示。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[isMessageReadReceiptNeeded](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >开启消息已读回执。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[hideItemsWhenLongPressMessage](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >隐藏长按消息菜单中的指定按钮。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[hideVideoCallButton](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >隐藏视频通话按钮。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[hideAudioCallButton](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >隐藏音频通话按钮。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[enableFloatWindowForCall](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >开启音视频通话浮窗。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[enableMultiDeviceForCall](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >开启音视频通话多端登录。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setCustomTopView](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置聊天界面顶部自定义 View。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[isExcludedFromUnreadCount](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置即将发送的消息不更新会话未读数。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[isExcludedFromLastMessage](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置即将发送的消息不更新会话 lastMsg。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[timeIntervalForAllowedMessageRecall](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置消息撤回时间。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[maxAudioRecordDuration](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置语音消息最长录制时长。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[maxVideoRecordDuration](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置视频消息最长录制时长。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[enableAndroidCustomRing](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置 Android 设备收到消息时的铃声为内置的自定义铃声。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setPlayingSoundMessageViaSpeakerByDefault](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置播放语音消息时默认使用扬声器而不是听筒播放。</td>
+</tr>
+</table>
+
+
+### 消息设置接口
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >API</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setBackgroundColor](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置聊天界面消息列表背景色。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setBackgroundImage](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置聊天界面消息列表背景图片。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[sendTextMessageColor](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置发送的文本消息的文字颜色。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[sendTextMessageFont](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置发送的文本消息的文字字体。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[receiveTextMessageColor](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置接收的文本消息的文字颜色。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[receiveTextMessageFont](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置接收的文本消息的文字字体。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[systemMessageTextColor](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置系统通知消息文字的字体。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[systemMessageTextFont](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置系统通知消息文字的颜色。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[systemMessageBackgroundColor、](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置系统通知消息文字的背景色。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[enableMessageBubbleStyle](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >开启消息气泡展示。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[sendBubbleBackgroundImage](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置发送消息的气泡背景图。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[sendHighlightBubbleBackgroundImage](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置发送消息的气泡高亮背景图。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[sendAnimateLightBubbleBackgroundImage](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置发送消息的气泡闪烁高亮背景图。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[sendAnimateDarkBubbleBackgroundImage](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置发送消息的气泡闪烁暗色背景图。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[receiveBubbleBackgroundImage](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置接收消息的气泡背景图。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[receiveHighlightBubbleBackgroundImage](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置接收消息的气泡高亮背景图。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[receiveAnimateLightBubbleBackgroundImage](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置接收消息的气泡闪烁高亮背景图。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[receiveAnimateDarkBubbleBackgroundImage](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置接收消息的气泡闪烁暗色背景图。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[sendTextMessageLayout](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置发送的文本消息 layout。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[receiveTextMessageLayout](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置接收的文本消息 layout。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[sendImageMessageLayout](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置发送的图片消息 layout。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[receiveImageMessageLayout](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置接收的图片消息 layout。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[sendVoiceMessageLayout](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置发送的语音消息 layout。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[receiveVoiceMessageLayout](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置接收的语音消息 layout。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[sendVideoMessageLayout](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置发送的视频消息 layout。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[receiveVideoMessageLayout](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置接收的视频消息 layout。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[systemMessageLayout](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置系统消息 layout。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[sendMessageLayout](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置其他发送的消息 layout。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[receiveMessageLayout](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >设置其他接收的消息 layout。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[registerCustomMessage](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >注册自定义消息。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[insertLocalTipsMessage](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >在本地插入一条系统提示消息。</td>
+</tr>
+</table>
+
+
+### 输入框设置接口
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >API</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[showInputBar](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >展示聊天界面输入框。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[hideItemsInMoreMenu](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >隐藏更多菜单中的按钮（全局）。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[inputBarShouldHideItemsInMoreMenuOfModel](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >隐藏更多菜单中的按钮（局部）。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[inputBarShouldAddNewItemsToMoreMenuOfModel](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >向更多菜单添加选项（局部）。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[itemsInShortcutViewOfModel](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >向输入栏上方添加快捷视图。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[addStickerGroup](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >向表情菜单中添加表情组。</td>
+</tr>
+</table>
+
+
+### 点击事件监听
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >API</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[onUserAvatarClicked](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >用户点击了消息列表里的用户头像的事件回调。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[onUserAvatarLongPressed](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >用户长按了消息列表里的用户头像的事件回调。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[onMessageClicked](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >用户点击了消息列表里的消息的事件回调。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[onMessageLongPressed](https://write.woa.com/document/159689307246845952)</td>
+
+<td rowspan="1" colSpan="1" >用户长按了消息列表里的消息的事件回调。</td>
+</tr>
+</table>
+
+
+## 会话列表设置接口
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >API</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[listBackgroundColor](https://write.woa.com/document/159689315970609152)</td>
+
+<td rowspan="1" colSpan="1" >会话列表背景色。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[cellBackgroundColor](https://write.woa.com/document/159689315970609152)</td>
+
+<td rowspan="1" colSpan="1" >会话 cell 背景色。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[pinnedCellBackgroundColor](https://write.woa.com/document/159689315970609152)</td>
+
+<td rowspan="1" colSpan="1" >会话置顶 cell 背景色。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[cellTitleLabelFont](https://write.woa.com/document/159689315970609152)</td>
+
+<td rowspan="1" colSpan="1" >会话列表 cell 上的标题字体。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[cellSubtitleLabelFont](https://write.woa.com/document/159689315970609152)</td>
+
+<td rowspan="1" colSpan="1" >会话列表 cell 上的副标题字体。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[cellTimeLabelFont](https://write.woa.com/document/159689315970609152)</td>
+
+<td rowspan="1" colSpan="1" >会话列表 cell 上的时间文字的字体。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[showCellUnreadCount](https://write.woa.com/document/159689315970609152)</td>
+
+<td rowspan="1" colSpan="1" >展示 cell 上的未读消息红点 icon。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[showUserOnlineStatusIcon](https://write.woa.com/document/159689315970609152)</td>
+
+<td rowspan="1" colSpan="1" >展示 cell 里用户头像上的在线状态 icon。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[conversationShouldHideItemsInMoreMenu](https://write.woa.com/document/159689315970609152)</td>
+
+<td rowspan="1" colSpan="1" >隐藏会话更多菜单选项。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[conversationShouldAddNewItemsToMoreMenu](https://write.woa.com/document/159689315970609152)</td>
+
+<td rowspan="1" colSpan="1" >向会话更多菜单添加选项。</td>
+</tr>
+</table>
+
+
+## 群组设置接口
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >API</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[hideItemsInGroupConfig](https://write.woa.com/document/159689321391304704)</td>
+
+<td rowspan="1" colSpan="1" >隐藏群组设置选项。</td>
+</tr>
+</table>
+
+
+## 联系人设置接口
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >API</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[hideItemsInContactConfig](https://write.woa.com/document/159689335596978176)</td>
+
+<td rowspan="1" colSpan="1" >隐藏联系人设置选项。</td>
+</tr>
+</table>
+
+