Struct fractal::session::model::room::event::Event

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

GObject representation of 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 reactions(&self) -> <ReactionList as Property>::Value

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

pub fn state(&self) -> <Cell<MessageState> 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 event_id_string( &self, ) -> <PhantomData<Option<String>> as Property>::Value

pub fn timeline_id(&self) -> <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 timestamp_full(&self) -> <PhantomData<String> 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_timestamp_full( &self, ) -> <PhantomData<String> as Property>::Value

pub fn is_highlighted(&self) -> <PhantomData<bool> 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_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_state_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_event_id_string_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_timeline_id_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_timestamp_full_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_timestamp_full_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_has_read_receipts_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn notify_room(&self)

pub fn notify_reactions(&self)

pub fn notify_read_receipts(&self)

pub fn notify_state(&self)

pub fn notify_source(&self)

pub fn notify_has_source(&self)

pub fn notify_event_id_string(&self)

pub fn notify_timeline_id(&self)

pub fn notify_sender_id_string(&self)

pub fn notify_timestamp(&self)

pub fn notify_timestamp_full(&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_timestamp_full(&self)

pub fn notify_is_highlighted(&self)

pub fn notify_has_read_receipts(&self)

impl Event

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

Create a new Event with the given SDK timeline item.

pub fn try_update_with( &self, item: &EventTimelineItem, timeline_id: &str, ) -> bool

Try to update this Event with the given SDK timeline item.

Returns true if the update succeeded.

pub fn item(&self) -> EventTimelineItem

The underlying SDK timeline item.

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

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

pub fn key(&self) -> EventKey

The unique key of this Event in the timeline.

pub fn matches_key(&self, key: &EventKey) -> bool

Whether the given key matches this Event.

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

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

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

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

The transaction ID of this Event, if it is still pending.

pub fn sender_id(&self) -> OwnedUserId

The user ID of the sender of this Event.

pub 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 fn origin_server_ts(&self) -> MilliSecondsSinceUnixEpoch

The timestamp of this Event as the number of milliseconds since Unix Epoch, if it has been echoed back by the server.

Otherwise it’s the local time when this event was created.

pub fn origin_server_ts_u64(&self) -> u64

The timestamp of this Event as a u64, if it has been echoed back by the server.

Otherwise it’s the local time when this event was created.

pub fn is_redacted(&self) -> bool

Whether this Event is redacted.

pub fn content(&self) -> TimelineItemContent

The content to display for this Event.

pub fn message(&self) -> Option<MessageType>

The message of this Event, if any.

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

The media message of this Event, if any.

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

The visual media message of this Event, if any.

pub fn mentions(&self) -> Option<Mentions>

The mentions from this message, if any.

pub fn can_contain_at_room(&self) -> bool

Whether this event might contain an @room mention.

This means that either it doesn’t have intentional mentions, or it has intentional mentions and room is set to true.

fn compute_state(&self) -> MessageState

Compute the current state of this Event.

fn update_state(&self)

Update the state of this Event.

fn update_read_receipts( &self, new_read_receipts: &IndexMap<OwnedUserId, Receipt>, )

Update the read receipts list with the given receipts.

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

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

pub fn is_reply(&self) -> bool

Whether this Event is a reply to another event.

pub 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 fn reply_to_event(&self) -> Option<Event>

Get the event this Event replies to, if any.

Returns None(_) if this event is not a reply or if the event was not found locally.

pub 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 fn is_message(&self) -> bool

Whether this Event is considered a message.

pub fn as_message(&self) -> Option<OriginalSyncRoomMessageEvent>

Deserialize this Event as an OriginalSyncRoomMessageEvent, if possible.

pub 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 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 async fn matrix_uri(&self) -> Option<MatrixUri>

The matrix: URI representation for this event.

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

pub 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 + PartialOrd,

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