Struct SendHandle

pub struct SendHandle { /* private fields */ }

A handle to manipulate an event that was scheduled to be sent to a room.

Implementations

impl SendHandle

pub async fn abort(&self) -> Result<bool, RoomSendQueueStorageError>

Aborts the sending of the event, if it wasn’t sent yet.

Returns true if the sending could be aborted, false if not (i.e. the event had already been sent).

pub async fn edit_raw( &self, new_content: Raw<AnyMessageLikeEventContent>, event_type: String, ) -> Result<bool, RoomSendQueueStorageError>

Edits the content of a local echo with a raw event content.

Returns true if the event to be sent was replaced, false if not (i.e. the event had already been sent).

pub async fn edit( &self, new_content: AnyMessageLikeEventContent, ) -> Result<bool, RoomSendQueueStorageError>

Edits the content of a local echo with an event content.

Returns true if the event to be sent was replaced, false if not (i.e. the event had already been sent).

pub async fn edit_media_caption( &self, caption: Option<String>, formatted_caption: Option<FormattedBody>, ) -> Result<bool, RoomSendQueueStorageError>

Edits the content of a local echo with a media caption.

Will fail if the event to be sent, represented by this send handle, wasn’t a media.

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

Unwedge a local echo identified by its transaction identifier and try to resend it.

pub async fn react( &self, key: String, ) -> Result<Option<SendReactionHandle>, RoomSendQueueStorageError>

Send a reaction to the event as soon as it’s sent.

If returning Ok(None); this means the reaction couldn’t be sent because the event is already a remote one.

Trait Implementations

impl Clone for SendHandle

fn clone(&self) -> SendHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SendHandle

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

Formats the value using the given formatter.