olp::client::Api Class Reference

The API Services provided by the HERE platform. More...

#include <Api.h>

Public Member Functions
const std::string &	GetApi () const
	Gets an API name.
std::string &	GetMutableApi ()
	Gets a mutable reference to the API name.
void	SetApi (const std::string &value)
	Sets the API name.
const std::string &	GetVersion () const
	Gets a version of the API.
std::string &	GetMutableVersion ()
	Gets a mutable reference to the API version.
void	SetVersion (const std::string &value)
	Sets the API version.
const std::string &	GetBaseUrl () const
	Gets an URL of the API.
std::string &	GetMutableBaseUrl ()
	Gets a mutable reference to the URL of the API.
void	SetBaseUrl (const std::string &value)
	Sets the URL of the API.
const std::map< std::string, std::string > &	GetParameters () const
	Gets a map of parameters.
std::map< std::string, std::string > &	GetMutableParameters ()
	Gets a mutable reference to the API parameters.
void	SetParameters (const std::map< std::string, std::string > &value)
	Sets the API parameters.

Detailed Description

The API Services provided by the HERE platform.

Member Function Documentation

GetApi()

const std::string & olp::client::Api::GetApi ( ) const

inline

Gets an API name.

Returns

The API name.

GetBaseUrl()

const std::string & olp::client::Api::GetBaseUrl ( ) const

inline

Gets an URL of the API.

Returns

The URL of the API.

GetMutableApi()

std::string & olp::client::Api::GetMutableApi ( )

inline

Gets a mutable reference to the API name.

Returns

The mutable reference to the API name.

GetMutableBaseUrl()

std::string & olp::client::Api::GetMutableBaseUrl ( )

inline

Gets a mutable reference to the URL of the API.

Returns

The mutable reference to the URL of the API.

GetMutableParameters()

std::map< std::string, std::string > & olp::client::Api::GetMutableParameters ( )

inline

Gets a mutable reference to the API parameters.

Returns

The mutable reference to the API parameters.

GetMutableVersion()

std::string & olp::client::Api::GetMutableVersion ( )

inline

Gets a mutable reference to the API version.

Returns

The mutable reference to the API version.

GetParameters()

const std::map< std::string, std::string > & olp::client::Api::GetParameters ( ) const

inline

Gets a map of parameters.

Returns

The API parameters.

GetVersion()

const std::string & olp::client::Api::GetVersion ( ) const

inline

Gets a version of the API.

Returns

The version of the API.

SetApi()

void olp::client::Api::SetApi ( const std::string &  value )

inline

Sets the API name.

Parameters

value

The API name.

SetBaseUrl()

void olp::client::Api::SetBaseUrl ( const std::string &  value )

inline

Sets the URL of the API.

Parameters

value

The URL of the API.

SetParameters()

void olp::client::Api::SetParameters ( const std::map< std::string, std::string > &  value )

inline

Sets the API parameters.

Parameters

value

The parameters map.

SetVersion()

void olp::client::Api::SetVersion ( const std::string &  value )

inline

Sets the API version.

Parameters

value

The API version.

---

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

• olp-cpp-sdk-core/include/olp/core/client/model/Api.h