Struct Room

#[repr(transparent)]
pub struct Room {
    inner: TypedObjectRef<Room, <Room as ObjectSubclass>::ParentType>,
    phantom: PhantomData<()>,
}

GObject representation of a Matrix room.

Handles populating the Timeline.

GLib type: GObject with reference counted clone semantics.

Fields

inner: TypedObjectRef<Room, <Room as ObjectSubclass>::ParentType>

phantom: PhantomData<()>

Implementations

impl Room

pub fn session(&self) -> <WeakRef<Session> as Property>::Value

pub fn room_id_string(&self) -> <PhantomData<String> as Property>::Value

pub fn aliases(&self) -> <RoomAliases as Property>::Value

pub fn name(&self) -> <RefCell<Option<String>> as Property>::Value

pub fn has_avatar(&self) -> <Cell<bool> as Property>::Value

pub fn topic(&self) -> <RefCell<Option<String>> as Property>::Value

pub fn topic_linkified(&self) -> <RefCell<Option<String>> as Property>::Value

pub fn category(&self) -> <Cell<RoomCategory> as Property>::Value

pub fn is_direct(&self) -> <Cell<bool> as Property>::Value

pub fn is_tombstoned(&self) -> <Cell<bool> as Property>::Value

pub fn predecessor_id_string( &self, ) -> <PhantomData<Option<String>> as Property>::Value

pub fn successor_id_string( &self, ) -> <PhantomData<Option<String>> as Property>::Value

pub fn successor(&self) -> <WeakRef<Room> as Property>::Value

pub fn members(&self) -> <WeakRef<MemberList> as Property>::Value

pub fn joined_members_count(&self) -> <Cell<u64> as Property>::Value

pub fn own_member(&self) -> <OnceCell<Member> as Property>::Value

pub fn inviter(&self) -> <RefCell<Option<Member>> as Property>::Value

pub fn direct_member(&self) -> <RefCell<Option<Member>> as Property>::Value

pub fn timeline(&self) -> <OnceCell<Timeline> as Property>::Value

pub fn latest_activity(&self) -> <Cell<u64> as Property>::Value

pub fn is_read(&self) -> <Cell<bool> as Property>::Value

pub fn notification_count(&self) -> <Cell<u64> as Property>::Value

pub fn has_notifications(&self) -> <Cell<bool> as Property>::Value

pub fn highlight(&self) -> <Cell<HighlightFlags> as Property>::Value

pub fn is_encrypted(&self) -> <Cell<bool> as Property>::Value

pub fn join_rule(&self) -> <JoinRule as Property>::Value

pub fn guests_allowed(&self) -> <Cell<bool> as Property>::Value

pub fn history_visibility( &self, ) -> <Cell<HistoryVisibilityValue> as Property>::Value

pub fn version(&self) -> <PhantomData<String> as Property>::Value

pub fn federated(&self) -> <PhantomData<bool> as Property>::Value

pub fn typing_list(&self) -> <TypingList as Property>::Value

pub fn notifications_setting( &self, ) -> <Cell<NotificationsRoomSetting> as Property>::Value

pub fn set_notifications_setting<'a>( &self, value: impl Borrow<<<Cell<NotificationsRoomSetting> as Property>::Value as HasParamSpec>::SetValue>, )

pub fn permissions(&self) -> <Permissions as Property>::Value

pub fn verification( &self, ) -> <BoundObjectWeakRef<IdentityVerification> as Property>::Value

pub fn set_verification<'a>( &self, value: Option<impl Borrow<<<BoundObjectWeakRef<IdentityVerification> as Property>::Value as HasParamSpec>::SetValue>>, )

pub fn connect_session_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_room_id_string_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_aliases_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_name_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_has_avatar_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_topic_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_topic_linkified_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_category_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_is_direct_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_is_tombstoned_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_predecessor_id_string_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_successor_id_string_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_successor_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_members_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_joined_members_count_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_own_member_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_inviter_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_direct_member_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_timeline_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_latest_activity_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_is_read_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_notification_count_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_has_notifications_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_highlight_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_is_encrypted_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_join_rule_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_guests_allowed_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_history_visibility_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_version_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_federated_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_typing_list_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_notifications_setting_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_permissions_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_verification_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn notify_session(&self)

pub fn notify_room_id_string(&self)

pub fn notify_aliases(&self)

pub fn notify_name(&self)

pub fn notify_has_avatar(&self)

pub fn notify_topic(&self)

pub fn notify_topic_linkified(&self)

pub fn notify_category(&self)

pub fn notify_is_direct(&self)

pub fn notify_is_tombstoned(&self)

pub fn notify_predecessor_id_string(&self)

pub fn notify_successor_id_string(&self)

pub fn notify_successor(&self)

pub fn notify_members(&self)

pub fn notify_joined_members_count(&self)

pub fn notify_own_member(&self)

pub fn notify_inviter(&self)

pub fn notify_direct_member(&self)

pub fn notify_timeline(&self)

pub fn notify_latest_activity(&self)

pub fn notify_is_read(&self)

pub fn notify_notification_count(&self)

pub fn notify_has_notifications(&self)

pub fn notify_highlight(&self)

pub fn notify_is_encrypted(&self)

pub fn notify_join_rule(&self)

pub fn notify_guests_allowed(&self)

pub fn notify_history_visibility(&self)

pub fn notify_version(&self)

pub fn notify_federated(&self)

pub fn notify_typing_list(&self)

pub fn notify_notifications_setting(&self)

pub fn notify_permissions(&self)

pub fn notify_verification(&self)

impl Room

pub fn new( session: &Session, matrix_room: MatrixRoom, metainfo: Option<RoomMetainfo>, ) -> Self

pub fn matrix_room(&self) -> &MatrixRoom

The room API of the SDK.

pub fn room_id(&self) -> &RoomId

The ID of this room.

pub fn human_readable_id(&self) -> String

Get a human-readable ID for this Room.

This shows the display name and room ID to identify the room easily in logs.

pub fn state(&self) -> RoomState

The state of the room.

pub fn is_joined(&self) -> bool

Whether this room is joined.

pub fn predecessor_id(&self) -> Option<&OwnedRoomId>

The ID of the predecessor of this room, if this room is an upgrade to a previous room.

pub fn successor_id(&self) -> Option<&RoomId>

The ID of the successor of this Room, if this room was upgraded.

pub async fn matrix_to_uri(&self) -> MatrixToUri

The matrix.to URI representation for this room.

pub async fn matrix_uri(&self) -> MatrixUri

The matrix: URI representation for this room.

pub async fn matrix_to_event_uri(&self, event_id: OwnedEventId) -> MatrixToUri

The matrix.to URI representation for the given event in this room.

pub async fn matrix_event_uri(&self, event_id: OwnedEventId) -> MatrixUri

The matrix: URI representation for the given event in this room.

pub fn at_room(&self) -> AtRoom

Constructs an AtRoom for this room.

pub fn get_or_create_members(&self) -> MemberList

Get or create the list of members of this room.

This creates the MemberList if no strong reference to it exists.

pub async fn ensure_direct_user(&self) -> Result<(), ()>

Ensure the direct user of this room is an active member.

If there is supposed to be a direct user in this room but they have left it, re-invite them.

This is a noop if there is no supposed direct user or if the user is already an active member.

pub async fn set_category(&self, category: RoomCategory) -> MatrixResult<()>

Set the category of this room.

This makes the necessary to propagate the category to the homeserver.

Note: Rooms can’t be moved to the invite category and they can’t be moved once they are upgraded.

pub async fn toggle_reaction( &self, key: String, event: &Event, ) -> Result<(), ()>

Toggle the key reaction on the given related event in this room.

pub async fn send_receipt( &self, receipt_type: ApiReceiptType, position: ReceiptPosition, )

Send the given receipt.

pub fn send_typing_notification(&self, is_typing: bool)

Send a typing notification for this room, with the given typing state.

pub async fn redact<'a>( &self, events: &'a [OwnedEventId], reason: Option<String>, ) -> Result<(), Vec<&'a EventId>>

Redact the given events in this room because of the given reason.

Returns Ok(()) if all the redactions are successful, otherwise returns the list of events that could not be redacted.

pub async fn report_events<'a>( &self, events: &'a [(OwnedEventId, Option<String>)], ) -> Result<(), Vec<&'a EventId>>

Report the given events in this room.

The events are a list of (event_id, reason) tuples.

Returns Ok(()) if all the reports are sent successfully, otherwise returns the list of event IDs that could not be reported.

pub async fn invite<'a>( &self, user_ids: &'a [OwnedUserId], ) -> Result<(), Vec<&'a UserId>>

Invite the given users to this room.

Returns Ok(()) if all the invites are sent successfully, otherwise returns the list of users who could not be invited.

pub async fn kick<'a>( &self, users: &'a [(OwnedUserId, Option<String>)], ) -> Result<(), Vec<&'a UserId>>

Kick the given users from this room.

The users are a list of (user_id, reason) tuples.

Returns Ok(()) if all the kicks are sent successfully, otherwise returns the list of users who could not be kicked.

pub async fn ban<'a>( &self, users: &'a [(OwnedUserId, Option<String>)], ) -> Result<(), Vec<&'a UserId>>

Ban the given users from this room.

The users are a list of (user_id, reason) tuples.

Returns Ok(()) if all the bans are sent successfully, otherwise returns the list of users who could not be banned.

pub async fn unban<'a>( &self, users: &'a [(OwnedUserId, Option<String>)], ) -> Result<(), Vec<&'a UserId>>

Unban the given users from this room.

The users are a list of (user_id, reason) tuples.

Returns Ok(()) if all the unbans are sent successfully, otherwise returns the list of users who could not be unbanned.

pub async fn enable_encryption(&self) -> Result<(), ()>

Enable encryption for this room.

pub async fn forget(&self) -> MatrixResult<()>

Forget a room that is left.

pub fn handle_ambiguity_changes<'a>( &self, changes: impl Iterator<Item = &'a AmbiguityChange>, )

Handle room member name ambiguity changes.

fn update_latest_activity<'a>( &self, events: impl IntoIterator<Item = &'a Event>, )

Update the latest activity of the room with the given events.

The events must be in reverse chronological order.

pub async fn update_is_direct(&self)

Update whether the room is direct or not.

pub fn update_successor(&self)

Update the successor of this room.

pub fn connect_room_forgotten<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Connect to the signal emitted when the room was forgotten.

Trait Implementations

impl Clone for Room

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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 HasParamSpec for Room

type ParamSpec = ParamSpecObject

type SetValue = Room

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Room>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Room

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl ObjectSubclassIs for Room

type Subclass = Room

impl Ord for Room

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for Room

type Parent = PillSource

impl<OT: ObjectType> PartialEq<OT> for Room

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Room

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Room

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Room

impl IsA<PillSource> for Room