Get the user's current state. More...

#include <old_sync.hpp>

Inheritance diagram for Kazv::Api::InitialSyncJob:

Collaboration diagram for Kazv::Api::InitialSyncJob:

[legend]

Classes
class	JobResponse

struct	PaginationChunk
	The pagination chunk for this room. More...

struct	RoomInfo
	This returns the full state for this user, with an optional limit on the number of messages per room to return. More...

Public Member Functions
	InitialSyncJob (std::string serverUrl, std::string _accessToken, std::optional< int > limit=std::nullopt, std::optional< bool > archived=std::nullopt)
	Get the user's current state. More...

InitialSyncJob	withData (JsonWrap j) &&

InitialSyncJob	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::optional< int > limit, std::optional< bool > archived)

static BaseJob::Body	buildBody (std::optional< int > limit, std::optional< bool > archived)

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

Get the user's current state.

This returns the full state for this user, with an optional limit on the number of messages per room to return.

This endpoint was deprecated in r0 of this specification. Clients should instead call the /sync endpoint with no since parameter. See the migration guide.

Constructor & Destructor Documentation

◆ InitialSyncJob()

Kazv::Api::InitialSyncJob::InitialSyncJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::optional< int >	limit = `std::nullopt`,
		std::optional< bool >	archived = `std::nullopt`
	)

explicit

Get the user's current state.

Parameters

limit	The maximum number of messages to return for each room.
archived	Whether to include rooms that the user has left. If `false` then only rooms that the user has been invited to or has joined are included. If set to `true` then rooms that the user has left are included as well. By default this is `false`.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::InitialSyncJob::buildBody	(	std::optional< int >	limit,
		std::optional< bool >	archived
	)

static

◆ buildQuery()

BaseJob::Query Kazv::Api::InitialSyncJob::buildQuery	(	std::optional< int >	limit,
		std::optional< bool >	archived
	)

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/old_sync.hpp
src/api/csapi/old_sync.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members