tenduke::net::URLBuilder Class Reference

#include <URLBuilder.h>

Detailed Description

Very simple URL-builder.

Only part of URL-construction implemented.

Public Member Functions
	URLBuilder (std::shared_ptr< const tenduke::net::URLEncoder > urlEncoder)
	Constructs new instance.
std::string	buildString ()
	Builds to URL into a string.
URLBuilder &	baseURL (const std::string &url)
	Sets the base URL.
URLBuilder &	queryParameter (const std::string &name, const std::string &value="")
	Adds an encoded query parameter.
URLBuilder &	queryParameters (const std::map< std::string, std::string > &pParameters)
	Sets multiple query parameters.
URLBuilder &	queryParameterUnencoded (const std::string &name, const std::string &value="")
	Adds an unencoded query parameter.
std::string	pctEncode (const std::string &value)
	PCT-encodes given string.

Constructor & Destructor Documentation

URLBuilder()

tenduke::net::URLBuilder::URLBuilder ( std::shared_ptr< const tenduke::net::URLEncoder >  urlEncoder )

explicit

Constructs new instance.

Parameters

urlEncoder

-

Member Function Documentation

baseURL()

xdnet::URLBuilder & tenduke::net::URLBuilder::baseURL

(

const std::string &

url

)

Sets the base URL.

Parameters

url

-

Returns

this instance for method-chaining

pctEncode()

std::string tenduke::net::URLBuilder::pctEncode

(

const std::string &

value

)

PCT-encodes given string.

Parameters

value

-

Returns

new string, PCT-encoded.

queryParameter()

xdnet::URLBuilder & tenduke::net::URLBuilder::queryParameter	(	const std::string &	name,
		const std::string &	value = ""
	)

Adds an encoded query parameter.

Both the name and value will be PCT-encoded.

Parameters

name	name of the parameter
value	value of the parameter. Optional. If not present, a parameter without value will be created.

Returns

this instance for method-chaining

queryParameters()

xdnet::URLBuilder & tenduke::net::URLBuilder::queryParameters

(

const std::map< std::string, std::string > &

pParameters

)

Sets multiple query parameters.

Both the names and values of the parameters will be PCT-encoded.

Parameters

pParameters

-

Returns

this instance for method-chaining

queryParameterUnencoded()

xdnet::URLBuilder & tenduke::net::URLBuilder::queryParameterUnencoded	(	const std::string &	name,
		const std::string &	value = ""
	)

Adds an unencoded query parameter.

Neither name nor the value will be PCT-encoded.

Parameters

name	name of the parameter
value	value of the parameter. Optional. If not present, a parameter without value will be created.

Returns

this instance for method-chaining

---

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

• core/core/src/net/URLBuilder.h
• core/core/src/net/URLBuilder.cpp