MessagesViewController class

消息列表控制器

Inheritance
Mixed-in types
Available extensions

Constructors

MessagesViewController({required ChatUIKitProfile profile, int pageSize = 30, dynamic searchedMsg, Future? willSendHandler(dynamic willSendMessage)?})

Properties

bottomConditions List<BottomCondition>
final
cacheMessages List<MessageModel>
getter/setter pair
canMoveToBottomPosition bool
getter/setter pair
chatType → dynamic
no setter
conversationType ↔ dynamic
会话类型, 不可修改,会根据 profile 自动设置。 详细参考 ConversationType
latefinal
hashCode int
The hash code for this object.
no setterinherited
hasListeners bool
Whether any listeners are currently registered.
no setterinherited
hasNew bool
不可修改
getter/setter pair
hasSearched bool
getter/setter pair
isDisposed bool
不可修改
getter/setter pair
isMultiSelectMode bool
getter/setter pair
lastActionType MessageLastActionType
不可修改
getter/setter pair
msgModelList List<MessageModel>
消息列表
final
pageSize int
一次获取的消息数量,默认为 30
final
pinedMessages ValueNotifier<List>
getter/setter pair
profile ChatUIKitProfile
用户信息对象,用于设置对方信息, 详细参考 ChatUIKitProfile。如果你自己设置了 MessageListViewController 需要确保 profileMessagesView 传入的 profile 一致。
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
searchedMsg ↔ dynamic
getter/setter pair
selectedMessages List
getter/setter pair
userMap Map<String, ChatUIKitProfile>
用户信息缓存,用于显示头像昵称, 不建议修改, 详细参考 ChatUIKitProfile
final
willSendHandler Future? Function(dynamic willSendMessage)?
final

Methods

addAllCacheToList() → void
addCanMoveBottomConditions(BottomCondition condition) → void

Available on MessagesViewController, provided by the MessageListViewControllerExtension extension

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
attemptSendInputType() → void
cleanBottomConditions(BottomCondition condition) → void

Available on MessagesViewController, provided by the MessageListViewControllerExtension extension

clearMentionIfNeed() → void
clearMessages() → void
deleteMessage(String messageId) Future<void>
deleteMessages({required List<String> messageIds}) Future<void>
deleteSelectedMessages() → void
disableMultiSelectMode() → void
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
override
downloadMessage(dynamic message) Future<void>
editMessage(dynamic message, String content) Future<void>
enableMultiSelectMode() → void
fetchItemList() → void
fetchPinnedMessages() Future<void>
getModelId(dynamic message) String
jumpToSearchedMessage(dynamic searchedMessage) → void
markAllMessageAsRead() Future<void>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
onChatThreadCreate(dynamic event) → void
inherited
onChatThreadDestroy(dynamic event) → void
override
onChatThreadUpdate(dynamic event) → void
override
onCmdMessagesReceived(List messages) → void
inherited
onConversationRead(String from, String to) → void
override
onConversationsUpdate() → void
inherited
onGroupMessageRead(List groupMessageAcks) → void
inherited
onMessageContentChanged(dynamic message, String operatorId, int operationTime) → void
override
onMessagePinChanged(String messageId, String conversationId, dynamic pinOperation, dynamic pinInfo) → void
override
onMessageReactionDidChange(List events) → void
override
onMessagesDelivered(List messages) → void
override
onMessageSendError(String msgId, dynamic msg, dynamic error) → void
override
onMessageSendProgress(String msgId, int progress) → void
inherited
onMessageSendSuccess(String msgId, dynamic msg) → void
override
onMessagesRead(List messages) → void
override
onMessagesRecalled(List recalled) → void
inherited
onMessagesRecalledInfo(List infos, List replaces) → void
override
onMessagesReceived(List messages) → void
override
onMessageUpdate(dynamic newMessage, [dynamic oldMessage]) → void
inherited
onMessageWillSend(dynamic msg) → void
inherited
onReadAckForGroupMessageUpdated() → void
inherited
onTyping(List<String> fromUsers) → void
inherited
onUserKickOutOfChatThread(dynamic event) → void
inherited
pinMessage(dynamic message) Future<void>
playMessage(dynamic message) → void
recallMessage(dynamic message) Future<void>
refresh() → void
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
reportMessage({required dynamic message, required String tag, required String reason}) Future<void>
resendMessage(dynamic message) Future<void>
sendCardMessage(ChatUIKitProfile cardProfile) Future<void>
sendConversationsReadAck() Future<void>
sendFileMessage(String path, {String? name, int? fileSize}) Future<void>
sendImageMessage(String path, {String? name}) Future<void>
sendMessage(dynamic message) Future<void>
sendMessageReadAck(dynamic message) → void
sendTextMessage(String text, {dynamic replay, dynamic mention}) Future<void>
sendVideoMessage(String path, {String? name, double? width, double? height, int? duration}) Future<void>
sendVoiceMessage(String path, int duration, String? displayName) Future<void>
toString() String
A string representation of this object.
inherited
translateMessage(dynamic message, {bool showTranslate = true}) Future<void>
unpinMessage(dynamic message) Future<void>
updateReaction(String messageId, String reaction, bool isAdd) Future<void>

Operators

operator ==(Object other) bool
The equality operator.
inherited