RestLink::Api Class Reference

Represents an API interface that manages configuration, requests, and parameters. More...

#include <api.h>

Inherits RestLink::ApiBase.

Public Member Functions
	Api (QObject *parent=nullptr)
	Constructs an Api object with an optional parent.
	~Api ()
QString	name () const
	Returns the name of the API.
Q_SLOT void	setName (const QString &name)
	Sets the name of the API.
Q_SIGNAL void	nameChanged (const QString &name)
QVersionNumber	version () const
	Returns the version of the API.
Q_SLOT void	setVersion (const QVersionNumber &version)
	Sets the version of the API.
Q_SIGNAL void	versionChanged ()
QUrl	url () const override
	Returns the URL of the API.
Q_SLOT void	setUrl (const QUrl &url)
	Sets the URL of the API.
Q_SIGNAL void	urlChanged (const QUrl &url)
	Emitted when the API URL changes.
QLocale	locale () const override
	Returns the api locale.
Q_SLOT void	setLocale (const QLocale &locale)
Q_SIGNAL void	localeChanged (const QLocale &locale)
QString	bearerToken () const
Q_SLOT void	setBearerToken (const QString &token)
Q_SIGNAL void	bearerTokenChanged (const QString &token)
QString	userAgent () const override
	Returns the user agent for the API.
Q_SLOT void	setUserAgent (const QString &agent)
	Sets the user agent for the API.
Q_SIGNAL void	userAgentChanged (const QString &agent)
	Emitted when the user agent changes.
Q_SLOT void	configure (const QUrl &url)
	Configures the API with the given URL.
bool	configure (const QJsonObject &config)
	Configures the API with the given JSON configuration.
Q_SIGNAL void	configurationCompleted ()
	Emitted when the API configuration is completed.
Q_SIGNAL void	configurationFailed ()
	Emitted when the API configuration fails.
Response *	send (AbstractRequestHandler::Method method, const Request &request, const Body &body) override
Public Member Functions inherited from RestLink::ApiBase
virtual	~ApiBase ()
	Destructor for ApiBase.
void	head (const Request &request, const ApiRunCallback &callback)
	Makes a HEAD request and calls the provided callback upon completion.
Response *	head (const Request &request)
	Makes a HEAD request and returns the Response object.
void	get (const Request &request, const ApiRunCallback &callback)
	Makes a GET request and calls the provided callback upon completion.
Response *	get (const Request &request)
	Makes a GET request and returns the Response object.
void	post (const Request &request, const Body &body, const ApiRunCallback &callback)
	Makes a POST request with a body and calls the provided callback upon completion.
Response *	post (const Request &request, const Body &body)
	Makes a POST request with a body and returns the Response object.
void	put (const Request &request, const Body &body, const ApiRunCallback &callback)
	Makes a PUT request with a body and calls the provided callback upon completion.
Response *	put (const Request &request, const Body &body)
	Makes a PUT request with a body and returns the Response object.
void	patch (const Request &request, const Body &body, const ApiRunCallback &callback)
	Makes a PATCH request with a body and calls the provided callback upon completion.
Response *	patch (const Request &request, const Body &body)
	Makes a PATCH request with a body and returns the Response object.
void	deleteResource (const Request &request, const ApiRunCallback &callback)
	Makes a DELETE request and calls the provided callback upon completion.
Response *	deleteResource (const Request &request)
	Makes a DELETE request and returns the Response object.
NetworkManager *	networkManager () const
	Returns the network manager used by the ApiBase class.
void	setNetworkManager (NetworkManager *manager)
	Sets the network manager for the ApiBase class.
Public Member Functions inherited from RestLink::RequestInterface
bool	hasPathParameter (const QString &name) const
	Checks if a path parameter exists in the request.
PathParameter	pathParameter (const QString &name) const
	Retrieves a specific path parameter.
QVariant	pathParameterValue (const QString &name) const
	Retrieves the value of a path parameter.
QStringList	pathParameterNames () const
	Retrieves the names of all path parameters.
void	setPathParameter (const QString &name, const QVariant &value)
	Sets the value of a path parameter.
void	setPathParameter (const PathParameter &parameter)
	Sets a path parameter using a PathParameter object.
void	unsetPathParameter (const QString &name)
	Unsets (removes) a path parameter from the request.
QList< PathParameter >	pathParameters () const
	Retrieves all path parameters.
void	setPathParameters (const QList< PathParameter > &parameters)
	Sets all path parameters.
bool	hasQueryParameter (const QString &name) const
	Checks if a query parameter exists in the request.
QueryParameter	queryParameter (const QString &name) const
	Retrieves a specific query parameter.
QList< QVariant >	queryParameterValues (const QString &name) const
	Retrieves the values of a query parameter.
QStringList	queryParameterNames () const
	Retrieves the names of all query parameters.
void	addQueryParameter (const QString &name, const QVariant &value)
	Add the value of a query parameter.
void	addQueryParameter (const QueryParameter &param)
	Add query parameter using a QueryParameter object.
void	removeQueryParameter (const QString &name)
	Removes a query parameter from the request.
void	removeQueryParameter (const QString &name, const QVariant &value)
	Removes a query parameter from the request.
QList< QueryParameter >	queryParameters () const
	Retrieves all query parameters.
void	setQueryParameters (const QList< QueryParameter > &parameters)
	Sets all query parameters.
bool	hasHeader (const QString &name) const
	Checks if a header exists in the request.
Header	header (const QString &name) const
	Retrieves a specific header.
QList< QVariant >	headerValues (const QString &name) const
	Retrieves the values of a header.
QStringList	headerNames () const
	Retrieves the names of all headers.
void	setHeader (const QString &name, const QVariant &value)
	Sets the value of a header.
void	setHeader (const Header &header)
	Sets a header using a Header object.
void	unsetHeader (const QString &name)
	Unsets (removes) a header from the request.
QList< Header >	headers () const
	Retrieves all headers.
void	setHeaders (const QList< Header > &headers)
	Sets all headers.

Properties
QString	name
QString	version
QUrl	url
QLocale	locale
QString	bearerToken
QString	userAgent

Additional Inherited Members
Protected Member Functions inherited from RestLink::ApiBase
	ApiBase (ApiBasePrivate *d, QObject *parent)
Protected Attributes inherited from RestLink::ApiBase
QScopedPointer< ApiBasePrivate >	d_ptr

Detailed Description

Represents an API interface that manages configuration, requests, and parameters.

The Api class is responsible for creating network requests and managing response data. It supports adding parameters to requests, configuring the API from different sources, and emitting signals for configuration changes and network error events.

Constructor & Destructor Documentation

Api()

RestLink::Api::Api ( QObject *  parent = nullptr )

explicit

Constructs an Api object with an optional parent.

This constructor initializes the API object, setting the parent if provided. The API object is ready to be configured and used to make requests. The parent object is passed to the QObject constructor, which manages the object's memory and lifecycle.

Parameters

parent

The parent QObject, or nullptr if no parent is specified.

~Api()

RestLink::Api::~Api

(

)

Member Function Documentation

name()

QString RestLink::Api::name

(

)

const

Returns the name of the API.

This method retrieves the current name of the API as a string. The API name typically represents the identity or label associated with the API.

Returns

A QString containing the name of the API.

setName()

void RestLink::Api::setName

(

const QString &

name

)

Sets the name of the API.

This method sets a new name for the API. The API name is typically used for identification or labeling purposes.

Parameters

name	The new name of the API.

nameChanged()

void RestLink::Api::nameChanged

(

const QString &

name

)

Emitted when the API name changes.

version()

QVersionNumber RestLink::Api::version

(

)

const

Returns the version of the API.

This method retrieves the current version of the API. The version is represented as an QVersionNumber and can be used to manage different versions of the API.

Returns

The integer version number of the API.

setVersion()

void RestLink::Api::setVersion

(

const QVersionNumber &

version

)

Sets the version of the API.

This method sets a new version number for the API. The version number is typically used to track API updates and compatibility.

Parameters

version

The new version number for the API.

versionChanged()

void RestLink::Api::versionChanged

(

)

Emitted when the API version changes.

url()

QUrl RestLink::Api::url ( ) const

overridevirtual

Returns the URL of the API.

This method retrieves the current URL of the API, which is used to define the endpoint for API requests.

Returns

A QUrl representing the API URL.

Implements RestLink::ApiBase.

setUrl()

void RestLink::Api::setUrl

(

const QUrl &

url

)

Sets the URL of the API.

This method sets a new URL for the API, which will be used for making API requests.

Parameters

url	The new URL of the API.

urlChanged()

void RestLink::Api::urlChanged

(

const QUrl &

url

)

Emitted when the API URL changes.

locale()

QLocale RestLink::Api::locale ( ) const

overridevirtual

Returns the api locale.

Returns

QLocale representing the api locale.

Note

This locale is used to set ACCEPT-LANGUAGE header only, if you want to pass it to the API you are using, you must do it manually according to the used API documentation.

Reimplemented from RestLink::ApiBase.

setLocale()

void RestLink::Api::setLocale

(

const QLocale &

locale

)

localeChanged()

Q_SIGNAL void RestLink::Api::localeChanged

(

const QLocale &

locale

)

bearerToken()

QString RestLink::Api::bearerToken

(

)

const

setBearerToken()

void RestLink::Api::setBearerToken

(

const QString &

token

)

bearerTokenChanged()

Q_SIGNAL void RestLink::Api::bearerTokenChanged

(

const QString &

token

)

userAgent()

QString RestLink::Api::userAgent ( ) const

overridevirtual

Returns the user agent for the API.

This method retrieves the current user agent string used for API requests. The user agent identifies the client software making the request.

Returns

A QString representing the user agent for the API.

Reimplemented from RestLink::ApiBase.

setUserAgent()

void RestLink::Api::setUserAgent

(

const QString &

agent

)

Sets the user agent for the API.

This method sets the user agent string used for API requests. The user agent identifies the client software making the request.

Parameters

agent

The user agent string to be used for the API.

userAgentChanged()

void RestLink::Api::userAgentChanged

(

const QString &

agent

)

Emitted when the user agent changes.

configure() [1/2]

void RestLink::Api::configure

(

const QUrl &

url

)

Configures the API with the given URL.

This method configures the API by setting the URL to the given one, which is used for making API requests.

Parameters

url	The URL to be set for the API.

configure() [2/2]

bool RestLink::Api::configure

(

const QJsonObject &

config

)

Configures the API with the given JSON configuration.

This method configures the API using a JSON object. The configuration can include parameters like the API URL, version, and other settings.

Parameters

config

A QJsonObject containing the configuration data for the API.

Returns

Returns true if the configuration was successful, false otherwise.

configurationCompleted()

void RestLink::Api::configurationCompleted

(

)

Emitted when the API configuration is completed.

configurationFailed()

void RestLink::Api::configurationFailed

(

)

Emitted when the API configuration fails.

See also

ApiBase, Request, RequestParameter

send()

Response * RestLink::Api::send ( AbstractRequestHandler::Method  method, const Request &  request, const Body &  body  )

overridevirtual

Reimplemented from RestLink::ApiBase.

Property Documentation

name

QString RestLink::Api::name

readwrite

version

QString RestLink::Api::version

readwrite

url

QUrl RestLink::Api::url

readwrite

locale

QLocale RestLink::Api::locale

readwrite

bearerToken

QString RestLink::Api::bearerToken

readwrite

userAgent

QString RestLink::Api::userAgent

readwrite