UsersRequest class
A request object for fetching users.
Properties
- currentPage → int?
-
Current page number.
final
- friendsOnly → bool?
-
Flag to include only friends.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hideBlockedUsers → bool?
-
Flag to hide blocked users.
final
- inProgress → bool?
-
Flag to indicate fetching progress.
final
- key ↔ String?
-
Key for pagination.
getter/setter pair
- limit → int?
-
Number of results to limit the query.
final
- nextPage → int?
-
Page number for pagination.
final
- role → String?
-
Role of the users.
final
-
roles
→ List<
String> ? -
Roles for filtering.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
searchIn
→ List<
String> ? -
Search in specific fields.
final
- searchKeyword → String?
-
Keyword for searching.
final
- setPage → int?
-
SetPage for fetching users from particular page.
final
- sortBy → String?
-
Sort by field.
final
- sortByOrder → String?
-
Sort order
final
-
Tags for filtering.
final
- token → int?
-
Token for pagination.
final
- totalPages → int?
-
Total number of pages.
final
-
uids
→ List<
String> ? -
User ids for filtering.
final
- userStatus → String?
-
Status of the users.
final
- withTags → bool?
-
Flag to include tags.
final
Methods
-
fetchNext(
{required dynamic onSuccess(List< User> userList)?, required dynamic onError(CometChatException excep)?}) → Future<List< User> > - Fetch a list of users based on the provided filters.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited