Query users with recent device key updates. More...

#include <keys.hpp>

Inheritance diagram for Kazv::Api::GetKeysChangesJob:

Collaboration diagram for Kazv::Api::GetKeysChangesJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	GetKeysChangesJob (std::string serverUrl, std::string _accessToken, std::string from, std::string to)
	Query users with recent device key updates. More...

GetKeysChangesJob	withData (JsonWrap j) &&

GetKeysChangesJob	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 (std::string from, std::string to)

static BaseJob::Body	buildBody (std::string from, std::string to)

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

Query users with recent device key updates.

Gets a list of users who have updated their device identity keys since a previous sync token.

The server should include in the results any users who:

currently share a room with the calling user (ie, both users have membership state join); and
added new device identity keys or removed an existing device with identity keys, between from and to.

Constructor & Destructor Documentation

◆ GetKeysChangesJob()

Kazv::Api::GetKeysChangesJob::GetKeysChangesJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	from,
		std::string	to
	)

explicit

Query users with recent device key updates.

Parameters

from	The desired start point of the list. Should be the `next_batch` field from a response to an earlier call to `/sync`. Users who have not uploaded new device identity keys since this point, nor deleted existing devices with identity keys since then, will be excluded from the results.
to	The desired end point of the list. Should be the `next_batch` field from a recent call to `/sync` - typically the most recent such call. This may be used by the server as a hint to check its caches are up to date.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::GetKeysChangesJob::buildBody	(	std::string	from,
		std::string	to
	)

static

◆ buildQuery()

BaseJob::Query Kazv::Api::GetKeysChangesJob::buildQuery	(	std::string	from,
		std::string	to
	)

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/keys.hpp
src/api/csapi/keys.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members