Classes

• namespace mtx Top level namespace for mtxclient.
  • namespace client A few helpers for the http client.
    • namespace utils Utility namespace.
      • struct MxcUrl Representation of Matrix Content (MXC) URIs.
  • namespace common Common structs used among many different event content types.
    • struct AudioInfo Audio clip metadata.
    • struct FileInfo Metadata about a file.
    • struct ImageInfo Metadata about an image.
    • struct LocationInfo Location metadata.
    • struct Mentions Mentions metadata.
    • struct Relation Relates to for reactions.
    • struct Relations Multiple relations for a event.
    • struct ThumbnailInfo Metadata about an image thumbnail.
    • struct VideoInfo Video clip metadata.
  • namespace crypto Cryptography related types.
    • struct AccountObject Wrapper for the olm account object.
    • class crypto_exception Exception thrown for various encryption related errors (not reported by olm), that generally should not be ignored.
    • struct CURVE25519_AES_SHA2_Encrypted Base64 encoded CURVE25519_AES_SHA2 encrypted text, including the mac and ephemeral key.
    • struct ExportedSession An exported megolm group session.
    • struct ExportedSessionKeys A list of exported sessions.
    • struct GroupPlaintext Return value from decrypting a group message.
    • struct HkdfKeys HKDF key derivation with SHA256 digest.
    • struct IdentityKeys A pair of keys connected to an olm account.
    • struct InboundSessionObject Wrapper around the olm object for inbound group sessions used to decrypt messages in matrix rooms.
    • class olm_exception Errors returned by the olm library.
    • class OlmClient Client for all the cryptography related functionality like olm accounts, session keys encryption, signing and a few more things.
      • struct CrossSigningSetup Data needed for bootstrapping crosssigning.
      • struct OnlineKeyBackupSetup Data needed to setup the online key backup.
      • struct SSSSSetup Data needed to setup SSSS.
    • struct OlmDeleter Deleter type to pass as a template argument to most smart pointers.
    • struct OneTimeKeys A list of one time keys.
    • struct OutboundSessionObject Wrapper around the outbound olm session object used to encrypt outbound group messages in matrix rooms.
    • struct PkDecryptionObject Wrapper for the olm object to do Private Key Decryption.
    • struct PkEncryptionObject Wrapper for the olm object to do Private Key Decryption.
    • struct PkSigning Helper to sign arbitrary messages using an ed25519 key.
    • struct PkSigningObject Wrapper for the olm object to do Private Key Signing.
    • struct SAS Helper to generate Short Authentication Strings (SAS)
    • struct SASObject Olm type for Short Authentication Strings.
    • struct SessionObject Wrapper around olm sessions used for to device encryption.
    • struct UtilityObject Wrapper for the Olm utility object.
  • namespace errors Namespace for Matrix errors.
    • struct Error Represents a Matrix related error.
    • struct LightweightError Represents a Matrix related error.
  • namespace events Namespace for all events.
    • namespace account_data Namespace for events in account_data.
      • namespace nheko_extensions Custom nheko specific event types.
        • struct EventExpiry Custom event to delete certain events automatically (e.g. after a certain time). Can be configured globally or per room.
        • struct HiddenEvents Custom event to hide certain event types in nheko.
      • struct Direct The direct chats for a user / m.direct.
      • struct FullyRead The fully read marker for this user / m.fully_read.
      • struct IgnoredUser An entry in m.ignored_user_list. Currently only the key (mxid) is supported, not arbitrary values.
      • struct Tag The content of a tag.
      • struct Tags Content for the m.tag room account_data event. A tag is a short string a client can attach to a room for sorting or advanced functionality.
    • namespace collections Contains heterogeneous collections of events using std::variant.
      • struct DeviceEvents Collection of key verification events.
      • struct RoomAccountDataEvents Collection of room specific account data.
      • struct StateEvents Collection of StateEvent only.
      • struct StrippedEvents Collection of StrippedEvent only.
      • struct TimelineEvents Collection of StateEvent and RoomEvent. Those events would be available on the returned timeline.
    • namespace ephemeral Ephemeral events not part of the timeline like typing and read notifications.
      • struct IndividualReceipt An individual receipt, which specifies when the event was read by this user.
      • struct Receipt Read notifications / m.receipt
      • struct Receipts A list of receipts for a single event.
      • struct Typing Typing notifications / m.typing.
    • namespace msc2545 Custom emotes and stickers MSC.
      • struct ImagePack A pack of stickers and/or emoticons.
        • struct PackDescription Information about an image pack.
      • struct ImagePackRooms The image packs from rooms enabled by this user to be available globally.
      • struct PackImage A single image in a pack.
    • namespace msg Non-state events sent in the timeline like messages.
      • struct Audio Content of m.room.message with msgtype m.audio.
      • struct Dummy Content of the m.dummy event.
      • struct ElementEffect Content of m.room.message with a msgtype used by Element to show a fancy effect.
      • struct Emote Content of m.room.message with msgtype m.emote.
      • struct Encrypted Content of the m.room.encrypted event.
      • struct File Content of m.room.message with msgtype m.file.
      • struct ForwardedRoomKey Content of the m.forwarded_room_key event.
      • struct Image Content of m.room.message with msgtype m.image.
      • struct KeyRequest A request to share a session key.
      • struct KeyVerificationAccept Implements the m.key.verification.accept event.
      • struct KeyVerificationCancel implementation of the m.key.verification.cancel event
      • struct KeyVerificationReady Implements the m.key.verification.ready event.
      • struct KeyVerificationRequest Content of the m.key.verification.request event.
      • struct KeyVerificationStart Content of the m.key.verification.start event.
      • struct Location Content of m.room.message with msgtype m.image.
      • struct Notice Content of m.room.message with msgtype m.notice.
      • struct OlmCipherContent Content of an individual message encrypted for a certain key.
      • struct OlmEncrypted Content of the m.room.encrypted Olm event.
      • struct Reaction Content for the m.reaction event.
      • struct Redacted Stripped out content for redacted events.
      • struct Redaction Content for the m.room.redaction state event.
      • struct RoomKey Content of the m.room_key event.
      • struct StickerImage Content of m.sticker.
      • struct Text Content of m.room.message with msgtype m.text.
      • struct Unknown Content of m.room.message with an unrecognized msgtype.
      • struct Video Content of m.room.message with msgtype m.video.
    • namespace state Events, that can be used as a state event.
      • namespace notification_keys different predefined keys for notification levels
      • namespace room_type Definitions of different room types.
      • namespace space Namespace for space related state events.
        • struct Child Event to point at a child room or space from a parent space.
        • struct Parent Event to point at a parent space from a room or space.
      • struct Aliases Content for the m.room.aliases event.
      • struct Avatar Content of the m.room.avatar event.
      • struct CanonicalAlias Content for the m.room.canonical_alias event.
      • struct Create Content of the m.room.create event.
      • struct Encryption Content of the m.room.encryption event.
      • struct GuestAccess Content of the m.room.guest_access state event.
      • struct HistoryVisibility Content of the m.room.history_visibility state event.
      • struct JoinAllowance An additional rule specifying what users are allowed to join.
      • struct JoinRules Content of the m.room.join_rules state event.
      • struct Member Content of the m.room.member state event.
      • struct Name Content of the m.room.name event.
      • struct PinnedEvents m.room.pinned_events state event.
      • struct PowerLevels Content for the m.room.power_levels state event.
      • struct PreviousRoom The predecessor of this room.
      • struct ServerAcl Content for the m.room.server_acl event.
      • struct Tombstone Content for the m.room.tombstone event.
      • struct Topic Content for the m.room.topic state event.
      • struct Widget Content of the m.widget event.
    • struct DeviceEvent Extension of the Event type for device events.
    • struct EncryptedEvent Extension of the RoomEvent.
    • struct EphemeralEvent An ephemeral event like typing or read receipts.
    • struct Event The basic set of fields all events must have.
    • struct RedactionEvent Extension of the RoomEvent.
    • struct RoomEvent RoomEvent.
    • struct StateEvent Extension of the RoomEvent.
    • struct Unknown Placeholder event for if an event is unsupported.
    • struct UnsignedData Additional server provided data for this event.
  • namespace http Types related to invoking the actual HTTP requests.
    • class Client The main object that the user will interact.
    • struct ClientError Compound type that includes matrix & network related errors.
    • struct MessagesOpts Configuration for the /messages endpoint.
    • struct SyncOpts Sync configuration options.
    • struct ThumbOpts Configuration for thumbnail retrieving.
    • class UIAHandler A helper to handle user interactive authentication. This will cache the request and call the prompt every time there is a new stage. Advance the flow by calling next().
  • namespace presence Presence specific types.
  • namespace pushrules Namespace for the pushrules specific endpoints.
    • namespace actions Namespace for the different push actions.
      • struct Actions A list of actions.
      • struct coalesce This enables notifications for matching events but activates homeserver specific behaviour to intelligently coalesce multiple events into a single notification.
      • struct dont_notify Don't notify the user.
      • struct notify Notify the user.
      • struct set_tweak_highlight Highlight the message.
      • struct set_tweak_sound Play a sound.
    • struct Enabled The response for queries, if a specific ruleset is enabled.
    • struct GlobalRuleset The global ruleset applied to all events.
    • struct PushCondition A condition to match pushrules on.
    • struct PushRule A pushrule defining the notification behaviour for a message.
    • class PushRuleEvaluator An optimized structure to calculate notifications for events.
      • struct RoomContext Additional room information needed to evaluate push rules.
    • struct Ruleset All the pushrules to evaluate for events.
  • namespace requests Namespace for request structs.
    • struct AvatarUrl Request payload for the POST /_matrix/client/r0/profile/{userId}/avatar_url endpoint.
    • struct ClaimKeys Claim onetime keys of devices of specific users.
    • struct CreateRoom Request payload for the POST /_matrix/client/r0/createRoom endpoint.
    • struct DeviceSigningUpload Upload cross signing keys.
    • struct DeviceUpdate Request payload for the PUT /_matrix/client/r0/devices/{deviceId} endpoint.
    • struct DisplayName Request payload for the PUT /_matrix/client/r0/profile/{userId}/displayname endpoint.
    • struct Empty An empty response.
    • struct IdentitySubmitToken Validate ownership of an email address/phone number.
    • struct KeySignaturesUpload Upload new signatures for a device or cross-signing key.
    • struct Login Request payload for the POST /_matrix/client/r0/login endpoint.
    • struct PublicRooms Request payload for the POST /_matrix/client/r0/publicRooms endpoint.
    • struct PublicRoomVisibility Request payload for the PUT /_matrix/client/r0/directory/list/room/{roomId} endpoint.
    • struct PusherData Information about a pusher.
    • struct QueryKeys Query the keys of devices of specific users.
    • struct RequestEmailToken Request payload for POST /_matrix/client/r0/{register,account/password}/email/requestToken
    • struct RequestMSISDNToken Request payload for POST /_matrix/client/r0/{register,account/password}/msisdn/requestToken
    • struct RoomMembershipChange Request payload for the POST /_matrix/client/r0/rooms/{roomId}/invite endpoint as well as ban, unban and kick.
    • struct SetPusher Request payload for the POST /_matrix/client/r0/pushers/set endpoint.
    • struct SignedOneTimeKey A signed onetime key. Usually curve25519.
    • struct TypingNotification Request payload for the PUT /_matrix/client/r0/rooms/{roomId}/typing/{userId} endpoint.
    • struct UploadKeys Upload a mix of device, one time and fallback keys.
  • namespace responses Namespace for the different types of responses.
    • namespace backup KeysBackup related responses.
      • struct BackupVersion Responses from the GET /_matrix/client/r0/room_keys/version endpoint.
      • struct EncryptedSessionData Encrypted session data using the m.megolm_backup.v1.curve25519-aes-sha2 algorithm.
      • struct KeysBackup Responses from the GET /_matrix/client/r0/room_keys/keys endpoint.
      • struct RoomKeysBackup Responses from the GET /_matrix/client/r0/room_keys/keys/{room_id} endpoint.
      • struct SessionBackup Responses from the GET /_matrix/client/r0/room_keys/keys/{room_id}/{session_id} endpoint.
      • struct SessionData The SessionData stored in the KeysBackup.
    • namespace utils Different helper for parsing responses.
    • struct AccountData Room specific Account Data events.
    • struct Aliases A simple list of aliases.
    • struct Available Some endpoints return this to indicate availability in addition to the http code (i.e. a username).
    • struct AvatarUrl Response from the GET /_matrix/client/r0/profile/{userId}/avatar_url endpoint.
    • struct ClaimKeys Response from the POST /_matrix/client/r0/keys/claim endpoint.
    • struct ContentURI Represents the response of POST /_matrix/media/r0/upload
    • struct CreateRoom Response from the POST /_matrix/client/r0/createRoom endpoint.
    • struct Device Information about one of your devices.
    • struct DeviceLists Information on e2e device updates.
    • struct Empty Used to represent empty responses.
    • struct Ephemeral The ephemeral events in the room that aren't recorded in the timeline or state of the room. e.g. typing.
    • struct EventId An event id returned by the API.
    • struct FilterId A filter id returned by the API.
    • struct HierarchyRooms Response from the GET /_matrix/client/v1/rooms/{roomId}/hierarchy
    • struct IdentityProvider Identity provider for SSO.
    • struct InvitedRoom A room that the user has been invited to.
    • struct JoinedRoom A room that the user has joined.
    • struct KeyChanges Response from the GET /_matrix/client/r0/keys/changes endpoint.
    • struct KeySignaturesUpload Request for POST /_matrix/client/r0/keys/upload.
    • struct KnockedRoom A room that the user has knocked on.
    • struct LeftRoom A room that the user has left or been banned from.
    • struct Login Response from the POST /_matrix/client/r0/login endpoint.
    • struct LoginFlow One supported login flow.
    • struct LoginFlows Response from the GET /_matrix/client/r0/login endpoint.
    • struct Members All the member events in a room.
    • struct Messages Response of the GET /_matrix/client/r0/rooms/{roomId}/messages endpoint.
    • struct Notification Description for a notification.
    • struct Notifications Response from the GET /_matrix/client/r0/notifications endpoint.
    • struct OGImage Represents an OpenGraph og:image.
    • struct Profile Response from the GET /_matrix/client/r0/profile/{userId} endpoint.
    • struct PublicRooms Response from the GET /_matrix/client/r0/publicRooms & POST /_matrix/client/r0/publicRooms endpoints.
    • struct PublicRoomVisibility Response from the GET /_matrix/client/r0/directory/list/room/{roomId}endpoint.
    • struct QueryDevices Response from the GET /_matrix/client/r0/devices endpoint.
    • struct QueryKeys Response from the POST /_matrix/client/r0/keys/query endpoint.
    • struct Register Response from the POST /_matrix/client/r0/register endpoint.
    • struct RegistrationTokenValidity Response from the GET /_matrix/client/v1/register/m.login.registration_token/validity endpoint.
    • struct RequestToken Responses to the /requestToken endpoints.
    • struct RoomId A room id returned by the API.
    • struct Rooms Room updates.
    • struct ServerInformation The info about this server.
    • struct State State events.
    • struct StateEvents An array of state events.
    • struct Success Some endpoints return this to indicate success in addition to the http code.
    • struct Sync Response from the GET /_matrix/client/r0/sync endpoint.
    • struct Timeline State and Room events.
    • struct ToDevice Information on to_device events in sync.
    • struct TurnServer Response of the GET /_matrix/client/r0/voip/turnServer endpoint.
    • struct UnreadNotifications Counts of unread notifications for this room.
    • struct UploadKeys Response from the POST /_matrix/client/r0/keys/upload endpoint.
    • struct URLPreview Represents the response of GET /_matrix/media/v3/preview_url, see https://ogp.me.
    • struct Users User directory search results.
    • struct Version A new room version as returned by the room_keys/version API.
    • struct Versions Response from the GET /_matrix/client/versions endpoint.
    • struct WellKnown Response from the GET /.well-known/matrix/client endpoint. May also be returned from POST /_matrix/client/r0/login.
  • namespace secret_storage SSSS related types to store encrypted data on the server.
    • namespace secrets Names of secrets used in the spec.
    • struct AesHmacSha2EncryptedData A aes-hmac-sha2 encrypted secret.
    • struct AesHmacSha2KeyDescription Description of the key for a secret.
    • struct PBKDF2 Information about the key derivation from a passphrase.
    • struct Secret A secret, encrypted with one or more algorithms.
  • namespace user_interactive Types and definitions for user interactive authentication.
    • namespace auth namespace for the request types in the different auth stages.
      • struct Dummy Empty struct to complete dummy auth.
      • struct EmailIdentity Email authentication stage.
      • struct Fallback Fallback auth.
      • struct MSISDN SMS authentication stage.
      • struct OAuth2 OAuth2, client retries with the session only, so I'm guessing this is empty?
      • struct Password Password stage.
      • struct ReCaptcha ReCaptcha stage.
      • struct RegistrationToken Registration token authentication stage.
      • struct SSO Empty struct to complete SSO.
      • struct Terms Empty struct, when parameters are accepted.
      • struct ThreePIDCred Third party identifier for Email or MSISDN stages.
      • struct Token Token stage.
    • namespace auth_types The different auth types.
    • struct Auth The auth request to complete a stage.
    • struct Flow A flow composed of a list of stages.
    • struct OAuth2Params Parameters for oauth2.
    • struct Policy A policy in the terms and conditions.
    • struct PolicyDescription The desciption of one policy in the terms and conditions.
    • struct TermsParams Parameters for the auth stage requiring you to accept terms and conditions.
    • struct Unauthorized The struct returned on requests failing with 401.