Struct matrix_sdk::BaseRoom [−][src]
pub struct BaseRoom { /* fields omitted */ }
Expand description
The underlying room data structure collecting state for joined, left and invited rooms.
Implementations
Get our own user id.
Get the unread notification counts.
Check if the room has it’s members fully synced.
Members might be missing if lazy member loading was enabled for the sync.
Returns true if no members are missing, false otherwise.
Get the prev_batch
token that was received from the last sync. May be
None
if the last sync contained the full room history.
Get the avatar url of this room.
Get the canonical alias of this room.
Get the m.room.create
content of this room.
This usually isn’t optional but some servers might not send an
m.room.create
event as the first event for a given room, thus this can
be optional.
If this room is a direct message, get the member that we’re sharing the room with.
Note: The member list might have been modified in the meantime and the target might not even be in the room anymore. This setting should only be considered as guidance.
Is the room encrypted.
Get the m.room.encryption
content that enabled end to end encryption
in the room.
Get the guest access policy of this room.
Get the history visibility policy of this room.
Get the maximum power level that this room contains.
This is useful if one wishes to normalize the power levels, e.g. from 0-100 where 100 would be the max power level.
Has the room been tombstoned.
Get the m.room.tombstone
content of this room if there is one.
Calculate the canonical display name of the room, taking into account its name, aliases and members.
The display name is calculated according to this algorithm.
Get the list of users ids that are considered to be joined members of this room.
Get the all RoomMember
s of this room that are known to the store.
Get the list of RoomMember
s that are considered to be joined members
of this room.
Get the list of RoomMember
s that are considered to be joined or
invited members of this room.
pub async fn get_member(
&'_ self,
user_id: &'_ UserId
) -> Result<Option<RoomMember>, StoreError>
pub async fn get_member(
&'_ self,
user_id: &'_ UserId
) -> Result<Option<RoomMember>, StoreError>
Get the RoomMember
with the given user_id
.
Returns None
if the member was never part of this room, otherwise
return a RoomMember
that can be in a joined, invited, left, banned
state.
Get the Tags
for this room.
pub async fn user_read_receipt(
&'_ self,
user_id: &'_ UserId
) -> Result<Option<(EventId, Receipt)>, StoreError>
pub async fn user_read_receipt(
&'_ self,
user_id: &'_ UserId
) -> Result<Option<(EventId, Receipt)>, StoreError>
Get the read receipt as a EventId
and Receipt
tuple for the given
user_id
in this room.
pub async fn event_read_receipts(
&'_ self,
event_id: &'_ EventId
) -> Result<Vec<(UserId, Receipt), Global>, StoreError>
pub async fn event_read_receipts(
&'_ self,
event_id: &'_ EventId
) -> Result<Vec<(UserId, Receipt), Global>, StoreError>
Get the read receipts as a list of UserId
and Receipt
tuples for the
given event_id
in this room.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Room
impl !UnwindSafe for Room
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more