RestLink::ApiBase Class Reference

The ApiBase class provides methods for making HTTP requests (HEAD, GET, POST, PUT, PATCH, DELETE) and handling responses. More...

#include <apibase.h>

Inherits QObject, and RestLink::RequestInterface.

Inherited by RestLink::Api.

Public Member Functions
virtual	~ApiBase ()
	Destructor for ApiBase.
virtual QUrl	url () const =0
virtual QLocale	locale () const
	Returns the api locale.
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.
virtual Response *	send (AbstractRequestHandler::Method method, const Request &request, const Body &body)
virtual QString	userAgent () const
	Returns the user agent string for the API.
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.

Protected Member Functions
	ApiBase (ApiBasePrivate *d, QObject *parent)

Protected Attributes
QScopedPointer< ApiBasePrivate >	d_ptr

Detailed Description

The ApiBase class provides methods for making HTTP requests (HEAD, GET, POST, PUT, PATCH, DELETE) and handling responses.

This class encapsulates the functionality for interacting with an API by providing methods for various HTTP methods. It manages request interceptors, constructs network requests, and handles the creation of network replies and responses. The class supports asynchronous communication, allowing the user to pass callbacks for handling responses.

Note

This class must not be used directly, use Api class instead.

See also

Request, Response, RequestInterceptor

Constructor & Destructor Documentation

~ApiBase()

RestLink::ApiBase::~ApiBase ( )

virtual

Destructor for ApiBase.

ApiBase()

RestLink::ApiBase::ApiBase ( ApiBasePrivate *  d, QObject *  parent  )

protected

Member Function Documentation

url()

virtual QUrl RestLink::ApiBase::url ( ) const

pure virtual

Implemented in RestLink::Api.

locale()

QLocale RestLink::ApiBase::locale ( ) const

virtual

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 in RestLink::Api.

head() [1/2]

void RestLink::ApiBase::head	(	const Request &	request,
		const ApiRunCallback &	callback
	)

Makes a HEAD request and calls the provided callback upon completion.

Parameters

request	The Request object to be sent.
callback	The callback function to be invoked once the request completes.

head() [2/2]

Response * RestLink::ApiBase::head

(

const Request &

request

)

Makes a HEAD request and returns the Response object.

Parameters

request

The Request object to be sent.

Returns

A Response object containing the result of the HEAD request.

get() [1/2]

void RestLink::ApiBase::get	(	const Request &	request,
		const ApiRunCallback &	callback
	)

Makes a GET request and calls the provided callback upon completion.

Parameters

request	The Request object to be sent.
callback	The callback function to be invoked once the request completes.

get() [2/2]

Response * RestLink::ApiBase::get

(

const Request &

request

)

Makes a GET request and returns the Response object.

Parameters

request

The Request object to be sent.

Returns

A Response object containing the result of the GET request.

post() [1/2]

void RestLink::ApiBase::post	(	const Request &	request,
		const Body &	body,
		const ApiRunCallback &	callback
	)

Makes a POST request with a body and calls the provided callback upon completion.

Parameters

request	The Request object to be sent.
body	The Body object containing the data to be sent in the request.
callback	The callback function to be invoked once the request completes.

post() [2/2]

Response * RestLink::ApiBase::post	(	const Request &	request,
		const Body &	body
	)

Makes a POST request with a body and returns the Response object.

Parameters

request	The Request object to be sent.
body	The Body object containing the data to be sent in the request.

Returns

A Response object containing the result of the POST request.

put() [1/2]

void RestLink::ApiBase::put	(	const Request &	request,
		const Body &	body,
		const ApiRunCallback &	callback
	)

Makes a PUT request with a body and calls the provided callback upon completion.

Parameters

request	The Request object to be sent.
body	The Body object containing the data to be sent in the request.
callback	The callback function to be invoked once the request completes.

put() [2/2]

Response * RestLink::ApiBase::put	(	const Request &	request,
		const Body &	body
	)

Makes a PUT request with a body and returns the Response object.

Parameters

request	The Request object to be sent.
body	The Body object containing the data to be sent in the request.

Returns

A Response object containing the result of the PUT request.

patch() [1/2]

void RestLink::ApiBase::patch	(	const Request &	request,
		const Body &	body,
		const ApiRunCallback &	callback
	)

Makes a PATCH request with a body and calls the provided callback upon completion.

Parameters

request	The Request object to be sent.
body	The Body object containing the data to be sent in the request.
callback	The callback function to be invoked once the request completes.

patch() [2/2]

Response * RestLink::ApiBase::patch	(	const Request &	request,
		const Body &	body
	)

Makes a PATCH request with a body and returns the Response object.

Parameters

request	The Request object to be sent.
body	The Body object containing the data to be sent in the request.

Returns

A Response object containing the result of the PATCH request.

deleteResource() [1/2]

void RestLink::ApiBase::deleteResource	(	const Request &	request,
		const ApiRunCallback &	callback
	)

Makes a DELETE request and calls the provided callback upon completion.

Parameters

request	The Request object to be sent.
callback	The callback function to be invoked once the request completes.

deleteResource() [2/2]

Response * RestLink::ApiBase::deleteResource

(

const Request &

request

)

Makes a DELETE request and returns the Response object.

Parameters

request

The Request object to be sent.

Returns

A Response object containing the result of the DELETE request.

send()

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

virtual

Reimplemented in RestLink::Api.

userAgent()

QString RestLink::ApiBase::userAgent ( ) const

virtual

Returns the user agent string for the API.

Returns

A string representing the user agent.

Reimplemented in RestLink::Api.

networkManager()

NetworkManager * RestLink::ApiBase::networkManager

(

)

const

Returns the network manager used by the ApiBase class.

This function retrieves the current instance of the QNetworkAccessManager that is used for making network requests.

Returns

A pointer to the QNetworkAccessManager instance.

setNetworkManager()

void RestLink::ApiBase::setNetworkManager

(

NetworkManager *

manager

)

Sets the network manager for the ApiBase class.

This function allows setting a custom QNetworkAccessManager instance to be used for network requests.

Parameters

manager

A pointer to the QNetworkAccessManager instance to be set.

Member Data Documentation

d_ptr

QScopedPointer<ApiBasePrivate> RestLink::ApiBase::d_ptr

protected