CometChatDetailsController class

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

Inheritance
  • Object
  • GetLifeCycle
  • DisposableInterface
  • GetxController
  • CometChatDetailsController
Implemented types
Mixed-in types

Constructors

CometChatDetailsController(User? user, Group? group, {AddMemberConfiguration? addMemberConfiguration, TransferOwnershipConfiguration? transferOwnershipConfiguration, BannedMemberConfiguration? bannedMemberConfiguration, void stateCallBack(CometChatDetailsController)?, List<CometChatDetailsTemplate>? data(Group? group, User? user)?, OnError? onError, GroupMembersConfiguration? groupMembersConfiguration, ConfirmDialogStyle? leaveGroupDialogStyle, bool? disableUsersPresence})

Properties

addMemberConfiguration → AddMemberConfiguration?
configurations for opening add members
final
bannedMemberConfiguration → BannedMemberConfiguration?
configurations for opening transfer ownership
final
context ↔ BuildContext
getter/setter pair
data → List<CometChatDetailsTemplate>? Function(Group? group, User? user)?
used to override list of templates is passed which is used for displaying relevant options
final
disableUsersPresence ↔ bool?
getter/setter pair
group ↔ Group?
to pass group , one of parameter user or group should be always populated
getter/setter pair
groupMembersConfiguration → GroupMembersConfiguration?
configurations for viewing group members
final
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
no setterinherited
initialized → bool
Checks whether the controller has already been initialized.
no setterinherited
isClosed → bool
Checks whether the controller has already been closed.
no setterinherited
leaveGroupDialogStyle → ConfirmDialogStyle?
leaveGroupDialogStyle used to customize the dialog box that pops up when trying to leave group
final
listeners → int
no setterinherited
loggedInUser ↔ User?
getter/setter pair
membersCount ↔ int
getter/setter pair
onDelete → InternalFinalCallback<void>
Internal callback that starts the cycle of this controller.
finalinherited
onError → OnError?
onError callback triggered in case any error happens when fetching users
final
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
optionsMap ↔ Map<String, List<CometChatDetailsOption>>
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stateCallBack → void Function(CometChatDetailsController)?
stateCallBack a call back to give state to its parent
final
templateList ↔ List<CometChatDetailsTemplate>
getter/setter pair
theme ↔ CometChatTheme
getter/setter pair
transferOwnershipConfiguration → TransferOwnershipConfiguration?
configurations for opening transfer ownership
final
user → User?
to pass user , one of parameter user or group should be always populated
final

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
addOption(String templateId, CometChatDetailsOption newOption, {int? position}) → int
override
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
ccOwnershipChanged(Group group, GroupMember newOwner) → void
This will get triggered when ownership is changed by logged in user
override
ccUserBlocked(User user) → void
This will get triggered when the logged in user blocks another user
override
ccUserUnblocked(User user) → void
This will get triggered when the logged in user unblocks another 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
getDetailsOptionMap() → Map<String, List<CometChatDetailsOption>>
override
getDetailsTemplateList() → List<CometChatDetailsTemplate>
override
hideUserPresence() → bool
initializeLoggedInUser() → dynamic
initializeSectionUtilities() → dynamic
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyChildrens() → void
inherited
onAddMemberClicked(Group group) → dynamic
override
onBanMemberClicked(Group group) → dynamic
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
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
onTransferOwnershipClicked(Group group) → dynamic
override
onUserOffline(User user) → void
override
onUserOnline(User user) → void
override
onViewMemberClicked(Group group) → dynamic
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
removeOption(String templateId, String optionId) → int
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
updateOption(String templateId, String oldOptionID, CometChatDetailsOption updatedOption) → int
override
useOption(CometChatDetailsOption option, String sectionId) → dynamic
override
userIsNotBlocked() → bool

Operators

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