A helper class to build QUrl and QNetworkRequest objects. More...

#include <requestbuilder.h>

Inheritance diagram for QtRestClient::RequestBuilder:

Classes
class	IExtender
	A simple interface to add custom extensions to the building process. More...

Public Member Functions
	RequestBuilder (const QUrl &baseUrl, QNetworkAccessManager *nam=nullptr)
	Constructs a builder with the given base url. More...

	RequestBuilder (const RequestBuilder &other)
	Copy constructor.

	RequestBuilder (RequestBuilder &&other) noexcept
	Move constructor.

RequestBuilder &	operator= (const RequestBuilder &other)
	Copy assignment operator.

RequestBuilder &	operator= (RequestBuilder &&other) noexcept
	Move assignment operator.

RequestBuilder &	setNetworkAccessManager (QNetworkAccessManager *nam)
	Sets the network access manager to be used for send() More...

RequestBuilder &	setExtender (IExtender *extender)
	Sets the extender to use for extending the build. More...

RequestBuilder &	setCredentials (QString user, QString password={})
	Sets the credentails of the URL. More...

RequestBuilder &	setVersion (QVersionNumber version)
	Sets the version of the API. More...

RequestBuilder &	addPath (const QString &pathSegment)
	appends a path segment to the builders path More...

RequestBuilder &	addPath (const QStringList &pathSegment)
	appends a path segment to the builders path More...

RequestBuilder &	trailingSlash (bool enable=true)
	Enables the trailing slash for the generated URL. More...

RequestBuilder &	addParameter (const QString &name, const QString &value)
	Adds a parameter to the URL. More...

RequestBuilder &	addParameters (const QUrlQuery &parameters)
	Adds parameters to the URL. More...

RequestBuilder &	setFragment (QString fragment)
	Sets the fragment part of the URL. More...

RequestBuilder &	addHeader (const QByteArray &name, const QByteArray &value)
	Adds a HTTP header to be added to the network request. More...

RequestBuilder &	addHeaders (const HeaderHash &headers)
	Adds HTTP headers to be added to the network request. More...

RequestBuilder &	updateFromRelativeUrl (const QUrl &url, bool mergeQuery=false, bool keepFragment=false)
	Updates the builder from the (relative) URL and includes all of it's elements. More...

RequestBuilder &	setAttribute (QNetworkRequest::Attribute attribute, const QVariant &value)
	Sets the given attribute on the generated network request. More...

RequestBuilder &	setAttributes (const QHash< QNetworkRequest::Attribute, QVariant > &attributes)
	Sets the given attributes on the generated network request. More...

RequestBuilder &	setSslConfig (QSslConfiguration sslConfig)
	Sets the ssl configuration to be used by the network request. More...

RequestBuilder &	setBody (QByteArray body, const QByteArray &contentType, bool setAccept=true)
	Sets the content of the generated network request. More...

RequestBuilder &	setBody (QCborValue body, bool setAccept=true)
	Sets the content of the generated network request. More...

RequestBuilder &	setBody (const QJsonValue &body, bool setAccept=true)
	Sets the content of the generated network request. More...

RequestBuilder &	setVerb (QByteArray verb)
	Sets the HTTP-Verb to be used by the generated network request. More...

RequestBuilder &	setAccept (const QByteArray &mimeType)
	Sets the "Accept" HTTP-header to the given mimetype. More...

RequestBuilder &	setAccept (const QMimeType &mimeType)
	Sets the "Accept" HTTP-header to the given mimetype. More...

RequestBuilder &	addPostParameter (const QString &name, const QString &value)
	Adds a post parameter to the body. More...

RequestBuilder &	addPostParameters (const QUrlQuery &parameters)
	Adds post parameters to the body. More...

QUrl	buildUrl () const
	Creates a URL from the builder settings. More...

QNetworkRequest	build () const
	Creates a network request from the builder settings. More...

QNetworkReply *	send () const
	Creates a network request and sends it with the builder settings. More...

QFuture< QNetworkReply * >	sendAsync () const
	Asynchronously creates a network request and sends it with the builder settings. More...

Detailed Description

A helper class to build QUrl and QNetworkRequest objects.

The builder is used by RestClient, RestClass and other components to build the API requests.

See also: RestClient::builder, RestClass::builer

Definition at line 24 of file requestbuilder.h.

Constructor & Destructor Documentation

◆ RequestBuilder()

QtRestClient::RequestBuilder::RequestBuilder	(	const QUrl &	baseUrl,
		QNetworkAccessManager *	nam = `nullptr`
	)

Constructs a builder with the given base url.

Parameters

nam	The network access manager to be used. Can be `nullptr`
baseUrl	The base URL to build ontop of

The base URL is required in order to build. As the name suggests, it's used as base

See also: RestClient::baseUrl, RequestBuilder::send

Member Function Documentation

◆ addHeader()

QtRestClient::RequestBuilder::addHeader	(	const QByteArray &	name,
		const QByteArray &	value
	)

Adds a HTTP header to be added to the network request.

Parameters

name	The header name
value	The header value

Returns: A reference to this builder

See also: RestClient::globalHeaders, QNetworkRequest::setRawHeader

◆ addHeaders()

QtRestClient::RequestBuilder::addHeaders ( const HeaderHash & headers )

Adds HTTP headers to be added to the network request.

Parameters

headers The headers to be set

Returns: A reference to this builder

See also: RestClient::globalHeaders, QNetworkRequest::setRawHeader

◆ addParameter()

QtRestClient::RequestBuilder::addParameter	(	const QString &	name,
		const QString &	value
	)

Adds a parameter to the URL.

Parameters

name	The parameters name
value	The parameters value

Returns: A reference to this builder

See also: RestClient::globalParameters, QUrl::setQuery(const QUrlQuery &)

◆ addParameters()

QtRestClient::RequestBuilder::addParameters ( const QUrlQuery & parameters )

Adds parameters to the URL.

Parameters

parameters The parameters to be set

Returns: A reference to this builder

See also: RestClient::globalParameters, QUrl::setQuery(const QUrlQuery &)

◆ addPath() [1/2]

QtRestClient::RequestBuilder::addPath ( const QString & pathSegment )

appends a path segment to the builders path

Parameters

pathSegment The path to be added to the builders URL

Returns: A reference to this builder

See also: RestClient::createClass, RequestBuilder::trailingSlash, QUrl::setPath

◆ addPath() [2/2]

RequestBuilder& QtRestClient::RequestBuilder::addPath ( const QStringList & pathSegment )

appends a path segment to the builders path

Parameters

pathSegment The path to be added to the builders URL

Returns: A reference to this builder

See also: RestClient::createClass, RequestBuilder::trailingSlash, QUrl::setPath

◆ addPostParameter()

QtRestClient::RequestBuilder::addPostParameter	(	const QString &	name,
		const QString &	value
	)

Adds a post parameter to the body.

Parameters

name	The parameters name
value	The parameters value

Returns: A reference to this builder

See also: RestClient::globalParameters, QUrl::setQuery(const QUrlQuery &)

◆ addPostParameters()

QtRestClient::RequestBuilder::addPostParameters ( const QUrlQuery & parameters )

Adds post parameters to the body.

Parameters

parameters The parameters to be set

Returns: A reference to this builder

See also: RestClient::globalParameters, QUrl::setQuery(const QUrlQuery &)

◆ build()

QtRestClient::RequestBuilder::build ( ) const

Creates a network request from the builder settings.

Returns: The generated network request

See also: RequestBuilder::buildUrl, RequestBuilder::send

◆ buildUrl()

QtRestClient::RequestBuilder::buildUrl ( ) const

Creates a URL from the builder settings.

Returns: The generated URL

See also: RequestBuilder::build, RequestBuilder::send

◆ send()

QtRestClient::RequestBuilder::send ( ) const

Creates a network request and sends it with the builder settings.

Returns: The network reply for the sent request

See also: RequestBuilder::sendAsync, RequestBuilder::buildUrl, RequestBuilder::build

◆ sendAsync()

QtRestClient::RequestBuilder::sendAsync ( ) const

Asynchronously creates a network request and sends it with the builder settings.

Returns: A future for the network reply for the sent request

This method will dispatch an asynchronous call to the internal QNetworkAccessManager. This call will run on the managers thread and perform the actual sending. The reply generated from the request will then be made available via the returned future.

While the sending itself is run on the primary thread, anything before that, i.e. the URL and request generation, are run on the current thread, to minimize the workload on the managers thread.

Warning: Please read the Multithreading section of the README before using this method.

See also: RequestBuilder::send, RequestBuilder::buildUrl, RequestBuilder::build

◆ setAccept() [1/2]

QtRestClient::RequestBuilder::setAccept ( const QByteArray & mimeType )

Sets the "Accept" HTTP-header to the given mimetype.

Parameters

mimeType The mimeType to be set as the "Accept" header

Returns: A reference to this builder

See also: RequestBuilder::addHeader, RequestBuilder::setBody

◆ setAccept() [2/2]

RequestBuilder& QtRestClient::RequestBuilder::setAccept ( const QMimeType & mimeType )

Sets the "Accept" HTTP-header to the given mimetype.

Parameters

mimeType The mimeType to be set as the "Accept" header

Returns: A reference to this builder

See also: RequestBuilder::addHeader, RequestBuilder::setBody

◆ setAttribute()

QtRestClient::RequestBuilder::setAttribute	(	QNetworkRequest::Attribute	attribute,
		const QVariant &	value
	)

Sets the given attribute on the generated network request.

Parameters

attribute	The attribute to be set
value	The attributes value

Returns: A reference to this builder

Note: This property has no effect if using buildUrl()

See also: RestClient::requestAttributes, QNetworkRequest::setAttribute

◆ setAttributes()

QtRestClient::RequestBuilder::setAttributes ( const QHash< QNetworkRequest::Attribute, QVariant > & attributes )

Sets the given attributes on the generated network request.

Parameters

attributes The attributes to be set

Returns: A reference to this builder

Note: This property has no effect if using buildUrl()

See also: RestClient::requestAttributes, QNetworkRequest::setAttribute

◆ setBody() [1/3]

QtRestClient::RequestBuilder::setBody	(	const QJsonValue &	body,
		bool	setAccept = `true`
	)

Sets the content of the generated network request.

Parameters

body	The JSON data to be sent as Content (sets Content-Type to "application/json")
setAccept	If set to true, the "Accept" header will be set to "application/json" as well

Returns: A reference to this builder

Note: This property is used by send() only!

See also: QNetworkAccessManager::sendCustomRequest, RequestBuilder::setAccept

◆ setBody() [2/3]

QtRestClient::RequestBuilder::setBody	(	QByteArray	body,
		const QByteArray &	contentType,
		bool	setAccept = `true`
	)

Sets the content of the generated network request.

Parameters

body	The data to be sent as Content
contentType	The content type for the Content
setAccept	If set to true, the "Accept" header will be set to the contentType

Returns: A reference to this builder

Note: This property is used by send() only!

See also: QNetworkAccessManager::sendCustomRequest, RequestBuilder::setAccept

◆ setBody() [3/3]

QtRestClient::RequestBuilder::setBody	(	QCborValue	body,
		bool	setAccept = `true`
	)

Sets the content of the generated network request.

Parameters

body	The CBOR data to be sent as Content (sets Content-Type to "application/cbor")
setAccept	If set to true, the "Accept" header will be set to "application/cbor" as well

Returns: A reference to this builder

Note: This property is used by send() only!

See also: QNetworkAccessManager::sendCustomRequest, RequestBuilder::setAccept

◆ setCredentials()

QtRestClient::RequestBuilder::setCredentials	(	QString	user,
		QString	password = `{}`
	)

Sets the credentails of the URL.

Parameters

user	The username to be set on the URL
password	The password to be set on the URL

Returns: A reference to this builder

See also: QUrl::setUserInfo

◆ setExtender()

QtRestClient::RequestBuilder::setExtender ( IExtender * extender )

Sets the extender to use for extending the build.

Parameters

extender The extender to be used for extending when building

Returns: A reference to this builder

The extender can be used to change the generated URL/request as last step of the building process.

See also: RequestBuilder::IExtender

◆ setFragment()

QtRestClient::RequestBuilder::setFragment ( QString fragment )

Sets the fragment part of the URL.

Parameters

fragment The URL fragment to be set

Returns: A reference to this builder

See also: QUrl::setFragment

◆ setNetworkAccessManager()

QtRestClient::RequestBuilder::setNetworkAccessManager ( QNetworkAccessManager * nam )

Sets the network access manager to be used for send()

Parameters

nam	The network access manager to use for sending requests

Returns: A reference to this builder

See also: RequestBuilder::RequestBuilder, QNetworkAccessManager

◆ setSslConfig()

QtRestClient::RequestBuilder::setSslConfig ( QSslConfiguration sslConfig )

Sets the ssl configuration to be used by the network request.

Parameters

sslConfig The ssl configuration to be used

Returns: A reference to this builder

If you don't specify a ssl configuration, the builder will use the default configuration

Note: This property has no effect if using buildUrl()

See also: RestClient::sslConfiguration, QNetworkRequest::setSslConfiguration, QSslConfiguration::defaultConfiguration

◆ setVerb()

QtRestClient::RequestBuilder::setVerb ( QByteArray verb )

Sets the HTTP-Verb to be used by the generated network request.

Parameters

verb	The HTTP-Verb to be used

Returns: A reference to this builder

If this property is not set, the HTTP-GET will be used as default

Note: This property is used by send() only!

See also: QNetworkAccessManager::sendCustomRequest

◆ setVersion()

QtRestClient::RequestBuilder::setVersion ( QVersionNumber version )

Sets the version of the API.

Parameters

version The API version

Returns: A reference to this builder

See RestClient::apiVersion for details

See also: RestClient::apiVersion

◆ trailingSlash()

QtRestClient::RequestBuilder::trailingSlash ( bool enable = true )

Enables the trailing slash for the generated URL.

Parameters

enable Enable/disable the trailing slash of the path

Returns: A reference to this builder

Enabled: http://example.com/my/path/?id=42
Disabled: http://example.com/my/path?id=42

See also: RequestBuilder::addPath(const QString &), QUrl::setPath

◆ updateFromRelativeUrl()

QtRestClient::RequestBuilder::updateFromRelativeUrl	(	const QUrl &	url,
		bool	mergeQuery = `false`,
		bool	keepFragment = `false`
	)

Updates the builder from the (relative) URL and includes all of it's elements.

Parameters

url	The (relative) URL to update from
mergeQuery	Specifies, whether the url queries should be merged
keepFragment	Specifies, whether the fragment should be kept or not

Returns: A reference to this builder

This function does the following:

Update the builders url host and path from url
Either merges the query of URL with the exiting one or replaces it
Either takes the fragment of url or keeps the existing one

Note: If either the query or the fragment of url are emtpy, and you do not keep/merge, then the will be replaced by an empty query/fragment

See also: QUrl::resolved

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

requestbuilder.h
requestbuilder.dox

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RequestBuilder()

Member Function Documentation

◆ addHeader()

◆ addHeaders()

◆ addParameter()

◆ addParameters()

◆ addPath() [1/2]

◆ addPath() [2/2]

◆ addPostParameter()

◆ addPostParameters()

◆ build()

◆ buildUrl()

◆ send()

◆ sendAsync()

◆ setAccept() [1/2]

◆ setAccept() [2/2]

◆ setAttribute()

◆ setAttributes()

◆ setBody() [1/3]

◆ setBody() [2/3]

◆ setBody() [3/3]

◆ setCredentials()

◆ setExtender()

◆ setFragment()

◆ setNetworkAccessManager()

◆ setSslConfig()

◆ setVerb()

◆ setVersion()

◆ trailingSlash()

◆ updateFromRelativeUrl()