CometChatUsersController class - cometchat_chat_uikit library

Constructors

CometChatUsersController({required UsersBuilderProtocol usersBuilderProtocol, SelectionMode? mode, dynamic onError(Exception)?, bool? disableUsersPresence})

Properties

builderProtocol ↔ BuilderProtocol: getter/setter pairinherited
dateStamp ↔ String: getter/setter pair
disableUsersPresence ↔ bool?: getter/setter pair
error ↔ Exception?: getter/setter pairinherited
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<User>: 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, User>: getter/setter pairinherited
selectionMode ↔ SelectionMode?: getter/setter pairinherited
userListenerID ↔ String: getter/setter pair
usersBuilderProtocol ↔ UsersBuilderProtocol: getter/setter pair

Methods

$configureLifeCycle() → void: inherited
addElement(User 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
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
deSelect(User 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(User element) → String: override
getList() → List<User>: inherited
getMatchingIndex(User element) → int: inherited
getMatchingIndexFromKey(String key) → int: inherited
getSelectedList() → List<User>: returns selected items in selected map
inherited
hideUserPresence(User user) → bool
loadMoreElements({bool isIncluded(User element)?}) → dynamic: inherited
match(User elementA, User 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
onInit() → void: Called immediately after the widget is allocated in memory. You might use this to initialize something for the controller.
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(User element) → dynamic: inherited
onUserOffline(User user) → void: override
onUserOnline(User user) → void: override
refresh() → void: inherited
refreshGroup(Object id) → void: inherited
removeElement(User 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(User 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(User element, {int? index}) → dynamic: inherited
updateElementAt(User element, int index) → dynamic: inherited
userIsNotBlocked(User user) → bool

Operators

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