Enum MatrixRequest 

pub enum MatrixRequest {
    PaginateTimeline {
        timeline_kind: TimelineKind,
        num_events: u16,
        direction: PaginationDirection,
    },
    EditMessage {
        timeline_kind: TimelineKind,
        timeline_event_item_id: TimelineEventItemId,
        edited_content: EditedContent,
    },
    FetchDetailsForEvent {
        timeline_kind: TimelineKind,
        event_id: OwnedEventId,
    },
    CreateThreadTimeline {
        room_id: OwnedRoomId,
        thread_root_event_id: OwnedEventId,
        sender: Sender<()>,
    },
    SyncRoomMemberList {
        timeline_kind: TimelineKind,
    },
    JoinRoom {
        room_id: OwnedRoomId,
    },
    LeaveRoom {
        room_id: OwnedRoomId,
    },
    GetRoomMembers {
        timeline_kind: TimelineKind,
        memberships: RoomMemberships,
        local_only: bool,
    },
    GetUserProfile {
        user_id: OwnedUserId,
        room_id: Option<OwnedRoomId>,
        local_only: bool,
        sender: Option<Sender<Option<UserProfile>>>,
    },
    GetNumberUnreadMessages {
        timeline_kind: TimelineKind,
    },
    IgnoreUser {
        ignore: bool,
        room_member: RoomMember,
        room_id: OwnedRoomId,
    },
    ResolveRoomAlias(OwnedRoomAliasId),
    FetchMedia {
        media_request: MediaRequestParameters,
        content_sender: Sender<Result<Vec<u8>, Error>>,
    },
    SendTextMessage {
        timeline_kind: TimelineKind,
        message: String,
        replied_to_id: Option<OwnedEventId>,
    },
    SendTypingNotice {
        room_id: OwnedRoomId,
        typing: bool,
    },
    SubscribeToTypingNotices {
        room_id: OwnedRoomId,
        subscribe: bool,
    },
    SubscribeToOwnUserReadReceiptsChanged {
        timeline_kind: TimelineKind,
        subscribe: bool,
    },
    ReadReceipt {
        timeline_kind: TimelineKind,
        event_id: OwnedEventId,
        receipt_type: ReceiptType,
    },
    MarkRoomAsRead {
        timeline_kind: TimelineKind,
    },
    GetRoomPowerLevels {
        timeline_kind: TimelineKind,
    },
    ToggleReaction {
        timeline_kind: TimelineKind,
        timeline_event_id: TimelineEventItemId,
        reaction: String,
    },
    RedactMessage {
        timeline_kind: TimelineKind,
        timeline_event_id: TimelineEventItemId,
        reason: Option<String>,
    },
    GetMatrixRoomLinkPillInfo {
        matrix_id: MatrixId,
        via: Vec<OwnedServerName>,
    },
    SearchUsers {
        search_term: String,
        limit: u64,
        content_sender: Sender<Result<Vec<ProfileModel>, Error>>,
    },
    CreateDMRoom {
        user_id: OwnedUserId,
    },
    CreateRoom {
        room_name: String,
        room_avatar: Option<OwnedMxcUri>,
        invited_user_ids: Vec<OwnedUserId>,
        topic: Option<String>,
    },
    InviteUsersInRoom {
        room_id: OwnedRoomId,
        invited_user_ids: Vec<OwnedUserId>,
    },
    KickOrBanUserFromRoom {
        room_id: OwnedRoomId,
        user_id: OwnedUserId,
        reason: Option<String>,
        is_ban: bool,
    },
}

The set of requests for async work that can be made to the worker thread.

Variants

PaginateTimeline

Request to paginate the older (or newer) events of a room or thread timeline.

Fields

timeline_kind: TimelineKind

num_events: u16

The maximum number of timeline events to fetch in each pagination batch.

direction: PaginationDirection

EditMessage

Request to edit the content of an event in the given room’s timeline.

Fields

timeline_kind: TimelineKind

timeline_event_item_id: TimelineEventItemId

edited_content: EditedContent

FetchDetailsForEvent

Request to fetch the full details of the given event in the given room’s timeline.

Fields

timeline_kind: TimelineKind

event_id: OwnedEventId

CreateThreadTimeline

Request to create a thread timeline focused on the given thread root event in the given room.

Fields

room_id: OwnedRoomId

thread_root_event_id: OwnedEventId

sender: Sender<()>

SyncRoomMemberList

Request to fetch profile information for all members of a room. This can be very slow depending on the number of members in the room.

Fields

timeline_kind: TimelineKind

JoinRoom

Request to join the given room.

Fields

room_id: OwnedRoomId

LeaveRoom

Request to leave the given room.

Fields

room_id: OwnedRoomId

GetRoomMembers

Request to get the actual list of members in a room. This returns the list of members that can be displayed in the UI.

Fields

timeline_kind: TimelineKind

memberships: RoomMemberships

local_only: bool

• If true (not recommended), only the local cache will be accessed.
• If false (recommended), details will be fetched from the server.

GetUserProfile

Request to fetch profile information for the given user ID.

Fields

user_id: OwnedUserId

room_id: Option<OwnedRoomId>

• If Some, the user is known to be a member of a room, so this will fetch the user’s profile from that room’s membership info.
• If None, the user’s profile info will be fetched from the server in a room-agnostic manner, and no room membership info will be returned.

local_only: bool

• If true (not recommended), only the local cache will be accessed.
• If false (recommended), details will be fetched from the server.

sender: Option<Sender<Option<UserProfile>>>

matrix-svelte-client: sender used if a command is awaiting for the profile. We send it directly through this channel

GetNumberUnreadMessages

Request to fetch the number of unread messages in the given room.

Fields

timeline_kind: TimelineKind

IgnoreUser

Request to ignore/block or unignore/unblock a user.

Fields

ignore: bool

Whether to ignore (true) or unignore (false) the user.

room_member: RoomMember

The room membership info of the user to (un)ignore.

room_id: OwnedRoomId

The room ID of the room where the user is a member, which is only needed because it isn’t present in the RoomMember object.

ResolveRoomAlias(OwnedRoomAliasId)

Request to resolve a room alias into a room ID and the servers that know about that room.

FetchMedia

Request to fetch media from the server. Upon completion of the async media request, the on_fetched function will be invoked with four arguments: the destination, the media_request, the result of the media fetch, and the update_sender.

Fields

media_request: MediaRequestParameters

content_sender: Sender<Result<Vec<u8>, Error>>

SendTextMessage

Request to send a message to the given room.

Fields

timeline_kind: TimelineKind

message: String

replied_to_id: Option<OwnedEventId>

SendTypingNotice

Sends a notice to the given room that the current user is or is not typing.

This request does not return a response or notify the UI thread, and furthermore, there is no need to send a follow-up request to stop typing (though you certainly can do so).

Fields

room_id: OwnedRoomId

typing: bool

SubscribeToTypingNotices

Subscribe to typing notices for the given room.

This request does not return a response or notify the UI thread.

Fields

room_id: OwnedRoomId

subscribe: bool

Whether to subscribe or unsubscribe from typing notices for this room.

SubscribeToOwnUserReadReceiptsChanged

Subscribe to changes in the read receipts of our own user.

This request does not return a response or notify the UI thread.

Fields

timeline_kind: TimelineKind

subscribe: bool

Whether to subscribe or unsubscribe.

ReadReceipt

Sends a read receipt for the given event in the given room.

Fields

timeline_kind: TimelineKind

event_id: OwnedEventId

receipt_type: ReceiptType

MarkRoomAsRead

Sends a read receipt in the given room.

Fields

timeline_kind: TimelineKind

GetRoomPowerLevels

Sends a request to obtain the power levels for this room.

The response is delivered back to the main UI thread via [TimelineUpdate::UserPowerLevels].

Fields

timeline_kind: TimelineKind

ToggleReaction

Toggles the given reaction to the given event in the given room.

Fields

timeline_kind: TimelineKind

timeline_event_id: TimelineEventItemId

reaction: String

RedactMessage

Redacts (deletes) the given event in the given room.

Fields

timeline_kind: TimelineKind

timeline_event_id: TimelineEventItemId

reason: Option<String>

GetMatrixRoomLinkPillInfo

Sends a request to obtain the room’s pill link info for the given Matrix ID.

The MatrixLinkPillInfo::Loaded variant is sent back to the main UI thread via.

Fields

matrix_id: MatrixId

via: Vec<OwnedServerName>

SearchUsers

Fields

search_term: String

limit: u64

content_sender: Sender<Result<Vec<ProfileModel>, Error>>

CreateDMRoom

Create a DM room with a given UserId

Fields

user_id: OwnedUserId

CreateRoom

Create a Matrix room

Fields

room_name: String

room_avatar: Option<OwnedMxcUri>

invited_user_ids: Vec<OwnedUserId>

topic: Option<String>

InviteUsersInRoom

Invite a list of users to a room

Fields

room_id: OwnedRoomId

invited_user_ids: Vec<OwnedUserId>

KickOrBanUserFromRoom

Fields

room_id: OwnedRoomId

user_id: OwnedUserId

reason: Option<String>

is_ban: bool

Trait Implementations

impl<'de> Deserialize<'de> for MatrixRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.