Struct matrix_sdk::room_preview::RoomPreview

pub struct RoomPreview {
    pub room_id: OwnedRoomId,
    pub canonical_alias: Option<OwnedRoomAliasId>,
    pub name: Option<String>,
    pub topic: Option<String>,
    pub avatar_url: Option<OwnedMxcUri>,
    pub num_joined_members: u64,
    pub num_active_members: Option<u64>,
    pub room_type: Option<RoomType>,
    pub join_rule: SpaceRoomJoinRule,
    pub is_world_readable: bool,
    pub state: Option<RoomState>,
    pub is_direct: Option<bool>,
}

The preview of a room, be it invited/joined/left, or not.

Fields

room_id: OwnedRoomId

The actual room id for this room.

Remember the room preview can be fetched from a room alias id, so we might not know ahead of time what the room id is.

canonical_alias: Option<OwnedRoomAliasId>

The canonical alias for the room.

name: Option<String>

The room’s name, if set.

topic: Option<String>

The room’s topic, if set.

avatar_url: Option<OwnedMxcUri>

The MXC URI to the room’s avatar, if set.

num_joined_members: u64

The number of joined members.

num_active_members: Option<u64>

The number of active members, if known (joined + invited).

room_type: Option<RoomType>

The room type (space, custom) or nothing, if it’s a regular room.

join_rule: SpaceRoomJoinRule

What’s the join rule for this room?

is_world_readable: bool

Is the room world-readable (i.e. is its history_visibility set to world_readable)?

state: Option<RoomState>

Has the current user been invited/joined/left this room?

Set to None if the room is unknown to the user.

is_direct: Option<bool>

The m.room.direct state of the room, if known.

Implementations

impl RoomPreview

pub async fn from_room_summary( client: &Client, room_id: OwnedRoomId, room_or_alias_id: &RoomOrAliasId, via: Vec<OwnedServerName>, ) -> Result<Self>

Get a RoomPreview using MSC3266, if available on the remote server.

Will fail with a 404 if the API is not available.

This method is exposed for testing purposes; clients should prefer Client::get_room_preview in general over this.

pub async fn from_state_events( client: &Client, room_id: &RoomId, ) -> Result<Self>

Get a RoomPreview using the room state endpoint.

This is always available on a remote server, but will only work if one of these two conditions is true:

• the user has joined the room at some point (i.e. they’re still joined or they’ve joined it and left it later).
• the room has an history visibility set to world-readable.

This method is exposed for testing purposes; clients should prefer Client::get_room_preview in general over this.

Trait Implementations

impl Clone for RoomPreview

fn clone(&self) -> RoomPreview

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomPreview

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

Formats the value using the given formatter.