Struct matrix_sdk_ui::room_list_service::Room
source · pub struct Room { /* private fields */ }
Expand description
A room in the room list.
It’s cheap to clone this type.
Implementations§
source§impl Room
impl Room
sourcepub fn cached_display_name(&self) -> Option<String>
pub fn cached_display_name(&self) -> Option<String>
Get a computed room name for the room.
sourcepub fn inner_room(&self) -> &Room
pub fn inner_room(&self) -> &Room
Get the underlying matrix_sdk::Room
.
sourcepub fn is_timeline_initialized(&self) -> bool
pub fn is_timeline_initialized(&self) -> bool
Get whether the timeline has been already initialised or not.
sourcepub async fn init_timeline_with_builder(
&self,
builder: TimelineBuilder,
) -> Result<(), Error>
pub async fn init_timeline_with_builder( &self, builder: TimelineBuilder, ) -> Result<(), Error>
Initialize the timeline of the room with an event type filter so only some events are returned. If a previous timeline exists, it’ll return an error. Otherwise, a Timeline will be returned.
sourcepub async fn latest_event(&self) -> Option<EventTimelineItem>
pub async fn latest_event(&self) -> Option<EventTimelineItem>
Get the latest event in the timeline.
The latest event comes first from the Timeline
, it can be a local or a
remote event. Note that the Timeline
can have more information esp. if
it has run a backpagination for example. Otherwise if the Timeline
doesn’t have any latest event, it comes from the cache. This method
does not fetch any events or calculate anything — if it’s not already
available, we return None
.
Reminder: this method also returns None
is the latest event is not
suitable for use in a message preview.
sourcepub async fn default_room_timeline_builder(
&self,
) -> Result<TimelineBuilder, Error>
pub async fn default_room_timeline_builder( &self, ) -> Result<TimelineBuilder, Error>
Create a new TimelineBuilder
with the default configuration.
If the room was synced before some initial events will be added to the
TimelineBuilder
.
Methods from Deref<Target = Room>§
sourcepub async fn make_edit_event(
&self,
event_id: &EventId,
new_content: EditedContent,
) -> Result<AnyMessageLikeEventContent, EditError>
pub async fn make_edit_event( &self, event_id: &EventId, new_content: EditedContent, ) -> Result<AnyMessageLikeEventContent, EditError>
Create a new edit event for the target event id with the new content.
The event can then be sent with Room::send
or a
crate::send_queue::RoomSendQueue
.
sourcepub async fn leave(&self) -> Result<(), Error>
pub async fn leave(&self) -> Result<(), Error>
Leave this room.
Only invited and joined rooms can be left.
sourcepub async fn join(&self) -> Result<(), Error>
pub async fn join(&self) -> Result<(), Error>
Join this room.
Only invited and left rooms can be joined via this method.
sourcepub fn client(&self) -> Client
pub fn client(&self) -> Client
Get the inner client saved in this room instance.
Returns the client this room is part of.
sourcepub fn is_synced(&self) -> bool
pub fn is_synced(&self) -> bool
Get the sync state of this room, i.e. whether it was fully synced with the server.
sourcepub async fn avatar(
&self,
format: MediaFormat,
) -> Result<Option<Vec<u8>>, Error>
pub async fn avatar( &self, format: MediaFormat, ) -> Result<Option<Vec<u8>>, Error>
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.
§Examples
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();
if let Some(avatar) = room.avatar(MediaFormat::File).await.unwrap() {
std::fs::write("avatar.png", avatar);
}
sourcepub async fn messages(
&self,
options: MessagesOptions,
) -> Result<Messages, Error>
pub async fn messages( &self, options: MessagesOptions, ) -> Result<Messages, Error>
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_room(room_id!("!roomid:example.com")).unwrap();
assert!(room.messages(options).await.is_ok());
sourcepub fn add_event_handler<Ev, Ctx, H>(&self, handler: H) -> EventHandlerHandle
pub fn add_event_handler<Ev, Ctx, H>(&self, handler: H) -> EventHandlerHandle
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.
sourcepub fn subscribe_to_updates(&self) -> Receiver<RoomUpdate>
pub fn subscribe_to_updates(&self) -> Receiver<RoomUpdate>
Subscribe to all updates for this room.
The returned receiver will receive a new message for each sync response that contains updates for this room.
sourcepub fn subscribe_to_typing_notifications(
&self,
) -> (EventHandlerDropGuard, Receiver<Vec<OwnedUserId>>)
pub fn subscribe_to_typing_notifications( &self, ) -> (EventHandlerDropGuard, Receiver<Vec<OwnedUserId>>)
Subscribe to typing notifications for this room.
The returned receiver will receive a new vector of user IDs for each sync response that contains ‘m.typing’ event. The current user ID will be filtered out.
sourcepub async fn subscribe_to_identity_status_changes(
&self,
) -> Result<impl Stream<Item = Vec<IdentityStatusChange>>, Error>
pub async fn subscribe_to_identity_status_changes( &self, ) -> Result<impl Stream<Item = Vec<IdentityStatusChange>>, Error>
Subscribe to updates about users who are in “pin violation” i.e. their identity has changed and the user has not yet acknowledged this.
The returned receiver will receive a new vector of
IdentityStatusChange
each time a /keys/query response shows a
changed identity for a member of this room, or a sync shows a change
to the membership of an affected user. (Changes to the current user are
not directly included, but some changes to the current user’s identity
can trigger changes to how we see other users’ identities, which
will be included.)
The first item in the stream provides the current state of the room: each member of the room who is not in “pinned” state will be included (except the current user).
If the changed_to
property of an IdentityStatusChange
is set to
PinViolation
then a warning should be displayed to the user. If it is
set to Pinned
then no warning should be displayed.
Note that if a user who is in pin violation leaves the room, a Pinned
update is sent, to indicate that the warning should be removed, even
though the user’s identity is not necessarily pinned.
sourcepub async fn event(
&self,
event_id: &EventId,
request_config: Option<RequestConfig>,
) -> Result<TimelineEvent, Error>
pub async fn event( &self, event_id: &EventId, request_config: Option<RequestConfig>, ) -> Result<TimelineEvent, Error>
Fetch the event with the given EventId
in this room.
It uses the given RequestConfig
if provided, or the client’s default
one otherwise.
sourcepub async fn event_with_context(
&self,
event_id: &EventId,
lazy_load_members: bool,
context_size: UInt,
request_config: Option<RequestConfig>,
) -> Result<EventWithContextResponse, Error>
pub async fn event_with_context( &self, event_id: &EventId, lazy_load_members: bool, context_size: UInt, request_config: Option<RequestConfig>, ) -> Result<EventWithContextResponse, Error>
Fetch the event with the given EventId
in this room, using the
/context
endpoint to get more information.
sourcepub async fn is_encrypted(&self) -> Result<bool, Error>
pub async fn is_encrypted(&self) -> Result<bool, Error>
Check whether this room is encrypted. If the room encryption state is not synced yet, it will send a request to fetch it.
Returns true if the room is encrypted, otherwise false.
sourcepub async fn sync_members(&self) -> Result<(), Error>
pub async fn sync_members(&self) -> Result<(), Error>
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
. This
method does nothing if the members are already synced.
sourcepub async fn get_member(
&self,
user_id: &UserId,
) -> Result<Option<RoomMember>, Error>
pub async fn get_member( &self, user_id: &UserId, ) -> Result<Option<RoomMember>, Error>
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.
sourcepub async fn get_member_no_sync(
&self,
user_id: &UserId,
) -> Result<Option<RoomMember>, Error>
pub async fn get_member_no_sync( &self, user_id: &UserId, ) -> Result<Option<RoomMember>, Error>
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.
sourcepub async fn members(
&self,
memberships: RoomMemberships,
) -> Result<Vec<RoomMember>, Error>
pub async fn members( &self, memberships: RoomMemberships, ) -> Result<Vec<RoomMember>, Error>
Get members for this room, with the given memberships.
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.
sourcepub async fn members_no_sync(
&self,
memberships: RoomMemberships,
) -> Result<Vec<RoomMember>, Error>
pub async fn members_no_sync( &self, memberships: RoomMemberships, ) -> Result<Vec<RoomMember>, Error>
Get members for this room, with the given memberships.
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.
sourcepub async fn get_state_events(
&self,
event_type: StateEventType,
) -> Result<Vec<RawAnySyncOrStrippedState>, Error>
pub async fn get_state_events( &self, event_type: StateEventType, ) -> Result<Vec<RawAnySyncOrStrippedState>, Error>
Get all state events of a given type in this room.
sourcepub async fn get_state_events_static<C>(
&self,
) -> Result<Vec<RawSyncOrStrippedState<C>>, Error>where
C: StaticEventContent + StaticStateEventContent + RedactContent,
<C as RedactContent>::Redacted: RedactedStateEventContent,
pub async fn get_state_events_static<C>(
&self,
) -> Result<Vec<RawSyncOrStrippedState<C>>, Error>where
C: StaticEventContent + StaticStateEventContent + RedactContent,
<C as RedactContent>::Redacted: RedactedStateEventContent,
Get all state events of a given statically-known type in this room.
§Examples
use matrix_sdk::ruma::{
events::room::member::RoomMemberEventContent, serde::Raw,
};
let room_members =
room.get_state_events_static::<RoomMemberEventContent>().await?;
sourcepub async fn get_state_events_for_keys(
&self,
event_type: StateEventType,
state_keys: &[&str],
) -> Result<Vec<RawAnySyncOrStrippedState>, Error>
pub async fn get_state_events_for_keys( &self, event_type: StateEventType, state_keys: &[&str], ) -> Result<Vec<RawAnySyncOrStrippedState>, Error>
Get the state events of a given type with the given state keys in this room.
sourcepub async fn get_state_events_for_keys_static<'a, C, K, I>(
&self,
state_keys: I,
) -> Result<Vec<RawSyncOrStrippedState<C>>, Error>where
C: StaticEventContent + StaticStateEventContent + RedactContent,
<C as StateEventContent>::StateKey: Borrow<K>,
<C as RedactContent>::Redacted: RedactedStateEventContent,
K: AsRef<str> + Sync + 'a,
I: IntoIterator<Item = &'a K> + Send,
<I as IntoIterator>::IntoIter: Send,
pub async fn get_state_events_for_keys_static<'a, C, K, I>(
&self,
state_keys: I,
) -> Result<Vec<RawSyncOrStrippedState<C>>, Error>where
C: StaticEventContent + StaticStateEventContent + RedactContent,
<C as StateEventContent>::StateKey: Borrow<K>,
<C as RedactContent>::Redacted: RedactedStateEventContent,
K: AsRef<str> + Sync + 'a,
I: IntoIterator<Item = &'a K> + Send,
<I as IntoIterator>::IntoIter: Send,
Get the state events of a given statically-known type with the given state keys in this room.
§Examples
use matrix_sdk::ruma::events::room::member::RoomMemberEventContent;
let room_members = room
.get_state_events_for_keys_static::<RoomMemberEventContent, _, _>(
user_ids,
)
.await?;
sourcepub async fn get_state_event(
&self,
event_type: StateEventType,
state_key: &str,
) -> Result<Option<RawAnySyncOrStrippedState>, Error>
pub async fn get_state_event( &self, event_type: StateEventType, state_key: &str, ) -> Result<Option<RawAnySyncOrStrippedState>, Error>
Get a specific state event in this room.
sourcepub async fn get_state_event_static<C>(
&self,
) -> Result<Option<RawSyncOrStrippedState<C>>, Error>where
C: StaticEventContent + StaticStateEventContent<StateKey = EmptyStateKey> + RedactContent,
<C as RedactContent>::Redacted: RedactedStateEventContent,
pub async fn get_state_event_static<C>(
&self,
) -> Result<Option<RawSyncOrStrippedState<C>>, Error>where
C: StaticEventContent + StaticStateEventContent<StateKey = EmptyStateKey> + RedactContent,
<C as RedactContent>::Redacted: RedactedStateEventContent,
Get a specific state event of statically-known type with an empty state key in this room.
§Examples
use matrix_sdk::ruma::events::room::power_levels::RoomPowerLevelsEventContent;
let power_levels = room
.get_state_event_static::<RoomPowerLevelsEventContent>()
.await?
.expect("every room has a power_levels event")
.deserialize()?;
sourcepub async fn get_state_event_static_for_key<C, K>(
&self,
state_key: &K,
) -> Result<Option<RawSyncOrStrippedState<C>>, Error>
pub async fn get_state_event_static_for_key<C, K>( &self, state_key: &K, ) -> Result<Option<RawSyncOrStrippedState<C>>, Error>
Get a specific state event of statically-known type in this room.
§Examples
use matrix_sdk::ruma::{
events::room::member::RoomMemberEventContent, serde::Raw, user_id,
};
let member_event = room
.get_state_event_static_for_key::<RoomMemberEventContent, _>(user_id!(
"@alice:example.org"
))
.await?;
sourcepub async fn parent_spaces(
&self,
) -> Result<impl Stream<Item = Result<ParentSpace, Error>>, Error>
pub async fn parent_spaces( &self, ) -> Result<impl Stream<Item = Result<ParentSpace, Error>>, Error>
Returns the parents this room advertises as its parents.
Results are in no particular order.
sourcepub async fn account_data(
&self,
data_type: RoomAccountDataEventType,
) -> Result<Option<Raw<AnyRoomAccountDataEvent>>, Error>
pub async fn account_data( &self, data_type: RoomAccountDataEventType, ) -> Result<Option<Raw<AnyRoomAccountDataEvent>>, Error>
Read account data in this room, from storage.
sourcepub async fn account_data_static<C>(
&self,
) -> Result<Option<Raw<RoomAccountDataEvent<C>>>, Error>where
C: StaticEventContent + RoomAccountDataEventContent,
pub async fn account_data_static<C>(
&self,
) -> Result<Option<Raw<RoomAccountDataEvent<C>>>, Error>where
C: StaticEventContent + RoomAccountDataEventContent,
Get account data of a statically-known type in this room, from storage.
§Examples
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"),
}
sourcepub async fn contains_only_verified_devices(&self) -> Result<bool, Error>
pub async fn contains_only_verified_devices(&self) -> Result<bool, Error>
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.
sourcepub async fn set_account_data<T>(&self, content: T) -> Result<Response, Error>where
T: RoomAccountDataEventContent,
pub async fn set_account_data<T>(&self, content: T) -> Result<Response, Error>where
T: RoomAccountDataEventContent,
Set the given account data event for this room.
§Example
use matrix_sdk::ruma::events::fully_read::FullyReadEventContent;
let content = FullyReadEventContent::new(event_id);
room.set_account_data(content).await?;
sourcepub async fn set_account_data_raw(
&self,
event_type: RoomAccountDataEventType,
content: Raw<AnyRoomAccountDataEventContent>,
) -> Result<Response, Error>
pub async fn set_account_data_raw( &self, event_type: RoomAccountDataEventType, content: Raw<AnyRoomAccountDataEventContent>, ) -> Result<Response, Error>
Set the given raw account data event in this room.
§Example
use matrix_sdk::ruma::{
events::{
marked_unread::MarkedUnreadEventContent,
AnyRoomAccountDataEventContent, EventContent,
},
serde::Raw,
};
let marked_unread_content = MarkedUnreadEventContent::new(true);
let full_event: AnyRoomAccountDataEventContent =
marked_unread_content.clone().into();
room.set_account_data_raw(
marked_unread_content.event_type(),
Raw::new(&full_event).unwrap(),
)
.await?;
sourcepub async fn set_tag(
&self,
tag: TagName,
tag_info: TagInfo,
) -> Result<Response, Error>
pub async fn set_tag( &self, tag: TagName, tag_info: TagInfo, ) -> Result<Response, Error>
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 theorder
parameter.
§Examples
use matrix_sdk::ruma::events::tag::TagInfo;
if let Some(room) = client.get_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?;
}
sourcepub async fn remove_tag(&self, tag: TagName) -> Result<Response, Error>
pub async fn remove_tag(&self, tag: TagName) -> Result<Response, Error>
Removes a tag from the room.
Returns the [delete_tag::v3::Response
] from the server.
§Arguments
tag
- The tag to remove.
sourcepub async fn set_is_favourite(
&self,
is_favourite: bool,
tag_order: Option<f64>,
) -> Result<(), Error>
pub async fn set_is_favourite( &self, is_favourite: bool, tag_order: Option<f64>, ) -> Result<(), Error>
Add or remove the m.favourite
flag for this room.
If is_favourite
is true
, and the m.low_priority
tag is set on the
room, the tag will be removed too.
§Arguments
is_favourite
- Whether to mark this room as favourite.tag_order
- The order of the tag if any.
sourcepub async fn set_is_low_priority(
&self,
is_low_priority: bool,
tag_order: Option<f64>,
) -> Result<(), Error>
pub async fn set_is_low_priority( &self, is_low_priority: bool, tag_order: Option<f64>, ) -> Result<(), Error>
Add or remove the m.lowpriority
flag for this room.
If is_low_priority
is true
, and the m.favourite
tag is set on the
room, the tag will be removed too.
§Arguments
is_low_priority
- Whether to mark this room as low_priority or not.tag_order
- The order of the tag if any.
sourcepub async fn set_is_direct(&self, is_direct: bool) -> Result<(), Error>
pub async fn set_is_direct(&self, is_direct: bool) -> Result<(), Error>
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.
sourcepub async fn decrypt_event(
&self,
event: &Raw<OriginalSyncMessageLikeEvent<RoomEncryptedEventContent>>,
) -> Result<TimelineEvent, Error>
pub async fn decrypt_event( &self, event: &Raw<OriginalSyncMessageLikeEvent<RoomEncryptedEventContent>>, ) -> Result<TimelineEvent, Error>
Tries to decrypt a room event.
§Arguments
event
- The room event to be decrypted.
Returns the decrypted event.
sourcepub async fn discard_room_key(&self) -> Result<(), Error>
pub async fn discard_room_key(&self) -> Result<(), Error>
Forces the currently active room key, which is used to encrypt messages, to be rotated.
A new room key will be crated and shared with all the room members the next time a message will be sent. You don’t have to call this method, room keys will be rotated automatically when necessary. This method is still useful for debugging purposes.
For more info please take a look a the encryption
module
documentation.
sourcepub async fn ban_user(
&self,
user_id: &UserId,
reason: Option<&str>,
) -> Result<(), Error>
pub async fn ban_user( &self, user_id: &UserId, reason: Option<&str>, ) -> Result<(), Error>
Ban the user with UserId
from this room.
§Arguments
-
user_id
- The user to ban withUserId
. -
reason
- The reason for banning this user.
sourcepub async fn unban_user(
&self,
user_id: &UserId,
reason: Option<&str>,
) -> Result<(), Error>
pub async fn unban_user( &self, user_id: &UserId, reason: Option<&str>, ) -> Result<(), Error>
Unban the user with UserId
from this room.
§Arguments
-
user_id
- The user to unban withUserId
. -
reason
- The reason for unbanning this user.
sourcepub async fn kick_user(
&self,
user_id: &UserId,
reason: Option<&str>,
) -> Result<(), Error>
pub async fn kick_user( &self, user_id: &UserId, reason: Option<&str>, ) -> Result<(), Error>
Kick a user out of this room.
§Arguments
-
user_id
- TheUserId
of the user that should be kicked out of the room. -
reason
- Optional reason why the room member is being kicked out.
sourcepub async fn invite_user_by_id(&self, user_id: &UserId) -> Result<(), Error>
pub async fn invite_user_by_id(&self, user_id: &UserId) -> Result<(), Error>
Invite the specified user by UserId
to this room.
§Arguments
user_id
- TheUserId
of the user to invite to the room.
sourcepub async fn invite_user_by_3pid(
&self,
invite_id: Invite3pid,
) -> Result<(), Error>
pub async fn invite_user_by_3pid( &self, invite_id: Invite3pid, ) -> Result<(), Error>
Invite the specified user by third party id to this room.
§Arguments
invite_id
- A third party id of a user to invite to the room.
sourcepub async fn typing_notice(&self, typing: bool) -> Result<(), Error>
pub async fn typing_notice(&self, typing: bool) -> Result<(), Error>
Activate typing notice for this room.
The typing notice remains active for 4s. It can be deactivate at any
point by setting typing to false
. If this method is called while
the typing notice is active nothing will happen. This method can be
called on every key stroke, since it will do nothing while typing is
active.
§Arguments
typing
- Whether the user is typing or has stopped typing.
§Examples
use std::time::Duration;
use matrix_sdk::ruma::api::client::typing::create_typing_event::v3::Typing;
let room_id = room_id!("!SVkFJHzfwvuaIEawgC:localhost");
if let Some(room) = client.get_room(&room_id) {
room.typing_notice(true).await?
}
sourcepub async fn send_single_receipt(
&self,
receipt_type: ReceiptType,
thread: ReceiptThread,
event_id: OwnedEventId,
) -> Result<(), Error>
pub async fn send_single_receipt( &self, receipt_type: ReceiptType, thread: ReceiptThread, event_id: OwnedEventId, ) -> Result<(), Error>
Send a request to set a single receipt.
§Arguments
-
receipt_type
- The type of the receipt to set. Note that it is possible to set the fully-read marker although it is technically not a receipt. -
thread
- The thread where this receipt should apply, if any. Note that this must be [ReceiptThread::Unthreaded
] when sending a [ReceiptType::FullyRead
][create_receipt::v3::ReceiptType::FullyRead]. -
event_id
- TheEventId
of the event to set the receipt on.
sourcepub async fn send_multiple_receipts(
&self,
receipts: Receipts,
) -> Result<(), Error>
pub async fn send_multiple_receipts( &self, receipts: Receipts, ) -> Result<(), Error>
Send a request to set multiple receipts at once.
§Arguments
receipts
- TheReceipts
to send.
If receipts
is empty, this is a no-op.
sourcepub async fn enable_encryption(&self) -> Result<(), Error>
pub async fn enable_encryption(&self) -> Result<(), Error>
Enable End-to-end encryption in this room.
This method will be a noop if encryption is already enabled, otherwise
sends a m.room.encryption
state event to the room. This might fail if
you don’t have the appropriate power level to enable end-to-end
encryption.
A sync needs to be received to update the local room state. This method will wait for a sync to be received, this might time out if no sync loop is running or if the server is slow.
§Examples
let room_id = room_id!("!SVkFJHzfwvuaIEawgC:localhost");
if let Some(room) = client.get_room(&room_id) {
room.enable_encryption().await?
}
sourcepub async fn sync_up(&self)
pub async fn sync_up(&self)
Wait for the room to be fully synced.
This method makes sure the room that was returned when joining a room has been echoed back in the sync.
Warning: This waits until a sync happens and does not return if no sync is happening. It can also return early when the room is not a joined room anymore.
sourcepub fn send(
&self,
content: impl MessageLikeEventContent,
) -> SendMessageLikeEvent<'_>
pub fn send( &self, content: impl MessageLikeEventContent, ) -> SendMessageLikeEvent<'_>
Send a message-like event to this room.
Returns the parsed response from the server.
If the encryption feature is enabled this method will transparently
encrypt the event if this room is encrypted (except for m.reaction
events, which are never encrypted).
Note: If you just want to send an event with custom JSON content to
a room, you can use the send_raw()
method for that.
If you want to set a transaction ID for the event, use
.with_transaction_id()
on the returned value before .await
ing it.
§Arguments
content
- The content of the message event.
§Examples
use matrix_sdk::ruma::{
events::{
macros::EventContent,
room::message::{RoomMessageEventContent, TextMessageEventContent},
},
uint, MilliSecondsSinceUnixEpoch, TransactionId,
};
let content = RoomMessageEventContent::text_plain("Hello world");
let txn_id = TransactionId::new();
if let Some(room) = client.get_room(&room_id) {
room.send(content).with_transaction_id(&txn_id).await?;
}
// Custom events work too:
#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
#[ruma_event(type = "org.shiny_new_2fa.token", kind = MessageLike)]
struct TokenEventContent {
token: String,
#[serde(rename = "exp")]
expires_at: MilliSecondsSinceUnixEpoch,
}
let content = TokenEventContent {
token: generate_token(),
expires_at: {
let now = MilliSecondsSinceUnixEpoch::now();
MilliSecondsSinceUnixEpoch(now.0 + uint!(30_000))
},
};
if let Some(room) = client.get_room(&room_id) {
room.send(content).await?;
}
sourcepub fn send_raw<'a>(
&'a self,
event_type: &'a str,
content: impl IntoRawMessageLikeEventContent,
) -> SendRawMessageLikeEvent<'a>
pub fn send_raw<'a>( &'a self, event_type: &'a str, content: impl IntoRawMessageLikeEventContent, ) -> SendRawMessageLikeEvent<'a>
Send a message-like event with custom JSON content to this room.
Returns the parsed response from the server.
If the encryption feature is enabled this method will transparently
encrypt the event if this room is encrypted (except for m.reaction
events, which are never encrypted).
This method is equivalent to the send()
method but
allows sending custom JSON payloads, e.g. constructed using the
serde_json::json!()
macro.
If you want to set a transaction ID for the event, use
.with_transaction_id()
on the returned value before .await
ing it.
§Arguments
-
event_type
- The type of the event. -
content
- The content of the event as a raw JSON value. The argument type can beserde_json::Value
, but also other raw JSON types; for the full list check the documentation ofIntoRawMessageLikeEventContent
.
§Examples
use serde_json::json;
if let Some(room) = client.get_room(&room_id) {
room.send_raw("m.room.message", json!({ "body": "Hello world" })).await?;
}
sourcepub fn send_attachment<'a>(
&'a self,
filename: &'a str,
content_type: &'a Mime,
data: Vec<u8>,
config: AttachmentConfig,
) -> SendAttachment<'a>
pub fn send_attachment<'a>( &'a self, filename: &'a str, content_type: &'a Mime, data: Vec<u8>, config: AttachmentConfig, ) -> SendAttachment<'a>
Send an attachment to this room.
This will upload the given data that the reader produces using the
upload()
method and post an event to the given room.
If the room is encrypted and the encryption feature is enabled the
upload will be encrypted.
This is a convenience method that calls the
upload()
and afterwards the send()
.
§Arguments
-
filename
- The file name. -
content_type
- The type of the media, this will be used as the content-type header. -
reader
- AReader
that will be used to fetch the raw bytes of the media. -
config
- Metadata and configuration for the attachment.
§Examples
let mut image = fs::read("/home/example/my-cat.jpg")?;
if let Some(room) = client.get_room(&room_id) {
room.send_attachment(
"my_favorite_cat.jpg",
&mime::IMAGE_JPEG,
image,
AttachmentConfig::new(),
).await?;
}
sourcepub async fn update_power_levels(
&self,
updates: Vec<(&UserId, Int)>,
) -> Result<Response, Error>
pub async fn update_power_levels( &self, updates: Vec<(&UserId, Int)>, ) -> Result<Response, Error>
Update the power levels of a select set of users of this room.
Issue a power_levels
state event request to the server, changing the
given UserId -> Int levels. May fail if the power_levels
aren’t
locally known yet or the server rejects the state event update, e.g.
because of insufficient permissions. Neither permissions to update
nor whether the data might be stale is checked prior to issuing the
request.
sourcepub async fn apply_power_level_changes(
&self,
changes: RoomPowerLevelChanges,
) -> Result<(), Error>
pub async fn apply_power_level_changes( &self, changes: RoomPowerLevelChanges, ) -> Result<(), Error>
Applies a set of power level changes to this room.
Any values that are None
in the given RoomPowerLevelChanges
will
remain unchanged.
sourcepub async fn room_power_levels(&self) -> Result<RoomPowerLevels, Error>
pub async fn room_power_levels(&self) -> Result<RoomPowerLevels, Error>
Get the current power levels of this room.
sourcepub async fn reset_power_levels(&self) -> Result<RoomPowerLevels, Error>
pub async fn reset_power_levels(&self) -> Result<RoomPowerLevels, Error>
Resets the room’s power levels to the default values
sourcepub async fn get_suggested_user_role(
&self,
user_id: &UserId,
) -> Result<RoomMemberRole, Error>
pub async fn get_suggested_user_role( &self, user_id: &UserId, ) -> Result<RoomMemberRole, Error>
Gets the suggested role for the user with the provided user_id
.
This method checks the RoomPowerLevels
events instead of loading the
member list and looking for the member.
sourcepub async fn get_user_power_level(&self, user_id: &UserId) -> Result<i64, Error>
pub async fn get_user_power_level(&self, user_id: &UserId) -> Result<i64, Error>
Gets the power level the user with the provided user_id
.
This method checks the RoomPowerLevels
events instead of loading the
member list and looking for the member.
sourcepub async fn users_with_power_levels(&self) -> HashMap<OwnedUserId, i64>
pub async fn users_with_power_levels(&self) -> HashMap<OwnedUserId, i64>
Gets a map with the UserId
of users with power levels other than 0
and this power level.
sourcepub async fn set_name(&self, name: String) -> Result<Response, Error>
pub async fn set_name(&self, name: String) -> Result<Response, Error>
Sets the name of this room.
sourcepub async fn set_room_topic(&self, topic: &str) -> Result<Response, Error>
pub async fn set_room_topic(&self, topic: &str) -> Result<Response, Error>
Sets a new topic for this room.
sourcepub async fn set_avatar_url(
&self,
url: &MxcUri,
info: Option<ImageInfo>,
) -> Result<Response, Error>
pub async fn set_avatar_url( &self, url: &MxcUri, info: Option<ImageInfo>, ) -> Result<Response, Error>
Sets the new avatar url for this room.
§Arguments
avatar_url
- The owned matrix uri that represents the avatarinfo
- The optional image info that can be provided for the avatar
sourcepub async fn remove_avatar(&self) -> Result<Response, Error>
pub async fn remove_avatar(&self) -> Result<Response, Error>
Removes the avatar from the room
sourcepub async fn upload_avatar(
&self,
mime: &Mime,
data: Vec<u8>,
info: Option<ImageInfo>,
) -> Result<Response, Error>
pub async fn upload_avatar( &self, mime: &Mime, data: Vec<u8>, info: Option<ImageInfo>, ) -> Result<Response, Error>
Uploads a new avatar for this room.
§Arguments
mime
- The mime type describing the datadata
- The data representation of the avatarinfo
- The optional image info provided for the avatar, the blurhash and the mimetype will always be updated
sourcepub async fn send_state_event(
&self,
content: impl StateEventContent<StateKey = EmptyStateKey>,
) -> Result<Response, Error>
pub async fn send_state_event( &self, content: impl StateEventContent<StateKey = EmptyStateKey>, ) -> Result<Response, Error>
Send a state event with an empty state key to the homeserver.
For state events with a non-empty state key, see
send_state_event_for_key
.
Returns the parsed response from the server.
§Arguments
content
- The content of the state event.
§Examples
use matrix_sdk::ruma::{
events::{
macros::EventContent, room::encryption::RoomEncryptionEventContent,
EmptyStateKey,
},
EventEncryptionAlgorithm,
};
let encryption_event_content = RoomEncryptionEventContent::new(
EventEncryptionAlgorithm::MegolmV1AesSha2,
);
joined_room.send_state_event(encryption_event_content).await?;
// Custom event:
#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
#[ruma_event(
type = "org.matrix.msc_9000.xxx",
kind = State,
state_key_type = EmptyStateKey,
)]
struct XxxStateEventContent {/* fields... */}
let content: XxxStateEventContent = todo!();
joined_room.send_state_event(content).await?;
sourcepub async fn send_state_event_for_key<C, K>(
&self,
state_key: &K,
content: C,
) -> Result<Response, Error>
pub async fn send_state_event_for_key<C, K>( &self, state_key: &K, content: C, ) -> Result<Response, Error>
Send a state event to the homeserver.
Returns the parsed response from the server.
§Arguments
-
content
- The content of the state event. -
state_key
- A unique key which defines the overwriting semantics for this piece of room state.
§Examples
use matrix_sdk::ruma::{
events::{
macros::EventContent,
room::member::{RoomMemberEventContent, MembershipState},
},
mxc_uri,
};
let avatar_url = mxc_uri!("mxc://example.org/avatar").to_owned();
let mut content = RoomMemberEventContent::new(MembershipState::Join);
content.avatar_url = Some(avatar_url);
joined_room.send_state_event_for_key(ruma::user_id!("@foo:bar.com"), content).await?;
// Custom event:
#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
#[ruma_event(type = "org.matrix.msc_9000.xxx", kind = State, state_key_type = String)]
struct XxxStateEventContent { /* fields... */ }
let content: XxxStateEventContent = todo!();
joined_room.send_state_event_for_key("foo", content).await?;
sourcepub async fn send_state_event_raw(
&self,
event_type: &str,
state_key: &str,
content: impl IntoRawStateEventContent,
) -> Result<Response, Error>
pub async fn send_state_event_raw( &self, event_type: &str, state_key: &str, content: impl IntoRawStateEventContent, ) -> Result<Response, Error>
Send a raw room state event to the homeserver.
Returns the parsed response from the server.
§Arguments
-
event_type
- The type of the event that we’re sending out. -
state_key
- A unique key which defines the overwriting semantics for this piece of room state. This value is often a zero-length string. -
content
- The content of the event as a raw JSON value. The argument type can beserde_json::Value
, but also other raw JSON types; for the full list check the documentation ofIntoRawStateEventContent
.
§Examples
use serde_json::json;
if let Some(room) = client.get_room(&room_id) {
room.send_state_event_raw("m.room.member", "", json!({
"avatar_url": "mxc://example.org/SEsfnsuifSDFSSEF",
"displayname": "Alice Margatroid",
"membership": "join",
})).await?;
}
sourcepub async fn redact(
&self,
event_id: &EventId,
reason: Option<&str>,
txn_id: Option<OwnedTransactionId>,
) -> Result<Response, HttpError>
pub async fn redact( &self, event_id: &EventId, reason: Option<&str>, txn_id: Option<OwnedTransactionId>, ) -> Result<Response, HttpError>
Strips all information out of an event of the room.
Returns the [redact_event::v3::Response
] from the server.
This cannot be undone. Users may redact their own events, and any user with a power level greater than or equal to the redact power level of the room may redact events there.
§Arguments
-
event_id
- The ID of the event to redact -
reason
- The reason for the event being redacted. -
txn_id
- A unique ID that can be attached to this event as its transaction ID. If not given one is created for the message.
§Examples
use matrix_sdk::ruma::event_id;
if let Some(room) = client.get_room(&room_id) {
let event_id = event_id!("$xxxxxx:example.org");
let reason = Some("Indecent material");
room.redact(&event_id, reason, None).await?;
}
sourcepub async fn can_user_redact_own(&self, user_id: &UserId) -> Result<bool, Error>
pub async fn can_user_redact_own(&self, user_id: &UserId) -> Result<bool, Error>
Returns true if the user with the given user_id is able to redact their own messages in the room.
The call may fail if there is an error in getting the power levels.
sourcepub async fn can_user_redact_other(
&self,
user_id: &UserId,
) -> Result<bool, Error>
pub async fn can_user_redact_other( &self, user_id: &UserId, ) -> Result<bool, Error>
Returns true if the user with the given user_id is able to redact messages of other users in the room.
The call may fail if there is an error in getting the power levels.
sourcepub async fn can_user_ban(&self, user_id: &UserId) -> Result<bool, Error>
pub async fn can_user_ban(&self, user_id: &UserId) -> Result<bool, Error>
Returns true if the user with the given user_id is able to ban in the room.
The call may fail if there is an error in getting the power levels.
sourcepub async fn can_user_invite(&self, user_id: &UserId) -> Result<bool, Error>
pub async fn can_user_invite(&self, user_id: &UserId) -> Result<bool, Error>
Returns true if the user with the given user_id is able to kick in the room.
The call may fail if there is an error in getting the power levels.
sourcepub async fn can_user_kick(&self, user_id: &UserId) -> Result<bool, Error>
pub async fn can_user_kick(&self, user_id: &UserId) -> Result<bool, Error>
Returns true if the user with the given user_id is able to kick in the room.
The call may fail if there is an error in getting the power levels.
sourcepub async fn can_user_send_state(
&self,
user_id: &UserId,
state_event: StateEventType,
) -> Result<bool, Error>
pub async fn can_user_send_state( &self, user_id: &UserId, state_event: StateEventType, ) -> Result<bool, Error>
Returns true if the user with the given user_id is able to send a specific state event type in the room.
The call may fail if there is an error in getting the power levels.
sourcepub async fn can_user_send_message(
&self,
user_id: &UserId,
message: MessageLikeEventType,
) -> Result<bool, Error>
pub async fn can_user_send_message( &self, user_id: &UserId, message: MessageLikeEventType, ) -> Result<bool, Error>
Returns true if the user with the given user_id is able to send a specific message type in the room.
The call may fail if there is an error in getting the power levels.
sourcepub async fn can_user_pin_unpin(&self, user_id: &UserId) -> Result<bool, Error>
pub async fn can_user_pin_unpin(&self, user_id: &UserId) -> Result<bool, Error>
Returns true if the user with the given user_id is able to pin or unpin events in the room.
The call may fail if there is an error in getting the power levels.
sourcepub async fn can_user_trigger_room_notification(
&self,
user_id: &UserId,
) -> Result<bool, Error>
pub async fn can_user_trigger_room_notification( &self, user_id: &UserId, ) -> Result<bool, Error>
Returns true if the user with the given user_id is able to trigger a notification in the room.
The call may fail if there is an error in getting the power levels.
sourcepub async fn route(&self) -> Result<Vec<OwnedServerName>, Error>
pub async fn route(&self) -> Result<Vec<OwnedServerName>, Error>
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.
sourcepub async fn matrix_to_permalink(&self) -> Result<MatrixToUri, Error>
pub async fn matrix_to_permalink(&self) -> Result<MatrixToUri, Error>
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.
sourcepub async fn matrix_permalink(&self, join: bool) -> Result<MatrixUri, Error>
pub async fn matrix_permalink(&self, join: bool) -> Result<MatrixUri, Error>
sourcepub async fn matrix_to_event_permalink(
&self,
event_id: impl Into<OwnedEventId>,
) -> Result<MatrixToUri, Error>
pub async fn matrix_to_event_permalink( &self, event_id: impl Into<OwnedEventId>, ) -> Result<MatrixToUri, Error>
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.
sourcepub async fn matrix_event_permalink(
&self,
event_id: impl Into<OwnedEventId>,
) -> Result<MatrixUri, Error>
pub async fn matrix_event_permalink( &self, event_id: impl Into<OwnedEventId>, ) -> Result<MatrixUri, Error>
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.
sourcepub async fn load_user_receipt(
&self,
receipt_type: ReceiptType,
thread: ReceiptThread,
user_id: &UserId,
) -> Result<Option<(OwnedEventId, Receipt)>, Error>
pub async fn load_user_receipt( &self, receipt_type: ReceiptType, thread: ReceiptThread, user_id: &UserId, ) -> Result<Option<(OwnedEventId, Receipt)>, Error>
Get the latest receipt of a user in this room.
§Arguments
-
receipt_type
- The type of receipt to get. -
thread
- The thread containing the event of the receipt, if any. -
user_id
- The ID of the user.
Returns the ID of the event on which the receipt applies and the receipt.
sourcepub async fn load_event_receipts(
&self,
receipt_type: ReceiptType,
thread: ReceiptThread,
event_id: &EventId,
) -> Result<Vec<(OwnedUserId, Receipt)>, Error>
pub async fn load_event_receipts( &self, receipt_type: ReceiptType, thread: ReceiptThread, event_id: &EventId, ) -> Result<Vec<(OwnedUserId, Receipt)>, Error>
Load the receipts for an event in this room from storage.
§Arguments
-
receipt_type
- The type of receipt to get. -
thread
- The thread containing the event of the receipt, if any. -
event_id
- The ID of the event.
Returns a list of IDs of users who have sent a receipt for the event and the corresponding receipts.
sourcepub async fn push_context(&self) -> Result<Option<PushConditionRoomCtx>, Error>
pub async fn push_context(&self) -> Result<Option<PushConditionRoomCtx>, Error>
Get the push context for this room.
Returns None
if some data couldn’t be found. This should only happen
in brand new rooms, while we process its state.
sourcepub async fn event_push_actions<T>(
&self,
event: &Raw<T>,
) -> Result<Option<Vec<Action>>, Error>
pub async fn event_push_actions<T>( &self, event: &Raw<T>, ) -> Result<Option<Vec<Action>>, Error>
Get the push actions for the given event with the current room state.
Note that it is possible that no push action is returned because the current room state does not have all the required state events.
sourcepub async fn invite_details(&self) -> Result<Invite, Error>
pub async fn invite_details(&self) -> Result<Invite, Error>
The membership details of the (latest) invite for the logged-in user in this room.
sourcepub async fn forget(&self) -> Result<(), Error>
pub async fn forget(&self) -> Result<(), Error>
Forget this room.
This communicates to the homeserver that it should forget the room.
Only left rooms can be forgotten.
sourcepub async fn notification_mode(&self) -> Option<RoomNotificationMode>
pub async fn notification_mode(&self) -> Option<RoomNotificationMode>
Get the notification mode.
sourcepub async fn user_defined_notification_mode(
&self,
) -> Option<RoomNotificationMode>
pub async fn user_defined_notification_mode( &self, ) -> Option<RoomNotificationMode>
Get the user-defined notification mode.
The result is cached for fast and non-async call. To read the cached
result, use
matrix_sdk_base::Room::cached_user_defined_notification_mode
.
sourcepub async fn report_content(
&self,
event_id: OwnedEventId,
score: Option<ReportedContentScore>,
reason: Option<String>,
) -> Result<Response, Error>
pub async fn report_content( &self, event_id: OwnedEventId, score: Option<ReportedContentScore>, reason: Option<String>, ) -> Result<Response, Error>
Report an event as inappropriate to the homeserver’s administrator.
§Arguments
event_id
- The ID of the event to report.score
- The score to rate this content.reason
- The reason the content is being reported.
§Errors
Returns an error if the room is not joined or if an error occurs with the request.
sourcepub async fn set_unread_flag(&self, unread: bool) -> Result<(), Error>
pub async fn set_unread_flag(&self, unread: bool) -> Result<(), Error>
Set a flag on the room to indicate that the user has explicitly marked it as (un)read.
sourcepub async fn event_cache(
&self,
) -> Result<(RoomEventCache, Arc<EventCacheDropHandles>), EventCacheError>
pub async fn event_cache( &self, ) -> Result<(RoomEventCache, Arc<EventCacheDropHandles>), EventCacheError>
Returns the RoomEventCache
associated to this room, assuming the
global [EventCache
] has been enabled for subscription.
sourcepub async fn send_call_notification_if_needed(&self) -> Result<(), Error>
pub async fn send_call_notification_if_needed(&self) -> Result<(), Error>
This will only send a call notification event if appropriate.
This function is supposed to be called whenever the user creates a room
call. It will send a m.call.notify
event if:
- there is not yet a running call.
It will configure the notify type: ring or notify based on:
- is this a DM room -> ring
- is this a group with more than one other member -> notify
Stop sharing live location in the room.
§Errors
Returns an error if the room is not joined, if the beacon information is redacted or stripped, or if the state event is not found.
sourcepub async fn send_location_beacon(
&self,
geo_uri: String,
) -> Result<Response, BeaconError>
pub async fn send_location_beacon( &self, geo_uri: String, ) -> Result<Response, BeaconError>
sourcepub async fn send_call_notification(
&self,
call_id: String,
application: ApplicationType,
notify_type: NotifyType,
mentions: Mentions,
) -> Result<(), Error>
pub async fn send_call_notification( &self, call_id: String, application: ApplicationType, notify_type: NotifyType, mentions: Mentions, ) -> Result<(), Error>
Send a call notification event in the current room.
This is only supposed to be used in custom situations where the user
explicitly chooses to send a m.call.notify
event to invite/notify
someone explicitly in unusual conditions. The default should be to
use send_call_notification_if_needed
just before a new room call is
created/joined.
One example could be that the UI allows to start a call with a subset of users of the room members first. And then later on the user can invite more users to the call.
sourcepub async fn save_composer_draft(
&self,
draft: ComposerDraft,
) -> Result<(), Error>
pub async fn save_composer_draft( &self, draft: ComposerDraft, ) -> Result<(), Error>
Store the given ComposerDraft
in the state store using the current
room id, as identifier.
sourcepub async fn load_composer_draft(&self) -> Result<Option<ComposerDraft>, Error>
pub async fn load_composer_draft(&self) -> Result<Option<ComposerDraft>, Error>
Retrieve the ComposerDraft
stored in the state store for this room.
sourcepub async fn clear_composer_draft(&self) -> Result<(), Error>
pub async fn clear_composer_draft(&self) -> Result<(), Error>
Remove the ComposerDraft
stored in the state store for this room.
sourcepub fn send_queue(&self) -> RoomSendQueue
pub fn send_queue(&self) -> RoomSendQueue
Returns the RoomSendQueue
for this specific room.
Methods from Deref<Target = Room>§
sourcepub fn own_user_id(&self) -> &UserId
pub fn own_user_id(&self) -> &UserId
Get our own user id.
sourcepub fn room_type(&self) -> Option<RoomType>
pub fn room_type(&self) -> Option<RoomType>
Returns the room’s type as defined in its creation event
(m.room.create
).
sourcepub fn unread_notification_counts(&self) -> UnreadNotificationsCount
pub fn unread_notification_counts(&self) -> UnreadNotificationsCount
Get the unread notification counts.
sourcepub fn num_unread_messages(&self) -> u64
pub fn num_unread_messages(&self) -> u64
Get the number of unread messages (computed client-side).
This might be more precise than Self::unread_notification_counts
for
encrypted rooms.
sourcepub fn read_receipts(&self) -> RoomReadReceipts
pub fn read_receipts(&self) -> RoomReadReceipts
Get the detailed information about read receipts for the room.
sourcepub fn num_unread_notifications(&self) -> u64
pub fn num_unread_notifications(&self) -> u64
Get the number of unread notifications (computed client-side).
This might be more precise than Self::unread_notification_counts
for
encrypted rooms.
sourcepub fn num_unread_mentions(&self) -> u64
pub fn num_unread_mentions(&self) -> u64
Get the number of unread mentions (computed client-side), that is, messages causing a highlight in a room.
This might be more precise than Self::unread_notification_counts
for
encrypted rooms.
sourcepub fn are_members_synced(&self) -> bool
pub fn are_members_synced(&self) -> bool
Check if the room has its 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.
sourcepub fn mark_members_missing(&self)
pub fn mark_members_missing(&self)
Mark this Room as still missing member information.
sourcepub fn is_state_fully_synced(&self) -> bool
pub fn is_state_fully_synced(&self) -> bool
Check if the room states have been synced
States might be missing if we have only seen the room_id of this Room
so far, for example as the response for a create_room
request without
being synced yet.
Returns true if the state is fully synced, false otherwise.
sourcepub fn is_state_partially_or_fully_synced(&self) -> bool
pub fn is_state_partially_or_fully_synced(&self) -> bool
Check if the room state has been at least partially synced.
See Room::is_state_fully_synced
for more info.
sourcepub fn is_encryption_state_synced(&self) -> bool
pub fn is_encryption_state_synced(&self) -> bool
Check if the room has its encryption event synced.
The encryption event can be missing when the room hasn’t appeared in sync yet.
Returns true if the encryption state is synced, false otherwise.
sourcepub fn last_prev_batch(&self) -> Option<String>
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.
sourcepub fn avatar_url(&self) -> Option<OwnedMxcUri>
pub fn avatar_url(&self) -> Option<OwnedMxcUri>
Get the avatar url of this room.
sourcepub fn avatar_info(&self) -> Option<ImageInfo>
pub fn avatar_info(&self) -> Option<ImageInfo>
Get information about the avatar of this room.
sourcepub fn canonical_alias(&self) -> Option<OwnedRoomAliasId>
pub fn canonical_alias(&self) -> Option<OwnedRoomAliasId>
Get the canonical alias of this room.
sourcepub fn alt_aliases(&self) -> Vec<OwnedRoomAliasId>
pub fn alt_aliases(&self) -> Vec<OwnedRoomAliasId>
Get the canonical alias of this room.
sourcepub fn create_content(&self) -> Option<RoomCreateWithCreatorEventContent>
pub fn create_content(&self) -> Option<RoomCreateWithCreatorEventContent>
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.
For room versions earlier than room version 11, if the event is
redacted, all fields except creator
will be set to their default
value.
sourcepub async fn is_direct(&self) -> Result<bool, StoreError>
pub async fn is_direct(&self) -> Result<bool, StoreError>
Is this room considered a direct message.
Async because it can read room info from storage.
sourcepub fn direct_targets(&self) -> HashSet<OwnedUserId>
pub fn direct_targets(&self) -> HashSet<OwnedUserId>
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. We leave members in this list to allow us to re-find a DM with a user even if they have left, since we may want to re-invite them.
sourcepub fn direct_targets_length(&self) -> usize
pub fn direct_targets_length(&self) -> usize
If this room is a direct message, returns the number of members that we’re sharing the room with.
sourcepub fn is_encrypted(&self) -> bool
pub fn is_encrypted(&self) -> bool
Is the room encrypted.
sourcepub fn encryption_settings(&self) -> Option<RoomEncryptionEventContent>
pub fn encryption_settings(&self) -> Option<RoomEncryptionEventContent>
Get the m.room.encryption
content that enabled end to end encryption
in the room.
sourcepub fn guest_access(&self) -> GuestAccess
pub fn guest_access(&self) -> GuestAccess
Get the guest access policy of this room.
sourcepub fn history_visibility(&self) -> HistoryVisibility
pub fn history_visibility(&self) -> HistoryVisibility
Get the history visibility policy of this room.
sourcepub fn max_power_level(&self) -> i64
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.
sourcepub fn name(&self) -> Option<String>
pub fn name(&self) -> Option<String>
Get the m.room.name
of this room.
The returned string may be empty if the event has been redacted, or it’s missing from storage.
sourcepub fn is_tombstoned(&self) -> bool
pub fn is_tombstoned(&self) -> bool
Has the room been tombstoned.
sourcepub fn tombstone(&self) -> Option<RoomTombstoneEventContent>
pub fn tombstone(&self) -> Option<RoomTombstoneEventContent>
Get the m.room.tombstone
content of this room if there is one.
sourcepub fn has_active_room_call(&self) -> bool
pub fn has_active_room_call(&self) -> bool
Is there a non expired membership with application “m.call” and scope “m.room” in this room
sourcepub fn active_room_call_participants(&self) -> Vec<OwnedUserId>
pub fn active_room_call_participants(&self) -> Vec<OwnedUserId>
Returns a Vec of userId’s that participate in the room call.
MatrixRTC memberships with application “m.call” and scope “m.room” are considered. A user can occur twice if they join with two devices. convert to a set depending if the different users are required or the amount of sessions.
The vector is ordered by oldest membership user to newest.
sourcepub async fn compute_display_name(&self) -> Result<DisplayName, StoreError>
pub async fn compute_display_name(&self) -> Result<DisplayName, StoreError>
Return the cached display name of the room if it was provided via sync, or otherwise calculate it, taking into account its name, aliases and members.
The display name is calculated according to this algorithm.
This is automatically recomputed on every successful sync, and the
cached result can be retrieved in
Self::cached_display_name
.
sourcepub fn cached_display_name(&self) -> Option<DisplayName>
pub fn cached_display_name(&self) -> Option<DisplayName>
Returns the cached computed display name, if available.
This cache is refilled every time we call
Self::compute_display_name
.
sourcepub fn update_cached_user_defined_notification_mode(
&self,
mode: RoomNotificationMode,
)
pub fn update_cached_user_defined_notification_mode( &self, mode: RoomNotificationMode, )
Update the cached user defined notification mode.
This is automatically recomputed on every successful sync, and the
cached result can be retrieved in
Self::cached_user_defined_notification_mode
.
sourcepub fn cached_user_defined_notification_mode(
&self,
) -> Option<RoomNotificationMode>
pub fn cached_user_defined_notification_mode( &self, ) -> Option<RoomNotificationMode>
Returns the cached user defined notification mode, if available.
This cache is refilled every time we call
Self::update_cached_user_defined_notification_mode
.
sourcepub fn latest_event(&self) -> Option<LatestEvent>
pub fn latest_event(&self) -> Option<LatestEvent>
Return the last event in this room, if one has been cached during sliding sync.
sourcepub async fn joined_user_ids(&self) -> Result<Vec<OwnedUserId>, StoreError>
pub async fn joined_user_ids(&self) -> Result<Vec<OwnedUserId>, StoreError>
Get the list of users ids that are considered to be joined members of this room.
sourcepub async fn members(
&self,
memberships: RoomMemberships,
) -> Result<Vec<RoomMember>, StoreError>
pub async fn members( &self, memberships: RoomMemberships, ) -> Result<Vec<RoomMember>, StoreError>
Get the RoomMember
s of this room that are known to the store, with the
given memberships.
sourcepub fn active_members_count(&self) -> u64
pub fn active_members_count(&self) -> u64
Returns the number of members who have joined or been invited to the room.
sourcepub fn invited_members_count(&self) -> u64
pub fn invited_members_count(&self) -> u64
Returns the number of members who have been invited to the room.
sourcepub fn joined_members_count(&self) -> u64
pub fn joined_members_count(&self) -> u64
Returns the number of members who have joined the room.
sourcepub fn subscribe_info(&self) -> Subscriber<RoomInfo>
pub fn subscribe_info(&self) -> Subscriber<RoomInfo>
Subscribe to the inner RoomInfo
.
sourcepub fn clone_info(&self) -> RoomInfo
pub fn clone_info(&self) -> RoomInfo
Clone the inner RoomInfo
.
sourcepub fn set_room_info(
&self,
room_info: RoomInfo,
room_info_notable_update_reasons: RoomInfoNotableUpdateReasons,
)
pub fn set_room_info( &self, room_info: RoomInfo, room_info_notable_update_reasons: RoomInfoNotableUpdateReasons, )
Update the summary with given RoomInfo.
sourcepub 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.
Async because it can read from storage.
Get the Tags
for this room.
sourcepub fn is_favourite(&self) -> bool
pub fn is_favourite(&self) -> bool
Check whether the room is marked as favourite.
A room is considered favourite if it has received the m.favourite
tag.
sourcepub fn is_low_priority(&self) -> bool
pub fn is_low_priority(&self) -> bool
Check whether the room is marked as low priority.
A room is considered low priority if it has received the m.lowpriority
tag.
sourcepub async fn load_user_receipt(
&self,
receipt_type: ReceiptType,
thread: ReceiptThread,
user_id: &UserId,
) -> Result<Option<(OwnedEventId, Receipt)>, StoreError>
pub async fn load_user_receipt( &self, receipt_type: ReceiptType, thread: ReceiptThread, user_id: &UserId, ) -> Result<Option<(OwnedEventId, Receipt)>, StoreError>
Get the receipt as an OwnedEventId
and Receipt
tuple for the given
receipt_type
, thread
and user_id
in this room.
sourcepub async fn load_event_receipts(
&self,
receipt_type: ReceiptType,
thread: ReceiptThread,
event_id: &EventId,
) -> Result<Vec<(OwnedUserId, Receipt)>, StoreError>
pub async fn load_event_receipts( &self, receipt_type: ReceiptType, thread: ReceiptThread, event_id: &EventId, ) -> Result<Vec<(OwnedUserId, Receipt)>, StoreError>
Load from storage the receipts as a list of OwnedUserId
and Receipt
tuples for the given receipt_type
, thread
and event_id
in this
room.
sourcepub fn is_marked_unread(&self) -> bool
pub fn is_marked_unread(&self) -> bool
Returns a boolean indicating if this room has been manually marked as unread
sourcepub fn recency_stamp(&self) -> Option<u64>
pub fn recency_stamp(&self) -> Option<u64>
Returns the recency stamp of the room.
Please read RoomInfo::recency_stamp
to learn more.
sourcepub fn pinned_event_ids_stream(&self) -> impl Stream<Item = Vec<OwnedEventId>>
pub fn pinned_event_ids_stream(&self) -> impl Stream<Item = Vec<OwnedEventId>>
Get a Stream
of loaded pinned events for this room.
If no pinned events are found a single empty Vec
will be returned.
sourcepub fn pinned_event_ids(&self) -> Vec<OwnedEventId>
pub fn pinned_event_ids(&self) -> Vec<OwnedEventId>
Returns the current pinned event ids for this room.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Room
impl !RefUnwindSafe for Room
impl Send for Room
impl Sync for Room
impl Unpin for Room
impl !UnwindSafe for Room
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> CompatExt for T
impl<T> CompatExt for T
source§impl<T> FutureExt for T
impl<T> FutureExt for T
source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
source§impl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
source§fn consume_handle(handle: Handle) -> Arc<T>
fn consume_handle(handle: Handle) -> Arc<T>
Arc<>
source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more