Upload a new filter. More...

#include <filter.hpp>

Inheritance diagram for Kazv::Api::DefineFilterJob:

Collaboration diagram for Kazv::Api::DefineFilterJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	DefineFilterJob (std::string serverUrl, std::string _accessToken, std::string userId, Filter filter)
	Upload a new filter. More...

DefineFilterJob	withData (JsonWrap j) &&

DefineFilterJob	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::string userId, Filter filter)

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 a new filter.

Uploads a new filter definition to the homeserver. Returns a filter ID that may be used in future requests to restrict which events are returned to the client.

Constructor & Destructor Documentation

◆ DefineFilterJob()

Kazv::Api::DefineFilterJob::DefineFilterJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	userId,
		Filter	filter
	)

explicit

Upload a new filter.

Parameters

userId	The id of the user uploading the filter. The access token must be authorized to make requests for this user id.
filter	The filter to upload.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::DefineFilterJob::buildBody	(	std::string	userId,
		Filter	filter
	)

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/filter.hpp
src/api/csapi/filter.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members