Enum matrix_sdk::room::Room

pub enum Room {
    Joined(Joined),
    Left(Left),
    Invited(Invited),
}

An enum that abstracts over the different states a room can be in.

Variants

Joined(Joined)

The room in the join state.

Left(Left)

The room in the left state.

Invited(Invited)

The room in the invited state.

Methods from Deref<Target = Common>

pub fn client(&self) -> Client

Get the inner client saved in this room instance.

Returns the client this room is part of.

pub async fn avatar(&self, format: MediaFormat) -> Result<Option<Vec<u8>>>

Gets the avatar of this room, if set.

Returns the avatar. If a thumbnail is requested no guarantee on the size of the image is given.

Arguments

• format - The desired format of the avatar.

Example

let client = Client::new(homeserver).await.unwrap();
client.login(user, "password", None, None).await.unwrap();
let room_id = room_id!("!roomid:example.com");
let room = client.get_joined_room(&room_id).unwrap();
if let Some(avatar) = room.avatar(MediaFormat::File).await.unwrap() {
    std::fs::write("avatar.png", avatar);
}

pub async fn messages(&self, options: MessagesOptions<'_>) -> Result<Messages>

Sends a request to /_matrix/client/r0/rooms/{room_id}/messages and returns a Messages struct that contains a chunk of room and state events (RoomEvent and AnyStateEvent).

With the encryption feature, messages are decrypted if possible. If decryption fails for an individual message, that message is returned undecrypted.

Examples

use matrix_sdk::{room::MessagesOptions, Client};

let options =
    MessagesOptions::backward().from("t47429-4392820_219380_26003_2265");

let mut client = Client::new(homeserver).await.unwrap();
let room = client.get_joined_room(room_id!("!roomid:example.com")).unwrap();
assert!(room.messages(options).await.is_ok());

pub fn add_event_handler<Ev, Ctx, H>(&self, handler: H) -> EventHandlerHandlewhere
    Ev: SyncEvent + DeserializeOwned + Send + 'static,
    H: EventHandler<Ev, Ctx>,
    <H::Future as Future>::Output: EventHandlerResult,

Register a handler for events of a specific type, within this room.

This method works the same way as Client::add_event_handler, except that the handler will only be called for events within this room. See that method for more details on event handler functions.

room.add_event_handler(hdl) is equivalent to client.add_room_event_handler(room_id, hdl). Use whichever one is more convenient in your use case.

pub async fn event(&self, event_id: &EventId) -> Result<TimelineEvent>

Fetch the event with the given EventId in this room.

pub async fn sync_members(&self) -> Result<Option<MembersResponse>>

Sync the member list with the server.

This method will de-duplicate requests if it is called multiple times in quick succession, in that case the return value will be None.

pub async fn active_members(&self) -> Result<Vec<RoomMember>>

Get active members for this room, includes invited, joined members.

Note: This method will fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Because of that, it might panic if it isn’t run on a tokio thread.

Use active_members_no_sync() if you want a method that doesn’t do any requests.

pub async fn active_members_no_sync(&self) -> Result<Vec<RoomMember>>

Get active members for this room, includes invited, joined members.

Note: This method will not fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Thus, members could be missing from the list.

Use active_members() if you want to ensure to always get the full member list.

pub async fn joined_members(&self) -> Result<Vec<RoomMember>>

Get all the joined members of this room.

Note: This method will fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Because of that it might panic if it isn’t run on a tokio thread.

Use joined_members_no_sync() if you want a method that doesn’t do any requests.

pub async fn joined_members_no_sync(&self) -> Result<Vec<RoomMember>>

Get all the joined members of this room.

Note: This method will not fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Thus, members could be missing from the list.

Use joined_members() if you want to ensure to always get the full member list.

pub async fn get_member(&self, user_id: &UserId) -> Result<Option<RoomMember>>

Get a specific member of this room.

Note: This method will fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Because of that it might panic if it isn’t run on a tokio thread.

Use get_member_no_sync() if you want a method that doesn’t do any requests.

Arguments

• user_id - The ID of the user that should be fetched out of the store.

pub async fn get_member_no_sync(
    &self,
    user_id: &UserId
) -> Result<Option<RoomMember>>

Get a specific member of this room.

Note: This method will not fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Thus, members could be missing.

Use get_member() if you want to ensure to always have the full member list to chose from.

Arguments

• user_id - The ID of the user that should be fetched out of the store.

pub async fn members(&self) -> Result<Vec<RoomMember>>

Get all members for this room, includes invited, joined and left members.

Note: This method will fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Because of that it might panic if it isn’t run on a tokio thread.

Use members_no_sync() if you want a method that doesn’t do any requests.

pub async fn members_no_sync(&self) -> Result<Vec<RoomMember>>

Get all members for this room, includes invited, joined and left members.

Note: This method will not fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Thus, members could be missing.

Use members() if you want to ensure to always get the full member list.

pub async fn get_state_events(
    &self,
    event_type: StateEventType
) -> Result<Vec<Raw<AnySyncStateEvent>>>

Get all state events of a given type in this room.

pub async fn get_state_events_static<C>(
    &self
) -> Result<Vec<Raw<SyncStateEvent<C>>>>where
    C: StaticEventContent + StateEventContent + RedactContent,
    C::Redacted: RedactedStateEventContent,

Get all state events of a given statically-known type in this room.

Example

use matrix_sdk::ruma::{
    events::room::member::SyncRoomMemberEvent, serde::Raw,
};

let room_members: Vec<Raw<SyncRoomMemberEvent>> =
    room.get_state_events_static().await?;

pub async fn get_state_event(
    &self,
    event_type: StateEventType,
    state_key: &str
) -> Result<Option<Raw<AnySyncStateEvent>>>

Get a specific state event in this room.

pub async fn get_state_event_static<C>(
    &self
) -> Result<Option<Raw<SyncStateEvent<C>>>>where
    C: StaticEventContent + StateEventContent<StateKey = EmptyStateKey> + RedactContent,
    C::Redacted: RedactedStateEventContent,

Get a specific state event of statically-known type with an empty state key in this room.

Example

use matrix_sdk::ruma::events::room::power_levels::SyncRoomPowerLevelsEvent;

let power_levels: SyncRoomPowerLevelsEvent = room
    .get_state_event_static()
    .await?
    .expect("every room has a power_levels event")
    .deserialize()?;

pub async fn get_state_event_static_for_key<C, K>(
    &self,
    state_key: &K
) -> Result<Option<Raw<SyncStateEvent<C>>>>where
    C: StaticEventContent + StateEventContent + RedactContent,
    C::StateKey: Borrow<K>,
    C::Redacted: RedactedStateEventContent,
    K: AsRef<str> + ?Sized + Sync,

Get a specific state event of statically-known type in this room.

Example

use matrix_sdk::ruma::{
    events::room::member::SyncRoomMemberEvent, serde::Raw, user_id,
};

let member_event: Option<Raw<SyncRoomMemberEvent>> = room
    .get_state_event_static_for_key(user_id!("@alice:example.org"))
    .await?;

pub async fn account_data(
    &self,
    data_type: RoomAccountDataEventType
) -> Result<Option<Raw<AnyRoomAccountDataEvent>>>

Get account data in this room.

pub async fn account_data_static<C>(
    &self
) -> Result<Option<Raw<RoomAccountDataEvent<C>>>>where
    C: StaticEventContent + RoomAccountDataEventContent,

Get account data of statically-known type in this room.

Example

use matrix_sdk::ruma::events::fully_read::FullyReadEventContent;

match room.account_data_static::<FullyReadEventContent>().await? {
    Some(fully_read) => {
        println!("Found read marker: {:?}", fully_read.deserialize()?)
    }
    None => println!("No read marker for this room"),
}

pub async fn contains_only_verified_devices(&self) -> Result<bool>

Available on crate feature e2e-encryption only.

Check if all members of this room are verified and all their devices are verified.

Returns true if all devices in the room are verified, otherwise false.

pub async fn set_tag(
    &self,
    tag: TagName,
    tag_info: TagInfo
) -> HttpResult<Response>

Adds a tag to the room, or updates it if it already exists.

Returns the [create_tag::v3::Response] from the server.

Arguments

• tag - The tag to add or update.

• tag_info - Information about the tag, generally containing the order parameter.

Example

use matrix_sdk::ruma::events::tag::TagInfo;

if let Some(room) = client.get_joined_room(&room_id) {
    let mut tag_info = TagInfo::new();
    tag_info.order = Some(0.9);
    let user_tag = UserTagName::from_str("u.work")?;

    room.set_tag(TagName::User(user_tag), tag_info).await?;
}

pub async fn remove_tag(&self, tag: TagName) -> HttpResult<Response>

Removes a tag from the room.

Returns the [delete_tag::v3::Response] from the server.

Arguments

• tag - The tag to remove.

pub async fn set_is_direct(&self, is_direct: bool) -> Result<()>

Sets whether this room is a DM.

When setting this room as DM, it will be marked as DM for all active members of the room. When unsetting this room as DM, it will be unmarked as DM for all users, not just the members.

Arguments

• is_direct - Whether to mark this room as direct.

pub async fn decrypt_event(
    &self,
    event: &Raw<OriginalSyncRoomEncryptedEvent>
) -> Result<TimelineEvent>

Available on crate feature e2e-encryption only.

Tries to decrypt a room event.

Arguments

• event - The room event to be decrypted.

Returns the decrypted event.

pub async fn route(&self) -> Result<Vec<OwnedServerName>>

Get a list of servers that should know this room.

Uses the synced members of the room and the suggested routing algorithm from the Matrix spec.

Returns at most three servers.

pub async fn matrix_to_permalink(&self) -> Result<MatrixToUri>

Get a matrix.to permalink to this room.

If this room has an alias, we use it. Otherwise, we try to use the synced members in the room for routing the room ID.

pub async fn matrix_permalink(&self, join: bool) -> Result<MatrixUri>

Get a matrix: permalink to this room.

If this room has an alias, we use it. Otherwise, we try to use the synced members in the room for routing the room ID.

Arguments

• join - Whether the user should join the room.

pub async fn matrix_to_event_permalink(
    &self,
    event_id: impl Into<OwnedEventId>
) -> Result<MatrixToUri>

Get a matrix.to permalink to an event in this room.

We try to use the synced members in the room for routing the room ID.

Note: This method does not check if the given event ID is actually part of this room. It needs to be checked before calling this method otherwise the permalink won’t work.

Arguments

• event_id - The ID of the event.

pub async fn matrix_event_permalink(
    &self,
    event_id: impl Into<OwnedEventId>
) -> Result<MatrixUri>

Get a matrix: permalink to an event in this room.

We try to use the synced members in the room for routing the room ID.

Note: This method does not check if the given event ID is actually part of this room. It needs to be checked before calling this method otherwise the permalink won’t work.

Arguments

• event_id - The ID of the event.

Methods from Deref<Target = BaseRoom>

pub fn room_id(&self) -> &RoomId

Get the unique room id of the room.

pub fn own_user_id(&self) -> &UserId

Get our own user id.

pub fn room_type(&self) -> RoomType

Get the type of the room.

pub fn is_space(&self) -> bool

Whether this room’s RoomType is m.space.

pub fn unread_notification_counts(&self) -> UnreadNotificationsCount

Get the unread notification counts.

pub fn are_members_synced(&self) -> bool

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.

pub fn last_prev_batch(&self) -> Option<String>

Get the prev_batch token that was received from the last sync. May be None if the last sync contained the full room history.

pub fn avatar_url(&self) -> Option<OwnedMxcUri>

Get the avatar url of this room.

pub fn canonical_alias(&self) -> Option<OwnedRoomAliasId>

Get the canonical alias of this room.

pub fn alt_aliases(&self) -> Vec<OwnedRoomAliasId, Global>

Get the canonical alias of this room.

pub fn create_content(&self) -> Option<RoomCreateEventContent>

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.

It can also be redacted in current room versions, leaving only the creator field.

pub fn is_direct(&self) -> bool

Is this room considered a direct message.

pub fn direct_targets(&self) -> HashSet<OwnedUserId, RandomState>

If this room is a direct message, get the members that we’re sharing the room with.

Note: The member list might have been modified in the meantime and the targets might not even be in the room anymore. This setting should only be considered as guidance.

pub fn is_encrypted(&self) -> bool

Is the room encrypted.

pub fn encryption_settings(&self) -> Option<RoomEncryptionEventContent>

Get the m.room.encryption content that enabled end to end encryption in the room.

pub fn guest_access(&self) -> GuestAccess

Get the guest access policy of this room.

pub fn history_visibility(&self) -> HistoryVisibility

Get the history visibility policy of this room.

pub fn is_public(&self) -> bool

Is the room considered to be public.

pub fn join_rule(&self) -> JoinRule

Get the join rule policy of this room.

pub fn max_power_level(&self) -> i64

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.

pub fn name(&self) -> Option<String>

Get the m.room.name of this room.

pub fn is_tombstoned(&self) -> bool

Has the room been tombstoned.

pub fn tombstone(&self) -> Option<RoomTombstoneEventContent>

Get the m.room.tombstone content of this room if there is one.

pub fn topic(&self) -> Option<String>

Get the topic of the room.

pub async fn display_name(
    &self
) -> impl Future<Output = Result<DisplayName, StoreError>>

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.

pub async fn joined_user_ids(
    &self
) -> impl Future<Output = Result<Vec<OwnedUserId, Global>, StoreError>>

Get the list of users ids that are considered to be joined members of this room.

pub async fn members(
    &self
) -> impl Future<Output = Result<Vec<RoomMember, Global>, StoreError>>

Get the all RoomMembers of this room that are known to the store.

pub async fn joined_members(
    &self
) -> impl Future<Output = Result<Vec<RoomMember, Global>, StoreError>>

Get the list of RoomMembers that are considered to be joined members of this room.

pub async fn active_members(
    &self
) -> impl Future<Output = Result<Vec<RoomMember, Global>, StoreError>>

Get the list of RoomMembers that are considered to be joined or invited members of this room.

pub fn clone_info(&self) -> RoomInfo

Clone the inner RoomInfo

pub fn update_summary(&self, summary: RoomInfo)

Update the summary with given RoomInfo

pub async fn get_member(
    &self,
    user_id: &UserId
) -> impl Future<Output = 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.

pub async fn tags(
    &self
) -> impl Future<Output = Result<Option<BTreeMap<TagName, TagInfo, Global>>, StoreError>>

Get the Tags for this room.

pub async fn user_read_receipt(
    &self,
    user_id: &UserId
) -> impl Future<Output = Result<Option<(OwnedEventId, 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
) -> impl Future<Output = Result<Vec<(OwnedUserId, 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

impl Clone for Room

fn clone(&self) -> Room

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Room

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for Room

type Target = Common

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<Common> for Room

fn from(room: Common) -> Self

Converts to this type from the input type.

impl From<Invited> for Room

fn from(room: Invited) -> Self

Converts to this type from the input type.

impl From<Joined> for Room

fn from(room: Joined) -> Self

Converts to this type from the input type.

impl From<Left> for Room

fn from(room: Left) -> Self

Converts to this type from the input type.

impl EventHandlerContext for Room

This event handler context argument is only applicable to room-specific events.

Trying to use it in the event handler for another event, for example a global account data or presence event, will result in the event handler being skipped and an error getting logged.