Struct Event

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

A Matrix room event.

GLib type: GObject with reference counted clone semantics.

Fields

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

phantom: PhantomData<()>

Implementations

impl Event

pub fn room(&self) -> <OnceCell<Room> as Property>::Value

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

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

pub fn timestamp(&self) -> <PhantomData<DateTime> as Property>::Value

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

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

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

pub fn state(&self) -> <Cell<MessageState> as Property>::Value

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

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

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

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

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

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

pub fn reactions(&self) -> <ReactionList as Property>::Value

pub fn read_receipts(&self) -> <ListStore as Property>::Value

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn notify_room(&self)

pub fn notify_event_id_string(&self)

pub fn notify_sender_id_string(&self)

pub fn notify_timestamp(&self)

pub fn notify_formatted_timestamp(&self)

pub fn notify_source(&self)

pub fn notify_has_source(&self)

pub fn notify_state(&self)

pub fn notify_is_edited(&self)

pub fn notify_latest_edit_source(&self)

pub fn notify_latest_edit_event_id_string(&self)

pub fn notify_latest_edit_timestamp(&self)

pub fn notify_latest_edit_formatted_timestamp(&self)

pub fn notify_is_highlighted(&self)

pub fn notify_reactions(&self)

pub fn notify_read_receipts(&self)

pub fn notify_has_read_receipts(&self)

impl Event

pub fn new(item: EventTimelineItem, room: &Room, timeline_id: &str) -> Self

Create a new Event in the given room with the given SDK timeline item.

pub(crate) fn update_with(&self, item: EventTimelineItem)

Update this event with the given SDK timeline item.

pub(crate) fn item(&self) -> Arc<EventTimelineItem>

The underlying SDK timeline item.

pub(crate) fn identifier(&self) -> TimelineEventItemId

The global permanent or temporary identifier of this event.

pub(crate) fn matches_identifier( &self, identifier: &TimelineEventItemId, ) -> bool

Whether the given identifier matches this event.

The result can be different from comparing two TimelineEventItemIds because an event can have a transaction ID and an event ID.

pub(crate) fn event_id(&self) -> Option<OwnedEventId>

The permanent global ID of this event, if it has been received from the server.

pub(crate) fn transaction_id(&self) -> Option<OwnedTransactionId>

The temporary ID of this event, if it has been sent with this session.

pub(crate) fn sender_id(&self) -> OwnedUserId

The ID of the sender of this event.

pub(crate) fn sender(&self) -> Member

The sender of this event.

This should only be called when the event’s room members list is available, otherwise it will be created on every call.

pub(crate) fn origin_server_ts(&self) -> MilliSecondsSinceUnixEpoch

The timestamp of this event, as the number of milliseconds since Unix Epoch.

pub(crate) fn raw(&self) -> Option<Raw<AnySyncTimelineEvent>>

The raw JSON source for this event, if it has been echoed back by the server.

pub(crate) fn content(&self) -> TimelineItemContent

The content of this event.

pub(crate) fn is_message(&self) -> bool

Whether this event contains a message.

Message events include the following variants of TimelineItemContent:

• Message
• Sticker

Note that this differs from the SDK/Matrix definition that only includes m.room.message events, and from the Ruma definition (e.g. used for AnySyncMessageLikeEvent) which includes all non-state events.

pub(crate) fn media_message(&self) -> Option<MediaMessage>

The media message of this event, if any.

pub(crate) fn visual_media_message(&self) -> Option<VisualMediaMessage>

The visual media message of this event, if any.

pub(crate) fn can_contain_at_room(&self) -> bool

Whether this event might contain an @room mention.

This means that either it does not have intentional mentions, or it has intentional mentions and room is set to true.

pub(crate) fn is_room_create_event(&self) -> bool

Whether this is an m.room.create event.

pub(crate) fn reply_to_id(&self) -> Option<OwnedEventId>

Get the ID of the event this event replies to, if any.

pub(crate) fn reply_to_event_content( &self, ) -> Option<TimelineDetails<Box<RepliedToEvent>>>

Get the details of the event this event replies to, if any.

Returns None(_) if this event is not a reply.

pub(crate) async fn fetch_missing_details(&self) -> Result<(), TimelineError>

Fetch missing details for this event.

This is a no-op if called for a local event.

pub(crate) fn can_be_replied_to(&self) -> bool

Whether this event can be replied to.

pub(crate) fn can_be_reacted_to(&self) -> bool

Whether this event can be reacted to.

pub(crate) fn can_be_redacted(&self) -> bool

Whether this event can be redacted.

This uses the raw JSON to be able to redact even events that failed to deserialize.

pub(crate) fn counts_as_unread(&self) -> bool

Whether this Event can count as an unread message.

This follows the algorithm in MSC2654, excluding events that we don’t show in the timeline.

pub(crate) async fn matrix_to_uri(&self) -> Option<MatrixToUri>

The matrix.to URI representation for this event.

Returns None if we don’t have the ID of the event.

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

Listen to the signal emitted when the SDK item changed.

Trait Implementations

impl Clone for Event

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 Event

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

Formats the value using the given formatter.

impl HasParamSpec for Event

type ParamSpec = ParamSpecObject

type SetValue = Event

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Event

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 Event

type Subclass = Event

impl Ord for Event

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 Event

type Parent = TimelineItem

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

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 Event

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 Event

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Event

impl IsA<TimelineItem> for Event