Configures the TokenEndpoint instance. More...

#include <Settings.h>

Collaboration diagram for olp::authentication::Settings:

Public Member Functions
	Settings (AuthenticationCredentials credentials)
	Creates the `Settings` instance. More...

Public Attributes
AuthenticationCredentials	credentials
	The access key ID and access key secret that you got from the HERE Account as a part of the onboarding or support process on the developer portal.

std::shared_ptr< http::Network >	network_request_handler
	The network instance that is used to internally operate with the HERE platform Services.

std::shared_ptr< thread::TaskScheduler >	task_scheduler
	(Optional) The `TaskScheduler` class that is used to manage the callbacks enqueue.

boost::optional< http::NetworkProxySettings >	network_proxy_settings
	(Optional) The configuration settings for the network layer.

std::string	token_endpoint_url
	(Optional) The server URL of the token endpoint. More...

bool	use_system_time {true}
	Uses system system time in authentication requests rather than requesting time from authentication server. More...

client::RetrySettings	retry_settings
	A collection of settings that controls how failed requests should be treated.

boost::optional< std::string >	scope
	(Optional) The scope to be assigned to an access token requests.

Detailed Description

Configures the TokenEndpoint instance.

Contains settings that customize the TokenEndpoint class.

Constructor & Destructor Documentation

olp::authentication::Settings::Settings ( AuthenticationCredentials credentials )

explicit

Creates the Settings instance.

Parameters

credentials Your access credentials to the HERE platform.

std::string olp::authentication::Settings::token_endpoint_url

(Optional) The server URL of the token endpoint.

Note: Only standard OAuth2 Token URLs (those ending in oauth2/token) are supported.

bool olp::authentication::Settings::use_system_time {true}

Uses system system time in authentication requests rather than requesting time from authentication server.

Default is true, which means system time is used.

Note: Please make sure that the system time does not deviate from the official UTC time as it might result in error responses from the authentication server.

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