TIMUIKitChatController

Introduction

The controller of the chat module.

Parameter introduction

loadHistoryMessageList

• Parameter type : Future< bool > Function({HistoryMsgGetTypeEnum getType, String? userID, String? groupID, int lastMsgSeq, required int count, String? lastMsgID})

• Supported Platform: All

• Parameter description : Load the history message list.

clearHistory

• Parameter type : void Function([String? convID])

• Supported Platform: All

• Parameter description : Clear the history message.

refreshCurrentHistoryList

• Parameter type : Future< bool > Function([String? convID, ConvType? convType])

• Supported Platform: All

• Parameter description : Refresh the history message list.

updateMessage

• Parameter type : Future< void > Function({String? convID, ConvType? convType, required String msgID})

• Supported Platform: All

• Parameter description : Update the UI of a specific message.

sendMessage

• Parameter type : Future< V2TimValueCallback < V2TimMessage >? >? Function({required V2TimMessage? messageInfo, ConvType? convType, String? userID, String? groupID, ValueChanged< String >? setInputField, OfflinePushInfo? offlinePushInfo, bool isNavigateToMessageListBottom = true, MessagePriorityEnum priority = MessagePriorityEnum.V2TIM_PRIORITY_NORMAL,bool? onlineUserOnly, bool? isExcludedFromUnreadCount, bool? needReadReceipt, String? cloudCustomData, String? localCustomData,})

• Supported Platform: All

• Parameter description : Sends a message to the specified conversation, or to the current conversation specified on TIMUIKitChat. You must provide convType and either userID or groupID, only if you use TIMUIKitChat without specifying a TIMUIKitChatController, you must provide these parameters. Please refer to the parameter annotations in this method for a detailed understanding of its usage.

sendForwardMessage

• Parameter type : Future< void > Function({required List< V2TimConversation > conversationList})

• Supported Platform: All

• Parameter description : Send forward message.

sendMergerMessage

• Parameter type : Future< V2TimValueCallback < V2TimMessage >? > Function({required List< V2TimConversation > conversationList, required String title, required List< String > abstractList, required BuildContext context})

• Supported Platform: All

• Parameter description : Send merger message.

setLocalCustomData

• Parameter type : Future< bool > Function(String msgID, String localCustomData, [String? convID])

• Supported Platform: All

• Parameter description : Add the extra local custom data to the message.

setLocalCustomInt

• Parameter type : Future< bool > Function(String msgID, int localCustomInt, [String? convID])

• Supported Platform: All

• Parameter description : Add the extra local custom data,in int, to the message.

getCurrentConversation

• Parameter type : String Function()

• Supported Platform: All

• Parameter description : Get the current conversation ID.

hideAllBottomPanelOnMobile

• Parameter type : String Function()

• Supported Platform: Mobile

• Parameter description : Hide all bottom panels, including the sticker panel and the additional functions panel, on mobile devices. This function solely works when TIMUIKitChatController is specified for use within a TIMUIKitChat.

mentionOtherMemberInGroup

• Parameter type : String Function({required String showNameInMessage, required String userID})

• Supported Platform: All

• Parameter description : Mention or @ other members in a group manually. This function solely works when TIMUIKitChatController is specified for use within a TIMUIKitChat.

setInputTextField

• Parameter type : String Function(String text))

• Supported Platform: All

• Parameter description : Set the content within the message input text field. This function solely works when TIMUIKitChatController is specified for use within a TIMUIKitChat.

getGroupMemberList

• Parameter type : String Function({String? keyword})

• Supported Platform: All

• Parameter description : Returns the list of group members of current group chat based on the provided keyword. This method filters the group members based on the given keyword. If the keyword is not provided, it returns the entire list of group members. The filtering is performed by checking if the keyword is contained within the userID, nickName, or friendRemark properties of each group member. [keyword] (optional) - The keyword to filter the group members. If not provided, the entire list of group members is returned. This function solely works when TIMUIKitChatController is specified for use within a TIMUIKitChat.