Upload end-to-end encryption keys. More...

#include <keys.hpp>

Inheritance diagram for Kazv::Api::UploadKeysJob:

Collaboration diagram for Kazv::Api::UploadKeysJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	UploadKeysJob (std::string serverUrl, std::string _accessToken, std::optional< DeviceKeys > deviceKeys=std::nullopt, JsonWrap oneTimeKeys={}, JsonWrap fallbackKeys={})
	Upload end-to-end encryption keys. More...

UploadKeysJob	withData (JsonWrap j) &&

UploadKeysJob	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< DeviceKeys > deviceKeys, JsonWrap oneTimeKeys, JsonWrap fallbackKeys)

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

Upload end-to-end encryption keys.

Publishes end-to-end encryption keys for the device.

Constructor & Destructor Documentation

◆ UploadKeysJob()

Kazv::Api::UploadKeysJob::UploadKeysJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::optional< DeviceKeys >	deviceKeys = `std::nullopt`,
		JsonWrap	oneTimeKeys = `{}`,
		JsonWrap	fallbackKeys = `{}`
	)

explicit

Upload end-to-end encryption keys.

Parameters

deviceKeys	Identity keys for the device. May be absent if no new identity keys are required.
oneTimeKeys	One-time public keys for "pre-key" messages. The names of the properties should be in the format `<algorithm>:<key_id>`. The format of the key is determined by the key algorithm.

May be absent if no new one-time keys are required.

Parameters

fallbackKeys The public key which should be used if the device's one-time keys are exhausted. The fallback key is not deleted once used, but should be replaced when additional one-time keys are being uploaded. The server will notify the client of the fallback key being used through /sync.

There can only be at most one key per algorithm uploaded, and the server will only persist one key per algorithm.

When uploading a signed key, an additional fallback: true key should be included to denote that the key is a fallback key.

May be absent if a new fallback key is not required.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::UploadKeysJob::buildBody	(	std::optional< DeviceKeys >	deviceKeys,
		JsonWrap	oneTimeKeys,
		JsonWrap	fallbackKeys
	)

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

UploadKeysJob Kazv::Api::UploadKeysJob::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