Create a new room. More...

#include <create_room.hpp>

Inheritance diagram for Kazv::Api::CreateRoomJob:

Collaboration diagram for Kazv::Api::CreateRoomJob:

[legend]

Classes
struct	Invite3pid
	Create a new room with various configuration options. More...

class	JobResponse

struct	StateEvent
	Create a new room with various configuration options. More...

Public Member Functions
	CreateRoomJob (std::string serverUrl, std::string _accessToken, std::optional< std::string > visibility=std::nullopt, std::optional< std::string > roomAliasName=std::nullopt, std::optional< std::string > name=std::nullopt, std::optional< std::string > topic=std::nullopt, immer::array< std::string > invite={}, immer::array< Invite3pid > invite3pid={}, std::optional< std::string > roomVersion=std::nullopt, JsonWrap creationContent={}, immer::array< StateEvent > initialState={}, std::optional< std::string > preset=std::nullopt, std::optional< bool > isDirect=std::nullopt, JsonWrap powerLevelContentOverride={})
	Create a new room. More...

CreateRoomJob	withData (JsonWrap j) &&

CreateRoomJob	withData (JsonWrap j) const &

Public Member Functions inherited from Kazv::BaseJob
	BaseJob (std::string serverUrl, std::string requestUrl, Method method, std::string jobId, std::string token={}, ReturnType returnType=ReturnType::Json, Body body=EmptyBody{}, Query query={}, Header header={}, std::optional< FileDesc > responseFile=std::nullopt)

	~BaseJob ()

bool	shouldReturnJson () const

std::string	url () const

Body	requestBody () const

Header	requestHeader () const

ReturnType	returnType () const

Query	requestQuery () const
	returns the non-encoded query as an array of pairs More...

Method	requestMethod () const

Response	genResponse (Response r) const

BaseJob	withData (JsonWrap j) &&

BaseJob	withData (JsonWrap j) const &

BaseJob	withQueue (std::string id, JobQueuePolicy policy=AlwaysContinue) &&

BaseJob	withQueue (std::string id, JobQueuePolicy policy=AlwaysContinue) const &

json	dataJson (const std::string &key) const

std::string	dataStr (const std::string &key) const

std::string	jobId () const

std::optional< std::string >	queueId () const

JobQueuePolicy	queuePolicy () const

std::optional< FileDesc >	responseFile () const

Static Public Member Functions
static constexpr auto	needsAuth ()

static BaseJob::Query	buildQuery ()

static BaseJob::Body	buildBody (std::optional< std::string > visibility, std::optional< std::string > roomAliasName, std::optional< std::string > name, std::optional< std::string > topic, immer::array< std::string > invite, immer::array< Invite3pid > invite3pid, std::optional< std::string > roomVersion, JsonWrap creationContent, immer::array< StateEvent > initialState, std::optional< std::string > preset, std::optional< bool > isDirect, JsonWrap powerLevelContentOverride)

Static Public Member Functions inherited from Kazv::BaseJob
static bool	contentTypeMatches (immer::array< std::string > expected, std::string actual)

Additional Inherited Members
Public Types inherited from Kazv::BaseJob
enum	ReturnType { Json, File }

using	Method = std::variant< Get, Post, Put, Delete >

using	Body = ::Kazv::Body

using	BytesBody = ::Kazv::BytesBody

using	JsonBody = ::Kazv::JsonBody

using	EmptyBody = ::Kazv::EmptyBody

using	Header = ::Kazv::Header

using	Response = ::Kazv::Response

Static Public Attributes inherited from Kazv::BaseJob
static Get	GET {}

static Post	POST {}

static Put	PUT {}

static Delete	DELETE {}

Protected Member Functions inherited from Kazv::BaseJob
void	attachData (JsonWrap data)

Detailed Description

Create a new room.

Create a new room with various configuration options.

The server MUST apply the normal state resolution rules when creating the new room, including checking power levels for each event. It MUST apply the events implied by the request in the following order:

The m.room.create event itself. Must be the first event in the room.
An m.room.member event for the creator to join the room. This is needed so the remaining events can be sent.
A default m.room.power_levels event, giving the room creator (and not other members) permission to send state events. Overridden by the power_level_content_override parameter.
An m.room.canonical_alias event if room_alias_name is given.
Events set by the preset. Currently these are the m.room.join_rules, m.room.history_visibility, and m.room.guest_access state events.
Events listed in initial_state, in the order that they are listed.
Events implied by name and topic (m.room.name and m.room.topic state events).
Invite events implied by invite and invite_3pid (m.room.member with membership: invite and m.room.third_party_invite).

The available presets do the following with respect to room state:

Preset	`join_rules`	`history_visibility`	`guest_access`	Other
`private_chat`	`invite`	`shared`	`can_join`
`trusted_private_chat`	`invite`	`shared`	`can_join`	All invitees are given the same power level as the room creator.
`public_chat`	`public`	`shared`	`forbidden`

The server will create a m.room.create event in the room with the requesting user as the creator, alongside other keys provided in the creation_content.

Constructor & Destructor Documentation

◆ CreateRoomJob()

Kazv::Api::CreateRoomJob::CreateRoomJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::optional< std::string >	visibility = `std::nullopt`,
		std::optional< std::string >	roomAliasName = `std::nullopt`,
		std::optional< std::string >	name = `std::nullopt`,
		std::optional< std::string >	topic = `std::nullopt`,
		immer::array< std::string >	invite = `{}`,
		immer::array< Invite3pid >	invite3pid = `{}`,
		std::optional< std::string >	roomVersion = `std::nullopt`,
		JsonWrap	creationContent = `{}`,
		immer::array< StateEvent >	initialState = `{}`,
		std::optional< std::string >	preset = `std::nullopt`,
		std::optional< bool >	isDirect = `std::nullopt`,
		JsonWrap	powerLevelContentOverride = `{}`
	)

explicit

Create a new room.

Parameters

visibility	A `public` visibility indicates that the room will be shown in the published room list. A `private` visibility will hide the room from the published room list. Rooms default to `private` visibility if this key is not included. NB: This should not be confused with `join_rules` which also uses the word `public`.
roomAliasName	The desired room alias local part. If this is included, a room alias will be created and mapped to the newly created room. The alias will belong on the same homeserver which created the room. For example, if this was set to "foo" and sent to the homeserver "example.com" the complete room alias would be `#foo:example.com`.

The complete room alias will become the canonical alias for the room and an m.room.canonical_alias event will be sent into the room.

Parameters

name	If this is included, an `m.room.name` event will be sent into the room to indicate the name of the room. See Room Events for more information on `m.room.name`.
topic	If this is included, an `m.room.topic` event will be sent into the room to indicate the topic for the room. See Room Events for more information on `m.room.topic`.
invite	A list of user IDs to invite to the room. This will tell the server to invite everyone in the list to the newly created room.
invite3pid	A list of objects representing third party IDs to invite into the room.
roomVersion	The room version to set for the room. If not provided, the homeserver is to use its configured default. If provided, the homeserver will return a 400 error with the errcode `M_UNSUPPORTED_ROOM_VERSION` if it does not support the room version.
creationContent	Extra keys, such as `m.federate`, to be added to the content of the `m.room.create` event. The server will overwrite the following keys: `creator`, `room_version`. Future versions of the specification may allow the server to overwrite other keys.
initialState	A list of state events to set in the new room. This allows the user to override the default state events set in the new room. The expected format of the state events are an object with type, state_key and content keys set.

Takes precedence over events set by preset, but gets overridden by name and topic keys.

Parameters

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

If unspecified, the server should use the visibility to determine which preset to use. A visbility of public equates to a preset of public_chat and private visibility equates to a preset of private_chat.

Parameters

isDirect	This flag makes the server set the `is_direct` flag on the `m.room.member` events sent to the users in `invite` and `invite_3pid`. See Direct Messaging for more information.
powerLevelContentOverride	The power level content to override in the default power level event. This object is applied on top of the generated `m.room.power_levels` event content prior to it being sent to the room. Defaults to overriding nothing.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::CreateRoomJob::buildBody	(	std::optional< std::string >	visibility,
		std::optional< std::string >	roomAliasName,
		std::optional< std::string >	name,
		std::optional< std::string >	topic,
		immer::array< std::string >	invite,
		immer::array< Invite3pid >	invite3pid,
		std::optional< std::string >	roomVersion,
		JsonWrap	creationContent,
		immer::array< StateEvent >	initialState,
		std::optional< std::string >	preset,
		std::optional< bool >	isDirect,
		JsonWrap	powerLevelContentOverride
	)

static

◆ buildQuery()

BaseJob::Query Kazv::Api::CreateRoomJob::buildQuery ( )

static

◆ needsAuth()

static constexpr auto Kazv::Api::CreateRoomJob::needsAuth ( )

inlinestaticconstexpr

◆ withData() [1/2]

CreateRoomJob Kazv::Api::CreateRoomJob::withData ( JsonWrap j ) &&

◆ withData() [2/2]

CreateRoomJob Kazv::Api::CreateRoomJob::withData ( JsonWrap j ) const &

The documentation for this class was generated from the following files:

src/api/csapi/create_room.hpp
src/api/csapi/create_room.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateRoomJob()

Member Function Documentation

◆ buildBody()

◆ buildQuery()

◆ needsAuth()

◆ withData() [1/2]

◆ withData() [2/2]