CometChatGroupsController class

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

Inheritance
Implemented types
Mixed-in types

Constructors

CometChatGroupsController({required GroupsBuilderProtocol groupsBuilderProtocol, SelectionMode? mode, required CometChatTheme theme, dynamic onError(Exception)?})

Properties

builderProtocol ↔ BuilderProtocol
getter/setter pairinherited
context ↔ BuildContext
getter/setter pair
dateStamp ↔ String
getter/setter pair
error ↔ Exception?
getter/setter pairinherited
groupsBuilderProtocol ↔ GroupsBuilderProtocol
getter/setter pair
groupSDKListenerID ↔ String
getter/setter pair
groupUIListenerID ↔ String
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
initialized → bool
Checks whether the controller has already been initialized.
no setterinherited
isClosed → bool
Checks whether the controller has already been closed.
no setterinherited
isFetchNext ↔ bool
getter/setter pairinherited
isLoading ↔ bool
getter/setter pairinherited
list ↔ List<Group>
getter/setter pairinherited
listeners → int
no setterinherited
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
request ↔ dynamic
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchKeyword ↔ String?
getter/setter pairinherited
selectionMap ↔ Map<String, Group>
getter/setter pairinherited
selectionMode ↔ SelectionMode?
getter/setter pairinherited
theme ↔ CometChatTheme
getter/setter pair

Methods

$configureLifeCycle() → void
inherited
addElement(Group 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
ccGroupCreated(Group group) → void
This will get triggered when a group is created successfully
override
ccGroupDeleted(Group group) → void
This will get triggered when a group is deleted successfully
override
ccGroupLeft(Action message, User leftUser, Group leftGroup) → void
This will get triggered when logged in user leaves the group
override
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
override
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
ccOwnershipChanged(Group group, GroupMember newOwner) → void
This will get triggered when ownership is changed by logged in user
override
deSelect(Group element) → dynamic
inherited
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
getKey(Group element) → String
override
getList() → List<Group>
inherited
getMatchingIndex(Group element) → int
inherited
getMatchingIndexFromKey(String key) → int
inherited
getSelectedList() → List<Group>
returns selected items in selected map
inherited
loadMoreElements({bool isIncluded(Group element)?}) → dynamic
inherited
match(Group elementA, Group elementB) → bool
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyChildrens() → 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
onConnected() → void
override
onConnecting() → void
inherited
onConnectionError(CometChatException error) → void
inherited
onDisconnected() → void
inherited
onFeatureThrottled() → 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
override
onGroupMemberUnbanned(Action action, User unbannedUser, User unbannedBy, Group unbannedFrom) → void
inherited
onInit() → void
Called immediately after the widget is allocated in memory. You might use this to initialize something for the controller.
override
onMemberAddedToGroup(Action action, User addedby, User userAdded, Group addedTo) → void
override
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
onSearch(String val) → dynamic
inherited
onTap(Group element) → dynamic
inherited
refresh() → void
inherited
refreshGroup(Object id) → void
inherited
removeElement(Group 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
select(Group element) → dynamic
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
updateElement(Group element, {int? index}) → dynamic
override
updateElementAt(Group element, int index) → dynamic
inherited

Operators

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