MockUsersApi class

Implemented types

• ChatUsersApi

Constructors

MockUsersApi(MockChatClient _client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

create({List<String>? externalIds, Map<String, String>? passwords, String? displayName, String? avatarUrl, String? bio, String? email, Map<String, dynamic>? custom}) → Future<ChatResult<ChatUser>>

Creates a new user, optionally linked to external IDs and seeded with profile fields (1-step creation).

override

createManaged({required List<String> externalIds}) → Future<ChatResult<List<ChatUser>>>

Creates managed users linked to the given external IDs.

override

delete(String userId) → Future<ChatResult<void>>

Deletes a user permanently.

override

deleteManaged(String userId, {required String fromUserId}) → Future<ChatResult<void>>

Removes a managed user from its parent.

override

get(String userId, {CachePolicy? cachePolicy}) → Future<ChatResult<ChatUser>>

Fetches a single user by ID.

override

getManaged(String userId, {ChatPaginationParams? pagination}) → Future<ChatResult<ChatPaginatedResponse<ChatUser>>>

Lists managed users belonging to a parent user.

override

getManagedConfig(String userId) → Future<ChatResult<ManagedUserConfiguration>>

Gets the configuration of a managed user (webhooks, metadata).

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

search(String query, {ChatPaginationParams? pagination}) → Future<ChatResult<ChatPaginatedResponse<ChatUser>>>

Searches users by display name (case-insensitive substring match).

override

searchManaged({required String externalId}) → Future<ChatResult<ChatUser>>

Finds a managed user by its external ID.

override

toString() → String

A string representation of this object.

inherited

update(String userId, {String? displayName, String? avatarUrl, bool clearAvatar = false, String? bio, String? email, Map<String, dynamic>? custom, bool? active}) → Future<ChatResult<ChatUser>>

Updates profile fields for an existing user.

override

updateManagedConfig(String userId, {required ManagedUserConfiguration configuration}) → Future<ChatResult<void>>

Updates the configuration of a managed user.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited