Struct EventTimelineItem

pub struct EventTimelineItem { /* private fields */ }

An item in the timeline that represents at least one event.

There is always one main event that gives the EventTimelineItem its identity but in many cases, additional events like reactions and edits are also part of the item.

Implementations

impl EventTimelineItem

pub async fn from_latest_event( client: Client, room_id: &RoomId, latest_event: LatestEvent, ) -> Option<EventTimelineItem>

If the supplied low-level SyncTimelineEvent is suitable for use as the latest_event in a message preview, wrap it as an EventTimelineItem.

Note: Timeline items created via this constructor do not produce the correct ShieldState when calling get_shield. This is because they are intended for display in the room list which a) is unlikely to show shields and b) would incur a significant performance overhead.

pub fn is_local_echo(&self) -> bool

Check whether this item is a local echo.

This returns true for events created locally, until the server echoes back the full event as part of a sync response.

This is the opposite of Self::is_remote_event.

pub fn is_remote_event(&self) -> bool

Check whether this item is a remote event.

This returns true only for events that have been echoed back from the homeserver. A local echo sent but not echoed back yet will return false here.

This is the opposite of Self::is_local_echo.

pub fn send_state(&self) -> Option<&EventSendState>

Get the event’s send state of a local echo.

pub fn identifier(&self) -> TimelineEventItemId

Get the unique identifier of this item.

Returns the transaction ID for a local echo item that has not been sent and the event ID for a local echo item that has been sent or a remote item.

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

Get the transaction ID of a local echo item.

The transaction ID is currently only kept until the remote echo for a local event is received.

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

Get the event ID of this item.

If this returns Some(_), the event was successfully created by the server.

Even if this is a local event, this can be Some(_) as the event ID can be known not just from the remote echo via sync_events, but also from the response of the send request that created the event.

pub fn sender(&self) -> &UserId

Get the sender of this item.

pub fn sender_profile(&self) -> &TimelineDetails<Profile>

Get the profile of the sender.

pub fn content(&self) -> &TimelineItemContent

Get the content of this item.

pub fn reactions(&self) -> &ReactionsByKeyBySender

Get the reactions of this item.

pub fn read_receipts(&self) -> &IndexMap<OwnedUserId, Receipt>

Get the read receipts of this item.

The key is the ID of a room member and the value are details about the read receipt.

Note that currently this ignores threads.

pub fn timestamp(&self) -> MilliSecondsSinceUnixEpoch

Get the timestamp of this item.

If this event hasn’t been echoed back by the server yet, returns the time the local event was created. Otherwise, returns the origin server timestamp.

pub fn is_own(&self) -> bool

Whether this timeline item was sent by the logged-in user themselves.

pub fn is_editable(&self) -> bool

Flag indicating this timeline item can be edited by the current user.

pub fn is_highlighted(&self) -> bool

Whether the event should be highlighted in the timeline.

pub fn encryption_info(&self) -> Option<&EncryptionInfo>

Get the encryption information for the event, if any.

pub fn get_shield(&self, strict: bool) -> Option<ShieldState>

Gets the ShieldState which can be used to decorate messages in the recommended way.

pub fn can_be_replied_to(&self) -> bool

Check whether this item can be replied to.

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

Get the raw JSON representation of the initial event (the one that caused this timeline item to be created).

Returns None if this event hasn’t been echoed back by the server yet.

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

Get the raw JSON representation of the latest edit, if any.

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

Shorthand for item.latest_edit_json().or_else(|| item.original_json()).

pub fn origin(&self) -> Option<EventItemOrigin>

Get the origin of the event, i.e. where it came from.

May return None in some edge cases that are subject to change.

pub fn with_reactions(&self, reactions: ReactionsByKeyBySender) -> Self

Clone the current event item, and update its reactions.

pub fn replied_to_info(&self) -> Result<RepliedToInfo, UnsupportedReplyItem>

Gives the information needed to reply to the event of the item.

pub fn local_echo_send_handle(&self) -> Option<SendHandle>

For local echoes, return the associated send handle.

Trait Implementations

impl Clone for EventTimelineItem

fn clone(&self) -> EventTimelineItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventTimelineItem

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

Formats the value using the given formatter.

impl From<EventTimelineItem> for TimelineItemKind

fn from(item: EventTimelineItem) -> Self

Converts to this type from the input type.