Struct EventBuilder

pub struct EventBuilder<C: EventContent> { /* private fields */ }

Implementations

impl<E: EventContent> EventBuilder<E>

where E::EventType: Serialize,

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 bundled_relations( self, relations: BundledMessageLikeRelations<Raw<AnySyncTimelineEvent>>, ) -> Self

Adds bundled relations to this event.

Ideally, we’d type-check that an event passed as a relation is the same type as this one, but it’s not trivial to do so because this builder is only generic on the event’s content, not the event type itself; doing so would require many changes, and this is testing code after all.

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.

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_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 latest thread event id too.

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<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 + EventContent> Debug for EventBuilder<C>

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

Formats the value using the given formatter.

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

where E::EventType: Serialize,

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

Converts to this type from the input type.

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

where E::EventType: Serialize,

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

Converts to this type from the input type.

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

where E::EventType: Serialize,

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

Converts to this type from the input type.