Room class

Methods

activeMembers() → Future<FfiListMember>

the members currently in the room

activeMembersIds() → Future<FfiListFfiString>

the members currently in the room

addParentRoom(String roomId, bool canonical) → Future<String>

add the following as a parent room and return event id of that event room can have multiple parents

avatar(ThumbnailSize? thumbSize) → Future<OptionBuffer>

get the binary data of avatar if thumb size is given, avatar thumbnail is returned if thumb size is not given, avatar file is returned

defaultNotificationMode() → Future<String>

default RoomNotificationMode for this type of room

displayName() → Future<OptionString>

get the display name

drop() → void

Manually drops the object and unregisters the FinalizableHandle.

getMember(String userId) → Future<Member>

get the room member by user id

getMyMembership() → Future<Member>

the Membership of myself

hasAvatar() → bool

whether to have avatar

invitedMembers() → Future<FfiListMember>

the members invited to this room

inviteUser(String userId) → Future<bool>

invite the new user to this room

isDirect() → Future<bool>

Whether this is a direct message (in chat)

isJoined() → bool

whether we are part of this room

isSpace() → bool

whether this is a Space

joinRuleStr() → String

the JoinRule as a String

leave() → Future<bool>

leave this room

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notificationMode() → Future<String>

RoomNotificationMode for this room

removeAvatar() → Future<EventId>

Remove the avatar of the room

removeParentRoom(String roomId, String? reason) → Future<bool>

remove a parent room

restrictedRoomIdsStr() → FfiListFfiString

if set to restricted or restricted_knock the rooms this is restricted to

roomIdStr() → String

the RoomId as a String

setJoinRule(JoinRuleBuilder joinRuleBuilder) → Future<bool>

set the join rule.

setName(String name) → Future<EventId>

set name of the room

setNotificationMode(String? newMode) → Future<bool>

set the RoomNotificationMode

setTopic(String topic) → Future<EventId>

set description / topic of the room

spaceRelations() → Future<SpaceRelations>

get the room profile that contains avatar and display name

subscribeToUpdates() → Stream<bool>

Whether new updates have been received for this room

topic() → String?

what is the description / topic

toString() → String

A string representation of this object.

inherited

unmute() → Future<bool>

Unset the mute for this room.

updatePowerLevel(String userId, int level) → Future<EventId>

update the power levels of specified member

uploadAvatar(String uri) → Future<MxcUri>

Change the avatar of the room

userSettings() → Future<UserRoomSettings>

user settings for this room