RoomDetail class abstract

Detailed room information including the current user's role and room configuration.

Available extensions

• RoomDetailPatterns

Annotations

• @freezed

Constructors

RoomDetail({required String id, String? name, String? subject, required RoomType type, required int memberCount, required RoomRole userRole, required RoomConfig config, @Default.new(false) bool muted, DateTime? muteUntil, @Default.new(false) bool pinned, @Default.new(false) bool hidden, @Default.new(false) bool selfMuted, DateTime? createdAt, String? avatarUrl, Map<String, dynamic>? custom})

const

factory

Properties

avatarUrl → String?

no setter, inherited

config → RoomConfig

no setter, inherited

copyWith → $RoomDetailCopyWith<RoomDetail>

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

no setter, inherited

createdAt → DateTime?

no setter, inherited

custom → Map<String, dynamic>?

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hidden → bool

no setter, inherited

id → String

no setter, inherited

isReadOnly → bool

True when the composer must be read-only: an announcement channel the user doesn't own, OR the user has been moderation-muted in this room (an admin/owner silenced them). selfMuted is distinct from muted (the user's own notification preference).

no setter

memberCount → int

no setter, inherited

muted → bool

no setter, inherited

muteUntil → DateTime?

When the notification mute expires (UTC). null means a permanent mute (or not muted — check muted).

no setter, inherited

name → String?

no setter, inherited

pinned → bool

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selfMuted → bool

no setter, inherited

subject → String?

no setter, inherited

type → RoomType

no setter, inherited

userRole → RoomRole

no setter, inherited

Methods

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

Available on RoomDetail, provided by the RoomDetailPatterns extension

A switch-like method, using callbacks.

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

Available on RoomDetail, provided by the RoomDetailPatterns extension

A variant of map that fallback to returning null.

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

Available on RoomDetail, provided by the RoomDetailPatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(String id, String? name, String? subject, RoomType type, int memberCount, RoomRole userRole, RoomConfig config, bool muted, DateTime? muteUntil, bool pinned, bool hidden, bool selfMuted, DateTime? createdAt, String? avatarUrl, Map<String, dynamic>? custom)?, {required TResult orElse()}) → TResult

Available on RoomDetail, provided by the RoomDetailPatterns 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

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>(TResult $default(String id, String? name, String? subject, RoomType type, int memberCount, RoomRole userRole, RoomConfig config, bool muted, DateTime? muteUntil, bool pinned, bool hidden, bool selfMuted, DateTime? createdAt, String? avatarUrl, Map<String, dynamic>? custom)) → TResult

Available on RoomDetail, provided by the RoomDetailPatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(String id, String? name, String? subject, RoomType type, int memberCount, RoomRole userRole, RoomConfig config, bool muted, DateTime? muteUntil, bool pinned, bool hidden, bool selfMuted, DateTime? createdAt, String? avatarUrl, Map<String, dynamic>? custom)?) → TResult?

Available on RoomDetail, provided by the RoomDetailPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited