Namespace Uniform.Matrix.Protocol.Core

Classes

AdminAccount

A local account in Synapse's user admin API.

AdminAccountsResponse

A page of AdminAccounts.

AdminRegistrationToken

A registration token in Synapse's admin API.

AdminRegistrationTokensResponse

Response listing AdminRegistrationTokens.

AdminReport

A report in Synapse's event report admin API; this project's server lists reports of rooms and users there too.

AdminReportsResponse

A page of AdminReports.

AdminRoomInfo

A room in Synapse's room admin API.

AdminRoomShutdown

Response of shutting down a room.

AdminRoomsResponse

A page of AdminRoomInfos.

AuthFlow

One accepted combination of auth stages.

AuthTypes

Common authentication types.

Base64

Base64 forms used by Matrix: unpadded for keys and ciphertexts, padded by some clients, URL-safe in JWKs; decoding accepts all.

CallAnswerContent

Content of CallAnswer.

CallCandidate

An ICE candidate of CallCandidatesContent; an empty Candidate ends the candidates.

CallCandidatesContent

Content of CallCandidates.

CallContent

Fields every call event has.

CallEncryptionKeysContent

Content of CallEncryptionKeys, sent to each member's device over Olm: the sender's key that its media is encrypted with.

CallHangupContent

Content of CallHangup.

CallInviteContent

Content of CallInvite.

CallKeyMember

The sender of CallEncryptionKeysContent.

CallMediaKey

A media key of a call member, in CallEncryptionKeysContent.

CallMemberContent

Content of CallMember, a device's membership in a room's call, as Element Call writes it; empty when the device left.

CallNegotiateContent

Content of CallNegotiate: a new offer or its answer during a call, e.g. to restart ICE after a network change.

CallRejectContent

Content of CallReject.

CallSelectAnswerContent

Content of CallSelectAnswer.

CallSessionDescription

An SDP offer or answer.

CanonicalAliasContent

Content of m.room.canonical_alias.

CanonicalJson

Canonical JSON: keys sorted by code point, no whitespace, minimal escaping; the form that Matrix signatures are made over.

ClientEvent

Room event as returned by sync, messages and state endpoints, see room event format.

ContextResponse

Response of GET /_matrix/client/v3/rooms/{roomId}/context/{eventId}.

CreateContent

Content of m.room.create.

CreateMediaResponse

Response of creating media before uploading its content.

CreateRoomRequest

Request of POST /_matrix/client/v3/createRoom.

CrossSigningKey

A cross-signing key: master, self-signing or user-signing.

CrossSigningUsages

Usages of Usage.

DelayedEventResponse

Response of sending a delayed event.

Device

A device, i.e. one logged-in session, of the user.

DeviceKeys

Signed device keys as uploaded and queried.

DeviceLists

Device list changes of a SyncResponse.

DevicesResponse

Response of GET /_matrix/client/v3/devices.

DirectContent

Content of m.direct: user ID to direct-message room IDs.

EncryptedContent

Content of m.room.encrypted, both Olm and Megolm.

EncryptedFile

Encrypted attachment: where the ciphertext is and how to decrypt it.

EncryptionAlgorithms

Encryption algorithm names.

EncryptionContent

Content of m.room.encryption.

ErrorCodes

Common error codes.

ErrorResponse

Standard error body returned with non-2xx responses.

EventFilter

Filter for non-room events.

EventIdResponse

Response holding an event ID, e.g. of send and redact.

EventList<T>

List of events.

EventTypes

Well-known event types.

ExceptionText

Text of exceptions for logs and messages.

Filter

Sync filter; upload with MatrixClient.CreateFilterAsync or pass ToJson() inline.

InReplyTo

Reply target of InReplyTo.

InitialStateEvent

State event of InitialState.

InvitedRoom

Update of an invited room.

JoinedMembersResponse

Response of GET /_matrix/client/v3/rooms/{roomId}/joined_members.

JoinedRoom

Update of a joined room.

JoinedRoomsResponse

Response of GET /_matrix/client/v3/joined_rooms.

JsonWebKey

JSON Web Key of an EncryptedFile.

KeyBackupAlgorithms

Algorithms of Algorithm.

KeyBackupData

One backed-up session key.

KeyBackupVersion

Key backup version from GET /room_keys/version.

KeysBackup

Backed-up keys by room ID, as uploaded and downloaded by /room_keys/keys.

KeysClaimResponse

Response of POST /_matrix/client/v3/keys/claim.

KeysQueryResponse

Response of POST /_matrix/client/v3/keys/query.

KeysUploadResponse

Response of POST /_matrix/client/v3/keys/upload.

KnockedRoom

Update of a room the user knocked on.

LeftRoom

Update of a left room.

LoginFlow

One supported login type, e.g. m.login.password.

LoginFlowsResponse

Response of GET /_matrix/client/v3/login.

LoginResponse

Response of POST /_matrix/client/v3/login.

MatrixEvent

Event with a type and content; used as is for account data and ephemeral events.

MatrixException

A homeserver returned a Matrix error, e.g. M_FORBIDDEN or M_UNKNOWN_TOKEN.

MatrixJson

Shared JSON settings matching Matrix wire conventions.

MatrixLink

Link to a room, a user or an event: a matrix.to link, a matrix: URI or a bare identifier.

MediaInfo

Attachment metadata of Info, see m.file.

MemberContent

Content of m.room.member; state key is the user ID.

MembersResponse

Response of GET /_matrix/client/v3/rooms/{roomId}/members.

Memberships

Membership states of Membership.

Mentions

Intentional mentions of a message.

MessageContent

Content of m.room.message.

MessageFormats

Formats of Format.

MessageTypes

Message types of MessageType.

MessagesResponse

Response of GET /_matrix/client/v3/rooms/{roomId}/messages.

NameContent

Content of m.room.name.

OpenIdTokenResponse

Response of POST /user/{userId}/openid/request_token: a token that proves the user to another service.

PasswordLoginRequest

Request of POST /_matrix/client/v3/login with type m.login.password.

PowerLevelsContent

Content of m.room.power_levels: who may do what in a room, as levels from 0 up, where 100 is usually an admin and 50 a moderator.

PresenceContent

Content of m.presence, also the presence status response.

PresenceEvent

Presence update of Sender, content PresenceContent.

PresenceStates

Presence states.

ProfileResponse

Response of GET /_matrix/client/v3/profile/{userId}.

PublicRoom

Room listed in the public room directory.

PublicRoomsResponse

Response of GET /_matrix/client/v3/publicRooms.

ReactionContent

Content of m.reaction.

ReceiptContent

Content of m.receipt: event ID, then receipt type, then user ID.

ReceiptInfo

One receipt of ReceiptContent.

ReceiptTypes

Receipt types.

RedactionContent

Content of m.room.redaction.

RegisterRequest

Request of POST /_matrix/client/v3/register.

RegisterResponse

Response of POST /_matrix/client/v3/register; tokens are missing when login was inhibited.

Relation

Relation between events.

RelationTypes

Relation types of RelType.

RoomAliasResponse

Response of GET /_matrix/client/v3/directory/room/{roomAlias}.

RoomAliasesResponse

Response of GET /_matrix/client/v3/rooms/{roomId}/aliases.

RoomAvatarContent

Content of m.room.avatar.

RoomEventFilter

Filter for room events.

RoomFilter

Filter for room data.

RoomIdResponse

Response holding a room ID, e.g. of join and create room.

RoomKeyBackup

Backed-up keys of one room, by session ID.

RoomKeyContent

Content of m.room_key, received over Olm.

RoomMember

Joined member of JoinedMembersResponse.

RoomPresets

Presets of Preset.

RoomSummary

Room summary for computing a room name.

RoomTags

Predefined room tags.

RtcDeclineContent

Content of RtcDecline: the callee declined the call of a notification.

RtcFocusActive

The focus a member uses, in FocusActive: LiveKit, each member on the SFU of its own homeserver.

RtcNotificationContent

Content of RtcNotification: a call started, ringing the others' devices for Lifetime.

RtcTransport

A MatrixRTC transport: how media goes, e.g. a LiveKit SFU behind its authorization service.

RtcTransportsResponse

Response of GET /_matrix/client/unstable/org.matrix.msc4143/rtc/transports: the homeserver's transports, preferred first.

StringOrNumberConverter

Reads a JSON string or number as text, as call versions are either; writes text.

StrippedStateEvent

Partial state of an invited room, see stripped state.

SyncResponse

Response of GET /_matrix/client/v3/sync.

SyncRooms

Room updates of a SyncResponse by membership, keyed by room ID.

TagContent

Content of m.tag, also the tags response.

TagInfo

One tag of TagContent.

TermsPolicy

A policy of the Terms stage, such as terms of service, that the user reads and accepts, in one language.

Timeline

Timeline section of a room update.

ToDeviceEvent

Send-to-device event of ToDevice.

TopicContent

Content of m.room.topic.

TurnServerResponse

Response of GET /_matrix/client/v3/voip/turnServer: time-limited TURN credentials; empty when the server has no TURN.

TypingContent

Content of m.typing.

UnreadNotificationCounts

Unread notification counts of a room.

UnsignedData

Server-added unsigned data of a ClientEvent.

UploadResponse

Response of POST /_matrix/media/v3/upload.

UserDirectoryEntry

User found by MatrixClient.SearchUsersAsync.

UserDirectoryResponse

Response of POST /_matrix/client/v3/user_directory/search.

UserIdentifier

Identifier of type m.id.user.

UserInteractiveAuthResponse

401 body of the user-interactive auth API.

VerificationRequestContent

Content of an in-room verification request: an m.room.message of msgtype m.key.verification.request.

VersionsResponse

Response of GET /_matrix/client/versions.

WellKnownClient

Body of GET /.well-known/matrix/client.

WellKnownServer

The m.homeserver entry of WellKnownClient.

WhoAmIResponse

Response of GET /_matrix/client/v3/account/whoami.

WhoisConnection

A connection of a WhoisSession.

WhoisDevice

A device in a WhoisResponse.

WhoisResponse

Response of whois: a user's devices and their connections.

WhoisSession

A session of a WhoisDevice.

Structs

MxcUri

Content URI of the form mxc://server/mediaId.

UserId

User ID of the form @localpart:server.

Enums

Direction

Pagination direction of MatrixClient.GetMessagesAsync.