Kazv::Api::SearchUserDirectoryJob::User Struct Reference

Performs a search for users. More...

#include <users.hpp>

Public Attributes
std::string	userId
	The user's matrix user ID. More...
std::optional< std::string >	displayName
	The display name of the user, if one exists. More...
std::optional< std::string >	avatarUrl
	The avatar url, as an MXC, if one exists. More...

Detailed Description

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.

Member Data Documentation

avatarUrl

std::optional<std::string> Kazv::Api::SearchUserDirectoryJob::User::avatarUrl

The avatar url, as an MXC, if one exists.

displayName

std::optional<std::string> Kazv::Api::SearchUserDirectoryJob::User::displayName

The display name of the user, if one exists.

userId

std::string Kazv::Api::SearchUserDirectoryJob::User::userId

The user's matrix user ID.

---

The documentation for this struct was generated from the following file:

• src/api/csapi/users.hpp