Kazv::Api::GetDisplayNameJob Class Reference

Get the user's display name. More...

#include <profile.hpp>

Inheritance diagram for Kazv::Api::GetDisplayNameJob:
Collaboration diagram for Kazv::Api::GetDisplayNameJob:


class  JobResponse

Public Member Functions

 GetDisplayNameJob (std::string serverUrl, std::string userId)
 Get the user's display name. More...
GetDisplayNameJob withData (JsonWrap j) &&
GetDisplayNameJob 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< FileDescresponseFile () const

Static Public Member Functions

static constexpr auto needsAuth ()
static BaseJob::Query buildQuery ()
static BaseJob::Body buildBody (std::string userId)
- 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 display name.

Get the user's display name. This API may be used to fetch the user's own displayname or to query the name of other users; either locally or on remote homeservers.

Constructor & Destructor Documentation

◆ GetDisplayNameJob()

Kazv::Api::GetDisplayNameJob::GetDisplayNameJob ( std::string  serverUrl,
std::string  userId 

Get the user's display name.

userIdThe user whose display name to get.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::GetDisplayNameJob::buildBody ( std::string  userId)

◆ buildQuery()

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

◆ needsAuth()

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

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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