Struct DelayedEventData 

#[non_exhaustive]
pub struct DelayedEventData {
    pub delay_id: String,
    pub room_id: OwnedRoomId,
    pub event_type: TimelineEventType,
    pub state_key: Option<String>,
    pub content: Raw<AnyTimelineEventContent>,
    pub delay: Duration,
    pub running_since: MilliSecondsSinceUnixEpoch,
    pub error: Option<StandardErrorBody>,
    pub event_id: Option<OwnedEventId>,
    pub finalized_ts: Option<MilliSecondsSinceUnixEpoch>,
}

Available on crate feature api and crate feature unstable-msc4140 and (crate features client-api-c or client-api-s) and (crate features client or server) only.

The structure of the data for returning a delayed event from a GET endpoint

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

delay_id: String

The ID of the delayed event.

room_id: OwnedRoomId

The ID of the room that the delayed event was scheduled to be sent in.

event_type: TimelineEventType

The event type of the delayed event.

state_key: Option<String>

The State Key if the event is a state event, nothing otherwise

content: Raw<AnyTimelineEventContent>

The event content to send.

This is the content that was submitted to the send endpoint, not the content of the final event

delay: Duration

The duration that the server should wait before sending this event

running_since: MilliSecondsSinceUnixEpoch

The timestamp when the delayed event was scheduled or last restarted.

error: Option<StandardErrorBody>

The error that prevented the delayed event from being sent. Present only for finalized events that were cancelled due to an error.

event_id: Option<OwnedEventId>

The event_id this event got when it was sent. Present only for events that were sent successfully.

finalized_ts: Option<MilliSecondsSinceUnixEpoch>

The timestamp when the event was finalized. Present only for events that were finalized (sent, failed to send, or cancelled).

Implementations

impl DelayedEventData

pub fn new( delay_id: String, room_id: OwnedRoomId, event_type: TimelineEventType, state_key: Option<String>, content: Raw<AnyTimelineEventContent>, delay: Duration, running_since: MilliSecondsSinceUnixEpoch, ) -> DelayedEventData

Create a new delayed event data object with the given parameters

pub fn status(&self) -> DelayedEventStatus

Returns the status indicated by this delayed event data.

Trait Implementations

impl Clone for DelayedEventData

fn clone(&self) -> DelayedEventData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DelayedEventData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DelayedEventData

fn deserialize<__D>( __deserializer: __D, ) -> Result<DelayedEventData, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DelayedEventData> for Response

fn from(delayed_event: DelayedEventData) -> Response

Converts to this type from the input type.

impl Serialize for DelayedEventData

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.