CometChatMessageListController class

CometChatMessageListController is the view model for CometChatMessageList it contains all the business logic involved in changing the state of the UI of CometChatMessageList

Inheritance
Implemented types
Mixed-in types

Constructors

CometChatMessageListController({required MessagesBuilderProtocol messagesBuilderProtocol, User? user, Group? group, String? customIncomingMessageSound, String? customIncomingMessageSoundPackage, bool disableSoundForMessages = false, bool hideDeletedMessage = false, bool scrollToBottomOnNewMessage = false, ScrollController? scrollController, dynamic stateCallBack(CometChatMessageListController controller)?, dynamic onError(Exception)?, dynamic onThreadRepliesClick(BaseMessage message, BuildContext context, {Widget bubbleView})?, List<CometChatMessageTemplate>? messageTypes, bool? disableReceipt, bool? hideReceipt, CometChatTheme? theme, MessageInformationConfiguration? messageInformationConfiguration, EmojiKeyboardStyle? emojiKeyboardStyle, bool? disableReactions, List<CometChatTextFormatter>? textFormatters, bool? disableMentions})

Properties

builderProtocol ↔ BuilderProtocol
getter/setter pairinherited
context ↔ BuildContext
getter/setter pair
conversation ↔ Conversation?
getter/setter pair
conversationId ↔ String?
getter/setter pair
conversationType ↔ String
getter/setter pair
conversationWithId ↔ String
getter/setter pair
customIncomingMessageSound ↔ String?
getter/setter pair
customIncomingMessageSoundPackage ↔ String?
getter/setter pair
dateStamp ↔ String
getter/setter pair
disableMentions ↔ bool?
getter/setter pair
disableReactions → bool?
final
disableReceipt → bool?
disableReceipt controls visibility of read receipts and also disables logic executed inside onMessagesRead and onMessagesDelivered listeners
final
disableSoundForMessages ↔ bool
getter/setter pair
emojiKeyboardStyle → EmojiKeyboardStyle?
emojiKeyboardStyle is a parameter used to set the style for the emoji keyboard
final
error ↔ Exception?
getter/setter pairinherited
getter/setter pair
footerView ↔ Widget? Function(BuildContext, {Group? group, int? parentMessageId, User? user})?
footerView shown in footer view
getter/setter pair
group ↔ Group?
getter/setter pair
hasError ↔ bool
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
no setterinherited
hasMoreItems ↔ bool
getter/setter pairinherited
getter/setter pair
headerView ↔ Widget? Function(BuildContext, {Group? group, int? parentMessageId, User? user})?
headerView shown in header view
getter/setter pair
hideDeletedMessage ↔ bool
getter/setter pair
hideReceipt → bool?
hideReceipt controls visibility of read receipts
final
inInitialized ↔ bool
getter/setter pair
initialized → bool
Checks whether the controller has already been initialized.
no setterinherited
initialUnreadCount ↔ int?
getter/setter pair
isClosed → bool
Checks whether the controller has already been closed.
no setterinherited
isFetchNext ↔ bool
getter/setter pairinherited
isLoading ↔ bool
getter/setter pairinherited
isThread ↔ bool
getter/setter pair
lastParticipantMessage ↔ BaseMessage?
getter/setter pair
list ↔ List<BaseMessage>
getter/setter pairinherited
listeners → int
no setterinherited
loggedInUser ↔ User?
getter/setter pair
messageInformationConfiguration ↔ MessageInformationConfiguration?
getter/setter pair
messageListId ↔ Map<String, dynamic>
getter/setter pair
messageListScrollController ↔ ScrollController
getter/setter pair
messagesBuilderProtocol ↔ MessagesBuilderProtocol
getter/setter pair
messageTypes ↔ List<CometChatMessageTemplate>?
getter/setter pair
newUnreadMessageCount ↔ int
getter/setter pair
onDelete → InternalFinalCallback<void>
Internal callback that starts the cycle of this controller.
finalinherited
onError ↔ dynamic Function(Exception)?
getter/setter pairinherited
onStart → InternalFinalCallback<void>
Called at the exact moment the widget is allocated in memory. It uses an internal "callable" type, to avoid any @overrides in subclases. This method should be internal and is required to define the lifetime cycle of the subclass.
finalinherited
onThreadRepliesClick → dynamic Function(BaseMessage message, BuildContext context, {Widget bubbleView})?
final
request ↔ dynamic
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollToBottomOnNewMessage ↔ bool
getter/setter pair
searchKeyword ↔ String?
getter/setter pairinherited
stateCallBack ↔ dynamic Function(CometChatMessageListController controller)?
getter/setter pair
tag ↔ String
getter/setter pair
templateMap ↔ Map<String, CometChatMessageTemplate>
getter/setter pair
textFormatters ↔ List<CometChatTextFormatter>?
getter/setter pair
theme ↔ CometChatTheme?
getter/setter pair
threadMessageParentId ↔ int
getter/setter pair
user ↔ User?
getter/setter pair

Methods

$configureLifeCycle() → void
inherited
addElement(BaseMessage element, {int index = 0}) → dynamic
inherited
addListener(GetStateUpdate listener) → Disposer
Register a closure to be called when the object notifies its listeners.
inherited
addListenerId(Object? key, GetStateUpdate listener) → Disposer
inherited
addMessage(BaseMessage message) → dynamic
override
addReactionIconTap(BaseMessage message) → void
ccActiveChatChanged(Map<String, dynamic>? id, BaseMessage? lastMessage, User? user, Group? group, int unreadMessageCount) → void
inherited
ccCallAccepted(Call call) → void
ccCallAccepted is used to inform the listeners that a call is accepted by the logged-in user.
override
ccCallEnded(Call call) → void
ccCallEnded is used to inform the listeners that a call is ended by either the logged-in user.
override
ccCallRejected(Call call) → void
ccCallRejected is used to inform the listeners that a call is rejected by the logged-in user.
override
ccComposeMessage(String text, MessageEditStatus status) → void
inherited
ccGroupCreated(Group group) → void
This will get triggered when a group is created successfully
inherited
ccGroupDeleted(Group group) → void
This will get triggered when a group is deleted successfully
inherited
ccGroupLeft(Action message, User leftUser, Group leftGroup) → void
This will get triggered when logged in user leaves the group
inherited
ccGroupMemberAdded(List<Action> messages, List<User> usersAdded, Group groupAddedIn, User addedBy) → void
This will get triggered when a member is added by logged in user
override
ccGroupMemberBanned(Action message, User bannedUser, User bannedBy, Group bannedFrom) → void
This will get triggered when group member is banned from the group by logged in user
override
ccGroupMemberJoined(User joinedUser, Group joinedGroup) → void
This will get triggered when logged in user is joined successfully
inherited
ccGroupMemberKicked(Action message, User kickedUser, User kickedBy, Group kickedFrom) → void
This will get triggered when group member is kicked from the group by logged in user
override
ccGroupMemberScopeChanged(Action message, User updatedUser, String scopeChangedTo, String scopeChangedFrom, Group group) → void
This will get triggered when group member's scope is changed by logged in user
override
ccGroupMemberUnbanned(Action message, User unbannedUser, User unbannedBy, Group unbannedFrom) → void
This will get triggered when a banned group member is unbanned from group by logged in user
override
ccLiveReaction(String reaction) → void
inherited
ccMessageDeleted(BaseMessage message, EventStatus messageStatus) → void
override
ccMessageEdited(BaseMessage message, MessageEditStatus status) → void
override
ccMessageForwarded(BaseMessage message, List<User>? usersSent, List<Group>? groupsSent, MessageStatus status) → void
inherited
ccMessageRead(BaseMessage message) → void
inherited
ccMessageSent(BaseMessage message, MessageStatus messageStatus) → void
override
ccOutgoingCall(Call call) → void
ccOutgoingCall is used to inform the listeners that an outgoing call is initiated by the logged-in user.
override
ccOwnershipChanged(Group group, GroupMember newOwner) → void
This will get triggered when ownership is changed by logged in user
inherited
checkBubbleContent(BaseMessage messageObject, ChatAlignment alignment) → BubbleContentVerifier
createMessage(BaseMessage copyFromMessage, User? user, Group? group) → dynamic
createTemplateMap() → dynamic
deleteMessage(BaseMessage message) → dynamic
override
dispose() → void
inherited
disposeId(Object id) → void
To dispose an id from future updates(), this ids are registered by GetBuilder() or similar, so is a way to unlink the state change with the Widget from the Controller.
inherited
getActionFunction(String id) → dynamic Function(BaseMessage message, CometChatMessageListControllerProtocol state)?
getConversationId() → String
override
getCurrentContext() → BuildContext
override
getGroup() → Group?
override
getKey(BaseMessage element) → int
override
getList() → List<BaseMessage>
inherited
getMatchingIndex(BaseMessage element) → int
inherited
getMatchingIndexFromKey(String key) → int
inherited
getParentMessageId() → int?
override
getScrollController() → ScrollController
override
getTemplateMap() → Map<String, CometChatMessageTemplate>
override
getTextFormatters(BaseMessage message, CometChatTheme theme) → List<CometChatTextFormatter>
getUnreadCount() → Future<void>
getUser() → User?
override
handleReactionPress(BaseMessage message, String? reaction, List<ReactionCount> reactionList) → dynamic
hidePanel(Map<String, dynamic>? id, CustomUIPosition uiPosition) → void
override
initializeHeaderAndFooterView() → dynamic
override
initializeTextFormatters() → void
isForThisWidget(Map<String, dynamic>? id) → bool
loadMoreElements({bool isIncluded(BaseMessage element)?}) → dynamic
override
markAsRead(BaseMessage message) → dynamic
match(BaseMessage elementA, BaseMessage elementB) → bool
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyChildrens() → void
inherited
onAiFeatureTapped(User? user, Group? group) → void
inherited
onCallEndedMessageReceived(Call call) → void
override
onCardMessageReceived(CardMessage cardMessage) → void
override
onClose() → void
Called before onDelete method. onClose might be used to dispose resources used by the controller. Like closing events, or streams before the controller is destroyed. Or dispose objects that can potentially create some memory leaks, like TextEditingControllers, AnimationControllers. Might be useful as well to persist some data on disk.
override
onConnected() → void
override
onConnecting() → void
inherited
onConnectionError(CometChatException error) → void
inherited
onCustomInteractiveMessageReceived(CustomInteractiveMessage customInteractiveMessage) → void
override
onCustomMessageReceived(CustomMessage customMessage) → void
override
onDisconnected() → void
inherited
onFeatureThrottled() → void
inherited
onFormMessageReceived(FormMessage formMessage) → void
override
onGroupMemberBanned(Action action, User bannedUser, User bannedBy, Group bannedFrom) → void
override
onGroupMemberJoined(Action action, User joinedUser, Group joinedGroup) → void
override
onGroupMemberKicked(Action action, User kickedUser, User kickedBy, Group kickedFrom) → void
override
onGroupMemberLeft(Action action, User leftUser, Group leftGroup) → void
override
onGroupMemberScopeChanged(Action action, User updatedBy, User updatedUser, String scopeChangedTo, String scopeChangedFrom, Group group) → void
override
onGroupMemberUnbanned(Action action, User unbannedUser, User unbannedBy, Group unbannedFrom) → void
override
onIncomingCallCancelled(Call call) → void
override
onIncomingCallReceived(Call call) → void
override
onInit() → void
Called immediately after the widget is allocated in memory. You might use this to initialize something for the controller.
override
onInteractionGoalCompleted(InteractionReceipt receipt) → void
override
onMediaMessageReceived(MediaMessage mediaMessage) → void
override
onMemberAddedToGroup(Action action, User addedby, User userAdded, Group addedTo) → void
override
onMessageDeleted(BaseMessage message) → void
override
onMessageEdited(BaseMessage message) → void
override
onMessageReactionAdded(ReactionEvent reactionEvent) → void
onMessageReactionAdded is called when a reaction is added to a message
override
onMessageReactionRemoved(ReactionEvent reactionEvent) → void
onMessageReactionRemoved is called when a reaction is removed from a message
override
onMessagesDelivered(MessageReceipt messageReceipt) → void
override
onMessagesDeliveredToAll(MessageReceipt messageReceipt) → void
override
onMessagesRead(MessageReceipt messageReceipt) → void
override
onMessagesReadByAll(MessageReceipt messageReceipt) → void
override
onOutgoingCallAccepted(Call call) → void
override
onOutgoingCallRejected(Call call) → void
override
onReactionTap(BaseMessage message, String? reaction) → void
onReady() → void
Called 1 frame after onInit(). It is the perfect place to enter navigation events, like snackbar, dialogs, or a new route, or async request.
inherited
onSchedulerMessageReceived(SchedulerMessage schedulerMessage) → void
override
onSearch(String val) → dynamic
inherited
onTextMessageReceived(TextMessage textMessage) → void
override
onTransientMessageReceived(TransientMessage message) → void
inherited
onTypingEnded(TypingIndicator typingIndicator) → void
inherited
onTypingStarted(TypingIndicator typingIndicator) → void
inherited
openChat(User? user, Group? group) → void
inherited
refresh() → void
inherited
refreshGroup(Object id) → void
inherited
removeElement(BaseMessage element) → dynamic
inherited
removeElementAt(int index) → dynamic
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that the object notifies.
inherited
removeListenerId(Object id, VoidCallback listener) → void
inherited
showPanel(Map<String, dynamic>? id, CustomUIPosition uiPosition, WidgetBuilder child) → void
override
toString() → String
A string representation of this object.
inherited
update([List<Object>? ids, bool condition = true]) → void
Rebuilds GetBuilder each time you call update(); Can take a List of ids, that will only update the matching GetBuilder( id: ), ids can be reused among GetBuilders like group tags. The update will only notify the Widgets, if condition is true.
inherited
updateElement(BaseMessage element, {int? index}) → dynamic
inherited
updateElementAt(BaseMessage element, int index) → dynamic
inherited
updateMessageThreadCount(int parentMessageId) → dynamic
override
updateMessageWithMuid(BaseMessage message) → dynamic
override
updateReactionsOnMessage(BaseMessage message, String reaction, bool add) → BaseMessage

Operators

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

Static Properties

counter ↔ int
getter/setter pair