Struct JoinedRoomBuilder

pub struct JoinedRoomBuilder { /* private fields */ }

Implementations

impl JoinedRoomBuilder

pub fn new(room_id: &RoomId) -> Self

Create a new JoinedRoomBuilder for the given room ID.

If the room ID is DEFAULT_TEST_ROOM_ID, JoinedRoomBuilder::default() can be used instead.

pub fn room_id(&self) -> &RoomId

Get the room ID of this JoinedRoomBuilder.

pub fn add_timeline_event( self, event: impl Into<Raw<AnySyncTimelineEvent>>, ) -> Self

Add an event to the timeline.

The raw event can be created with the sync_timeline_event macro.

pub fn add_timeline_bulk<I>(self, events: I) -> Self

where I: IntoIterator<Item = Raw<AnySyncTimelineEvent>>,

Add events in bulk to the timeline.

pub fn add_timeline_state_bulk<I>(self, events: I) -> Self

where I: IntoIterator<Item = Raw<AnySyncStateEvent>>,

Add state events in bulk to the timeline.

This is a convenience method that casts Raw<AnySyncStateEvent> to Raw<AnySyncTimelineEvent> and calls JoinedRoom::add_timeline_bulk().

pub fn set_timeline_limited(self) -> Self

Set the timeline as limited.

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

Set the prev_batch of the timeline.

pub fn use_state_after(self) -> Self

Add state events to the state_after field rather than state.

pub fn add_state_event(self, event: impl Into<Raw<AnySyncStateEvent>>) -> Self

Add an event to the state.

pub fn add_state_bulk<I>(self, events: I) -> Self

where I: IntoIterator<Item = Raw<AnySyncStateEvent>>,

Add events in bulk to the state.

pub fn add_receipt(self, f: EventBuilder<ReceiptEventContent>) -> Self

Add a single read receipt to the joined room’s ephemeral events.

pub fn add_typing(self, f: EventBuilder<TypingEventContent>) -> Self

Add a typing notification event for this sync.

pub fn add_account_data(self, event: RoomAccountDataTestEvent) -> Self

Add room account data.

pub fn add_account_data_bulk<I>(self, events: I) -> Self

where I: IntoIterator<Item = Raw<AnyRoomAccountDataEvent>>,

Add room account data in bulk.

pub fn set_room_summary(self, summary: JsonValue) -> Self

Set the room summary.

pub fn set_unread_notifications_count( self, unread_notifications: JsonValue, ) -> Self

Set the unread notifications count.

Trait Implementations

impl Clone for JoinedRoomBuilder

fn clone(&self) -> JoinedRoomBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JoinedRoomBuilder

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

Formats the value using the given formatter.

impl Default for JoinedRoomBuilder

fn default() -> Self

Returns the “default value” for a type.