Struct RoomPrivacySettings

pub struct RoomPrivacySettings<'a> { /* private fields */ }

A helper to group the methods in Room related to the room’s visibility and access.

Implementations

impl<'a> RoomPrivacySettings<'a>

pub async fn publish_room_alias_in_room_directory( &'a self, alias: &RoomAliasId, ) -> Result<bool>

Publish a new room alias for this room in the room directory.

Returns:

• true if the room alias didn’t exist and it’s now published.
• false if the room alias was already present so it couldn’t be published.

pub async fn remove_room_alias_from_room_directory( &'a self, alias: &RoomAliasId, ) -> Result<bool>

Remove an existing room alias for this room in the room directory.

Returns:

• true if the room alias was present and it’s now removed from the room directory.
• false if the room alias didn’t exist so it couldn’t be removed.

pub async fn update_canonical_alias( &'a self, alias: Option<OwnedRoomAliasId>, alt_aliases: Vec<OwnedRoomAliasId>, ) -> Result<()>

Update the canonical alias of the room.

Arguments:

• alias - The new main alias to use for the room. A None value removes the existing main canonical alias.
• alt_aliases - The list of alternative aliases for this room.

See https://spec.matrix.org/v1.12/client-server-api/#mroomcanonical_alias for more info about the canonical alias.

Note that publishing the alias in the room directory is done separately, and a room alias must have already been published before it can be set as the canonical alias.

pub async fn update_room_history_visibility( &'a self, new_value: HistoryVisibility, ) -> Result<()>

Update room history visibility for this room.

The history visibility controls whether a user can see the events that happened in a room before they joined.

See https://spec.matrix.org/v1.12/client-server-api/#mroomcanonical_alias for more info.

pub async fn update_join_rule(&'a self, new_rule: JoinRule) -> Result<()>

Update the join rule for this room.

The join rules controls if and how a new user can get access to the room.

See https://spec.matrix.org/v1.12/client-server-api/#mroomjoin_rules for more info.

pub async fn get_room_visibility(&'a self) -> Result<Visibility>

Returns the visibility for this room in the room directory.

Public rooms are listed in the room directory and can be found using it.

pub async fn update_room_visibility( &'a self, visibility: Visibility, ) -> Result<()>

Update the visibility for this room in the room directory.

Public rooms are listed in the room directory and can be found using it.

Trait Implementations

impl<'a> Debug for RoomPrivacySettings<'a>

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

Formats the value using the given formatter.