Gets a list of events that the user has been notified about. More...

Inheritance diagram for Kazv::Api::GetNotificationsJob:

Collaboration diagram for Kazv::Api::GetNotificationsJob:

[legend]

Classes
class	JobResponse

struct	Notification
	This API is used to paginate through the list of events that the user has been, or would have been notified about. More...

Public Member Functions
	GetNotificationsJob (std::string serverUrl, std::string _accessToken, std::optional< std::string > from=std::nullopt, std::optional< int > limit=std::nullopt, std::optional< std::string > only=std::nullopt)
	Gets a list of events that the user has been notified about. More...

GetNotificationsJob	withData (JsonWrap j) &&

GetNotificationsJob	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::optional< std::string > from, std::optional< int > limit, std::optional< std::string > only)

static BaseJob::Body	buildBody (std::optional< std::string > from, std::optional< int > limit, std::optional< std::string > only)

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

Gets a list of events that the user has been notified about.

This API is used to paginate through the list of events that the user has been, or would have been notified about.

Constructor & Destructor Documentation

Kazv::Api::GetNotificationsJob::GetNotificationsJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::optional< std::string >	from = `std::nullopt`,
		std::optional< int >	limit = `std::nullopt`,
		std::optional< std::string >	only = `std::nullopt`
	)

explicit

Gets a list of events that the user has been notified about.

Parameters

from	Pagination token to continue from. This should be the `next_token` returned from an earlier call to this endpoint.
limit	Limit on the number of events to return in this request.
only	Allows basic filtering of events returned. Supply `highlight` to return only events where the notification had the highlight tweak set.

BaseJob::Body Kazv::Api::GetNotificationsJob::buildBody	(	std::optional< std::string >	from,
		std::optional< int >	limit,
		std::optional< std::string >	only
	)

static

BaseJob::Query Kazv::Api::GetNotificationsJob::buildQuery	(	std::optional< std::string >	from,
		std::optional< int >	limit,
		std::optional< std::string >	only
	)

static

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

inlinestaticconstexpr

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

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

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