mtx::requests namespace

Namespace for request structs.

Classes

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.

Enums

enum class Preset { PrivateChat, PublicChat, TrustedPrivateChat }: Convenience parameter for setting various default state events based on a preset.

Typedefs

template<typename EventContent> using ToDeviceMessages = std::map<mtx::identifiers::User, std::map<std::string, EventContent>>: Request payload for the PUT /_matrix/client/r0/sendToDevice/{eventType}/{transcationID}
using Logout = Empty: A successfull logout.

Variables

uint64_t DEFAULT_DOWNLOAD_TIMEOUT constexpr: The default timeout for a download.

Enum documentation

enum class mtx::requests::Preset
#include <include/mtx/requests.hpp>

Convenience parameter for setting various default state events based on a preset.

Enumerators
PrivateChat	`join_rules` is set to `invite`. `history_visibility` is set to `shared`.
PublicChat	`join_rules` is set to `public`. `history_visibility` is set to `shared`.
TrustedPrivateChat	`join_rules` is set to `invite`. `history_visibility` is set to `shared`. All invitees are given the same power level as the room creator.

Typedef documentation

#include <include/mtx/requests.hpp>

template<typename EventContent>
using mtx::requests::ToDeviceMessages = std::map<mtx::identifiers::User, std::map<std::string, EventContent>>

Request payload for the PUT /_matrix/client/r0/sendToDevice/{eventType}/{transcationID}

using mtx::requests::Logout = Empty
#include <include/mtx/requests.hpp>

A successfull logout.

Variable documentation

uint64_t mtx::requests::DEFAULT_DOWNLOAD_TIMEOUT constexpr
#include <include/mtx/requests.hpp>

The default timeout for a download.