Get information about a URL for a client. More...

#include <content-repo.hpp>

Inheritance diagram for Kazv::Api::GetUrlPreviewJob:

Collaboration diagram for Kazv::Api::GetUrlPreviewJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	GetUrlPreviewJob (std::string serverUrl, std::string _accessToken, std::string url, std::optional< std::int_fast64_t > ts=std::nullopt)
	Get information about a URL for a client. More...

GetUrlPreviewJob	withData (JsonWrap j) &&

GetUrlPreviewJob	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::string url, std::optional< std::int_fast64_t > ts)

static BaseJob::Body	buildBody (std::string url, std::optional< std::int_fast64_t > ts)

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 information about a URL for a client.

Get information about a URL for the client. Typically this is called when a client sees a URL in a message and wants to render a preview for the user.

Note: Clients should consider avoiding this endpoint for URLs posted in encrypted rooms. Encrypted rooms often contain more sensitive information the users do not want to share with the homeserver, and this can mean that the URLs being shared should also not be shared with the homeserver.

Constructor & Destructor Documentation

◆ GetUrlPreviewJob()

Kazv::Api::GetUrlPreviewJob::GetUrlPreviewJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	url,
		std::optional< std::int_fast64_t >	ts = `std::nullopt`
	)

explicit

Get information about a URL for a client.

Parameters

url	The URL to get a preview of.
ts	The preferred point in time to return a preview for. The server may return a newer version if it does not have the requested version available.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::GetUrlPreviewJob::buildBody	(	std::string	url,
		std::optional< std::int_fast64_t >	ts
	)

static

◆ buildQuery()

BaseJob::Query Kazv::Api::GetUrlPreviewJob::buildQuery	(	std::string	url,
		std::optional< std::int_fast64_t >	ts
	)

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/content-repo.hpp
src/api/csapi/content-repo.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members