Files

• dir include Include directory. Add this to your include path.
  • dir mtx The root directory for all the type definitions listed in the specifications.
    • dir events The different event types in the Matrix API.
      • dir ephemeral /
        • file receipt.hpp Read notifications.
        • file typing.hpp Typing notifications.
      • dir messages The different types, that can be sent as a message event.
        • file audio.hpp Audio messages.
        • file elementeffect.hpp A message with a fancy effect.
        • file emote.hpp Events describing an emotion or action.
        • file file.hpp A file sent in a room.
        • file image.hpp Images sent in a room.
        • file location.hpp Real-world locations to send in a room.
        • file notice.hpp A bot generated message and other notices.
        • file text.hpp A text message.
        • file unknown.hpp An unknown message. According to the spec, this must have a text fallback.
        • file video.hpp A video sent in a room.
      • dir mscs MSCs, that are not yet part of the specification.
        • file image_packs.hpp Image packs from MSC2545
      • dir nheko_extensions Nheko specific event types not part of the official specification.
        • file event_expiry.hpp A nheko specific event in account data used to delete events meeting certain criteria.
        • file hidden_events.hpp A nheko specific event in account data used to hide events across different clients.
      • file common.hpp Structs used in multiple different event types.
      • file aliases.hpp Alias events.
      • file avatar.hpp Room avatar events.
      • file canonical_alias.hpp Change the canonical or listed avatars of a room.
      • file collections.hpp Collections to store multiple events of different types.
      • file create.hpp The first event in a room.
      • file encrypted.hpp Various event types used in E2EE.
      • file encryption.hpp The event enabling encryption in a room.
      • file event_type.hpp Enumeration of all event types.
      • file guest_access.hpp An event describing, if guest accounts can join a room.
      • file history_visibility.hpp State event describing the visibility of the history.
      • file join_rules.hpp Manage the permission of how people can join a room.
      • file member.hpp The state event describing the membership status of a specific member.
      • file unknown.hpp The room name state event.
      • file name.hpp The room name state event.
      • file pinned_events.hpp Events pinned in a room.
      • file policy_rules.hpp policy rules for room moderation
      • file power_levels.hpp The state event governing the different permissions in a room.
      • file presence.hpp An ephemeral event describing the presence of a user.
      • file reaction.hpp A reaction event used to attach small annotations to events.
      • file redaction.hpp Events describing redactions and redacted content.
      • file server_acl.hpp Server ACL events.
      • file spaces.hpp Space related events to make child and parent relations.
      • file tag.hpp Events describing room tags.
      • file tombstone.hpp An event describing a room upgrade or shutdown.
      • file topic.hpp The state event describing the topic in a room.
      • file voip.hpp Call related events.
      • file widget.hpp A widget in account data or a room.
    • dir responses The reponses returned from each request.
      • file common.hpp Responses used by multiple endpoints.
      • file capabilities.hpp Responses from the capabilities API.
      • file create_room.hpp Response from creating a room.
      • file crypto.hpp E2EE related endpoints.
      • file device.hpp device related endpoints.
      • file empty.hpp Empty responses returned by different endpoints.
      • file login.hpp Login related responses.
      • file media.hpp Responses returned by the media repo.
      • file members.hpp Responses for the endpoints to list members.
      • file messages.hpp Reponses from the message pagination API.
      • file notifications.hpp Notification related endpoints.
      • file profile.hpp Responses from the profile API.
      • file register.hpp Responses from the registration API.
      • file sync.hpp Response from the /sync API.
      • file turn_server.hpp Responses for the turn server used for calls.
      • file users.hpp Response for the endpoint to search users.
      • file version.hpp Return value of the server and API version query.
      • file well-known.hpp Response for .well-known lookup.
    • file common.hpp Common types used by the crypto related endpoints. Common types used by room directory endpoints.
    • file errors.hpp The error struct returned by the Matrix API.
    • file events.hpp Basetypes for events. Content is defined elsewhere.
    • file identifiers.hpp Identifiers used in the Matrix API.
    • file lightweight_error.hpp Error codes returned by the Matrix API.
    • file log.hpp Header for logging related functions.
    • file pushrules.hpp Pushrules and notification settings.
    • file requests.hpp Structs for for requests to the Matrix API.
    • file responses.hpp Collection header for all the different response structs.
    • file secret_storage.hpp Header with SSSS related types.
    • file user_interactive.hpp Header with types for user interactive authentication.
  • dir mtxclient The root directory for all the client callbacks.
    • dir crypto Wrappers around the olm library as well as other encryption specific functionality.
      • file client.hpp Holds most of the crypto functions and errors as well as a Client, which does the Olm account bookkeeping for you.
      • file objects.hpp Wrappers around the various Olm types.
      • file types.hpp Various type definitions for the crypto API.
      • file utils.hpp Various crypto functions.
    • dir http Functions to invoke the API over HTTP.
      • file errors.hpp Error codes returned by the client-server API.
      • file client.hpp Primary header to access the http API.
      • file client_impl.hpp All the template stuff needed for the http client.
    • file utils.hpp Various utility functions for http requests.
  • file mtx.hpp A header including pretty much all the headers of the library. Including this will have a significant compile time cost.