MUser class abstract

Represents a Matrix user

The userID field contains the unique identifier of the user.

The deviceId field contains the identifier of the user's device.

The displayName field contains the display name of the user.

The accessToken field contains the access token associated with the user.

The avatarUri field contains the URI to the user's avatar.

The isSignedIn field indicates whether the user is currently signed in.

This class corresponds to the user object defined in the Matrix API specification. For more details, refer to the API documentation at https://matrix.org/docs/spec/client_server/latest#user-object.

To create an instance of User, use the provided factory constructors or the fromJson method. It is also possible to create an initial instance of User using the initial factory constructor.

Example usage:

final user = User.fromJson(jsonData);
final userID = user.userID;
final displayName = user.displayName;

Available extensions

• MUserPatterns

Annotations

• @freezed

Constructors

MUser({@JsonKey.new(name: 'user_id') String? userID, @JsonKey.new(name: 'device_id') String? deviceId, @JsonKey.new(name: 'display_name') String? displayName, @JsonKey.new(name: 'access_token') String? accessToken, @JsonKey.new(name: 'avatar_url') String? avatarUri, @JsonKey.new(name: 'isSignedIn') bool? isSignedIn})

Creates a User instance.

factory

MUser.fromJson(Map<String, dynamic> json)

Creates a User instance from a JSON map.

factory

MUser.initial()

Creates an initial User instance.

factory

Properties

accessToken → String?

no setter, inherited

avatarUri → String?

no setter, inherited

copyWith → $MUserCopyWith<MUser>

Create a copy of MUser with the given fields replaced by the non-null parameter values.

no setter, inherited

deviceId → String?

no setter, inherited

displayName → String?

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

isSignedIn → bool?

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

userID → String?

no setter, inherited

Methods

map<TResult extends Object?>(TResult $default(_MUser value)) → TResult

Available on MUser, provided by the MUserPatterns extension

A switch-like method, using callbacks.

mapOrNull<TResult extends Object?>(TResult? $default(_MUser value)?) → TResult?

Available on MUser, provided by the MUserPatterns extension

A variant of map that fallback to returning null.

maybeMap<TResult extends Object?>(TResult $default(_MUser value)?, {required TResult orElse()}) → TResult

Available on MUser, provided by the MUserPatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(String? userID, String? deviceId, String? displayName, String? accessToken, String? avatarUri, bool? isSignedIn)?, {required TResult orElse()}) → TResult

Available on MUser, provided by the MUserPatterns extension

A variant of when that fallback to an orElse callback.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this MUser to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>(TResult $default(String? userID, String? deviceId, String? displayName, String? accessToken, String? avatarUri, bool? isSignedIn)) → TResult

Available on MUser, provided by the MUserPatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(String? userID, String? deviceId, String? displayName, String? accessToken, String? avatarUri, bool? isSignedIn)?) → TResult?

Available on MUser, provided by the MUserPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited