CometChatMessageHeaderController class

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

Inheritance

• Object
• GetLifeCycle
• DisposableInterface
• GetxController
• CometChatMessageHeaderController

Implemented types

• Listenable

Mixed-in types

• CometChatMessageEventListener
• UserListener
• GroupListener
• CometChatGroupEventListener

Constructors

CometChatMessageHeaderController({User? userObject, Group? groupObject, bool? disableTyping, bool? disableUserPresence})

Properties

dateStamp ↔ String

getter/setter pair

disableTyping ↔ bool?

getter/setter pair

disableUserPresence ↔ bool?

getter/setter pair

groupListenerId ↔ String

getter/setter pair

groupObject ↔ Group?

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

hasListeners → bool

no setter, inherited

initialized → bool

Checks whether the controller has already been initialized.

no setter, inherited

isClosed → bool

Checks whether the controller has already been closed.

no setter, inherited

isTyping ↔ bool?

getter/setter pair

listeners → int

no setter, inherited

membersCount ↔ int?

getter/setter pair

messageListenerId ↔ String

getter/setter pair

onDelete → InternalFinalCallback<void>

Internal callback that starts the cycle of this controller.

final, inherited

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.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

tag ↔ String

getter/setter pair

typingUser ↔ User?

getter/setter pair

userListenerId ↔ String

getter/setter pair

userObject ↔ User?

getter/setter pair

Methods

$configureLifeCycle() → void

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

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

inherited

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

inherited

ccLiveReaction(String reaction) → void

inherited

ccMessageDeleted(BaseMessage message, EventStatus messageStatus) → void

inherited

ccMessageEdited(BaseMessage message, MessageEditStatus status) → void

inherited

ccMessageForwarded(BaseMessage message, List<User>? usersSent, List<Group>? groupsSent, MessageStatus status) → void

inherited

ccMessageRead(BaseMessage message) → void

inherited

ccMessageSent(BaseMessage message, MessageStatus messageStatus) → void

inherited

ccOwnershipChanged(Group group, GroupMember newOwner) → void

This will get triggered when ownership is changed by logged in user

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifyChildrens() → void

inherited

onCardMessageReceived(CardMessage cardMessage) → void

inherited

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

onCustomInteractiveMessageReceived(CustomInteractiveMessage customInteractiveMessage) → void

inherited

onCustomMessageReceived(CustomMessage customMessage) → void

inherited

onFormMessageReceived(FormMessage formMessage) → void

inherited

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

inherited

onGroupMemberUnbanned(Action action, User unbannedUser, User unbannedBy, Group unbannedFrom) → 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

inherited

onMediaMessageReceived(MediaMessage mediaMessage) → void

inherited

onMemberAddedToGroup(Action action, User addedby, User userAdded, Group addedTo) → void

override

onMessageDeleted(BaseMessage message) → void

inherited

onMessageEdited(BaseMessage message) → void

inherited

onMessageReactionAdded(ReactionEvent reactionEvent) → void

onMessageReactionAdded is called when a reaction is added to a message

inherited

onMessageReactionRemoved(ReactionEvent reactionEvent) → void

onMessageReactionRemoved is called when a reaction is removed from a message

inherited

onMessagesDelivered(MessageReceipt messageReceipt) → void

inherited

onMessagesDeliveredToAll(MessageReceipt messageReceipt) → void

inherited

onMessagesRead(MessageReceipt messageReceipt) → void

inherited

onMessagesReadByAll(MessageReceipt messageReceipt) → void

inherited

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

inherited

onTextMessageReceived(TextMessage textMessage) → void

inherited

onTransientMessageReceived(TransientMessage message) → void

inherited

onTypingEnded(TypingIndicator typingIndicator) → void

override

onTypingStarted(TypingIndicator typingIndicator) → void

override

onUserOffline(User user) → void

override

onUserOnline(User user) → void

override

refresh() → void

inherited

refreshGroup(Object id) → void

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

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

updateMemberCount(Group group) → dynamic

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

counter ↔ int

getter/setter pair