Searches the user directory. More...

#include <users.hpp>

Inheritance diagram for Kazv::Api::SearchUserDirectoryJob:

Collaboration diagram for Kazv::Api::SearchUserDirectoryJob:

[legend]

Classes
class	JobResponse

struct	User
	Performs a search for users. More...

Public Member Functions
	SearchUserDirectoryJob (std::string serverUrl, std::string _accessToken, std::string searchTerm, std::optional< int > limit=std::nullopt)
	Searches the user directory. More...

SearchUserDirectoryJob	withData (JsonWrap j) &&

SearchUserDirectoryJob	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 searchTerm, std::optional< int > limit)

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

Searches the user directory.

Performs a search for users. The homeserver may determine which subset of users are searched, however the homeserver MUST at a minimum consider the users the requesting user shares a room with and those who reside in public rooms (known to the homeserver). The search MUST consider local users to the homeserver, and SHOULD query remote users as part of the search.

The search is performed case-insensitively on user IDs and display names preferably using a collation determined based upon the Accept-Language header provided in the request, if present.

Constructor & Destructor Documentation

◆ SearchUserDirectoryJob()

Kazv::Api::SearchUserDirectoryJob::SearchUserDirectoryJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	searchTerm,
		std::optional< int >	limit = `std::nullopt`
	)

explicit

Searches the user directory.

Parameters

searchTerm	The term to search for
limit	The maximum number of results to return. Defaults to 10.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::SearchUserDirectoryJob::buildBody	(	std::string	searchTerm,
		std::optional< int >	limit
	)

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/users.hpp
src/api/csapi/users.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members