Struct EventBuilder 

pub struct EventBuilder<C: StaticEventContent<IsPrefix = False>> { /* private fields */ }

Implementations

impl<E: StaticEventContent<IsPrefix = False>> EventBuilder<E>

pub fn room(self, room_id: &RoomId) -> Self

pub fn sender(self, sender: &UserId) -> Self

pub fn event_id(self, event_id: &EventId) -> Self

pub fn no_event_id(self) -> Self

pub fn server_ts(self, ts: impl TimestampArg) -> Self

pub fn unsigned_transaction_id(self, transaction_id: &TransactionId) -> Self

pub fn age(self, age: impl Into<Int>) -> Self

Add age to unsigned data in this event.

pub fn with_bundled_thread_summary( self, latest_event: Raw<AnySyncMessageLikeEvent>, count: usize, current_user_participated: bool, ) -> Self

Create a bundled thread summary in the unsigned bundled relations of this event.

pub fn with_bundled_edit( self, replacement: impl Into<Raw<AnySyncTimelineEvent>>, ) -> Self

Create a bundled edit in the unsigned bundled relations of this event.

pub fn state_key(self, state_key: impl Into<String>) -> Self

For state events manually created, define the state key.

For other state events created in the EventFactory, this is automatically filled upon creation or update of the events.

impl<E> EventBuilder<E>

where E: StaticEventContent<IsPrefix = False> + Serialize,

pub fn into_raw<T>(self) -> Raw<T>

Build an event from the EventBuilder and convert it into a serialized and Raw event.

The generic argument T allows you to automatically cast the Raw event into any desired type.

pub fn into_raw_timeline(self) -> Raw<AnyTimelineEvent>

pub fn into_any_sync_message_like_event(self) -> AnySyncMessageLikeEvent

pub fn into_original_sync_room_message_event( self, ) -> OriginalSyncRoomMessageEvent

pub fn into_raw_sync(self) -> Raw<AnySyncTimelineEvent>

pub fn into_event(self) -> TimelineEvent

impl EventBuilder<RoomEncryptedEventContent>

pub fn into_utd_sync_timeline_event(self) -> TimelineEvent

Turn this event into a TimelineEvent representing a decryption failure

impl EventBuilder<RoomMessageEventContent>

pub fn reply_to(self, event_id: &EventId) -> Self

Adds a reply relation to the current event.

pub fn in_thread(self, root: &EventId, latest_thread_event: &EventId) -> Self

Adds a thread relation to the root event, setting the reply fallback to the latest in-thread event.

pub fn in_thread_reply(self, root: &EventId, replied_to: &EventId) -> Self

Adds a thread relation to the root event, that’s a non-fallback reply to another thread event.

pub fn mentions(self, mentions: Mentions) -> Self

Adds the given mentions to the current event.

pub fn edit( self, edited_event_id: &EventId, new_content: RoomMessageEventContentWithoutRelation, ) -> Self

Adds a replacement relation to the current event, with the new content passed.

pub fn caption( self, caption: Option<String>, formatted_caption: Option<FormattedBody>, ) -> Self

Adds a caption to a media event.

Will crash if the event isn’t a media room message.

impl EventBuilder<UnstablePollStartEventContent>

pub fn reply_to(self, event_id: &EventId) -> Self

Adds a reply relation to the current event.

pub fn in_thread(self, root: &EventId, reply_to_event_id: &EventId) -> Self

Adds a thread relation to the root event, setting the reply to event id as well.

impl EventBuilder<RoomCreateEventContent>

pub fn predecessor(self, room_id: &RoomId) -> Self

Define the predecessor fields.

pub fn no_predecessor(self) -> Self

Erase the predecessor if any.

pub fn with_space_type(self) -> Self

Sets the m.room.create type field to m.space.

impl EventBuilder<StickerEventContent>

pub fn reply_thread(self, root: &EventId, reply_to_event: &EventId) -> Self

Add reply Thread relation to root event and set replied-to event id.

impl EventBuilder<DirectEventContent>

pub fn add_user( self, user_id: OwnedDirectUserIdentifier, room_id: &RoomId, ) -> Self

Add a user/room pair to the m.direct event.

impl EventBuilder<RoomMemberEventContent>

pub fn membership(self, state: MembershipState) -> Self

Set the membership of the m.room.member event to the given MembershipState.

The default is MembershipState::Join.

pub fn invited(self, invited_user: &UserId) -> Self

Set that the sender of this event invited the user passed as a parameter here.

pub fn kicked(self, kicked_user: &UserId) -> Self

Set that the sender of this event kicked the user passed as a parameter here.

pub fn banned(self, banned_user: &UserId) -> Self

Set that the sender of this event banned the user passed as a parameter here.

pub fn display_name(self, display_name: impl Into<String>) -> Self

Set the display name of the m.room.member event.

pub fn avatar_url(self, url: &MxcUri) -> Self

Set the avatar URL of the m.room.member event.

pub fn reason(self, reason: impl Into<String>) -> Self

Set the reason field of the m.room.member event.

pub fn previous(self, previous: impl Into<PreviousMembership>) -> Self

Set the previous membership state (in the unsigned section).

impl EventBuilder<RoomAvatarEventContent>

pub fn url(self, url: &MxcUri) -> Self

Defines the URL for the room avatar.

pub fn info(self, image: ImageInfo) -> Self

Defines the image info for the avatar.

Trait Implementations

impl<C: Debug + StaticEventContent<IsPrefix = False>> Debug for EventBuilder<C>

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

Formats the value using the given formatter.

impl<E> From<EventBuilder<E>> for Raw<AnyGlobalAccountDataEvent>

where E: Serialize + StaticEventContent<IsPrefix = False>,

fn from(val: EventBuilder<E>) -> Self

Converts to this type from the input type.

impl<E: StaticEventContent<IsPrefix = False> + StateEventContent> From<EventBuilder<E>> for Raw<AnyStateEvent>

fn from(val: EventBuilder<E>) -> Self

Converts to this type from the input type.

impl<E: StaticEventContent<IsPrefix = False> + StateEventContent> From<EventBuilder<E>> for Raw<AnySyncStateEvent>

fn from(val: EventBuilder<E>) -> Self

Converts to this type from the input type.

impl<E> From<EventBuilder<E>> for Raw<AnySyncTimelineEvent>

where E: Serialize + StaticEventContent<IsPrefix = False>,

fn from(val: EventBuilder<E>) -> Self

Converts to this type from the input type.

impl<E> From<EventBuilder<E>> for Raw<AnyTimelineEvent>

where E: Serialize + StaticEventContent<IsPrefix = False>,

fn from(val: EventBuilder<E>) -> Self

Converts to this type from the input type.

impl<E> From<EventBuilder<E>> for TimelineEvent

where E: Serialize + StaticEventContent<IsPrefix = False>,

fn from(val: EventBuilder<E>) -> Self

Converts to this type from the input type.