Struct RoomMember 

pub struct RoomMember { /* private fields */ }

The high-level RoomMember representation

Implementations

impl RoomMember

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

Gets the avatar of this member, 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.

Examples

use matrix_sdk::{
    Client, RoomMemberships, media::MediaFormat, room::RoomMember,
    ruma::room_id,
};
let client = Client::new(homeserver).await.unwrap();
client.matrix_auth().login_username(user, "password").send().await.unwrap();
let room_id = room_id!("!roomid:example.com");
let room = client.get_room(&room_id).unwrap();
let members = room.members(RoomMemberships::empty()).await.unwrap();
let member = members.first().unwrap();
if let Some(avatar) = member.avatar(MediaFormat::File).await.unwrap() {
    std::fs::write("avatar.png", avatar);
}

pub async fn ignore(&self) -> Result<()>

Adds the room member to the current account data’s ignore list which will ignore the user across all rooms.

pub async fn unignore(&self) -> Result<()>

Removes the room member from the current account data’s ignore list which will unignore the user across all rooms.

pub fn is_account_user(&self) -> bool

Returns true if the member of the room is the user of the account

pub fn suggested_role_for_power_level(&self) -> RoomMemberRole

Get the suggested role of this member based on their power level.

Methods from Deref<Target = BaseRoomMember>

pub fn user_id(&self) -> &UserId

Get the unique user id of this member.

pub fn event(&self) -> &Arc<SyncOrStrippedState<RoomMemberEventContent>>

Get the original member event

pub fn display_name(&self) -> Option<&str>

Get the display name of the member if there is one.

pub fn name(&self) -> &str

Get the name of the member.

This returns either the display name or the local part of the user id if the member didn’t set a display name.

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

Get the avatar url of the member, if there is one.

pub fn status(&self) -> Option<&StatusProfileField>

Available on crate feature unstable-msc4426 only.

Get the user’s status, if any.

This is the user-set status (emoji + text) taken from the user’s global profile.

Global profiles are only populated when syncing via sliding sync with the profiles extension enabled; this is always None under sync v2.

pub fn call(&self) -> Option<&CallProfileField>

Available on crate feature unstable-msc4426 only.

Get the user’s call indicator, if any.

This indicates the user is currently in a call (and optionally how long they’ve been in it). It is taken from the user’s global profile.

Global profiles are only populated when syncing via sliding sync with the profiles extension enabled; this is always None under sync v2.

pub fn normalized_power_level(&self) -> UserPowerLevel

Get the normalized power level of this member.

The normalized power level depends on the maximum power level that can be found in a certain room, positive values that are not Infinite are always in the range of 0-100.

pub fn power_level(&self) -> UserPowerLevel

Get the power level of this member.

pub fn can_ban(&self) -> bool

Whether this user can ban other users based on the power levels.

Same as member.can_do(PowerLevelAction::Ban).

pub fn can_invite(&self) -> bool

Whether this user can invite other users based on the power levels.

Same as member.can_do(PowerLevelAction::Invite).

pub fn can_kick(&self) -> bool

Whether this user can kick other users based on the power levels.

Same as member.can_do(PowerLevelAction::Kick).

pub fn can_redact_own(&self) -> bool

Whether this user can redact their own events based on the power levels.

Same as member.can_do(PowerLevelAction::RedactOwn).

pub fn can_redact_other(&self) -> bool

Whether this user can redact events of other users based on the power levels.

Same as member.can_do(PowerLevelAction::RedactOther).

pub fn can_send_message(&self, msg_type: MessageLikeEventType) -> bool

Whether this user can send message events based on the power levels.

Same as member.can_do(PowerLevelAction::SendMessage(msg_type)).

pub fn can_send_state(&self, state_type: StateEventType) -> bool

Whether this user can send state events based on the power levels.

Same as member.can_do(PowerLevelAction::SendState(state_type)).

pub fn can_pin_or_unpin_event(&self) -> bool

Whether this user can pin or unpin events based on the power levels.

pub fn can_trigger_room_notification(&self) -> bool

Whether this user can notify everybody in the room by writing @room in a message.

Same as member. can_do(PowerLevelAction::TriggerNotification(NotificationPowerLevelType::Room)).

pub fn can_do(&self, action: PowerLevelAction) -> bool

Whether this user can do the given action based on the power levels.

pub fn name_ambiguous(&self) -> bool

Is the name that the member uses ambiguous in the room.

A name is considered to be ambiguous if at least one other member shares the same name.

pub fn membership(&self) -> &MembershipState

Get the membership state of this member.

pub fn is_ignored(&self) -> bool

Is the room member ignored by the current account user

pub fn is_service_member(&self) -> bool

Is the room member a service member.

Trait Implementations

impl Clone for RoomMember

fn clone(&self) -> RoomMember

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoomMember

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

Formats the value using the given formatter.

impl Deref for RoomMember

type Target = RoomMember

The resulting type after dereferencing.

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

Dereferences the value.