web::http::oauth1::experimental::oauth1_token Class Reference

OAuth 1.0 token and associated information. More...

#include <oauth1.h>

Public Member Functions
	oauth1_token ()
	Constructs an initially empty invalid access token. More...
	oauth1_token (utility::string_t access_token, utility::string_t secret)
	Constructs a OAuth1 token from a given access token and secret. More...
bool	is_valid_access_token () const
	Get access token validity state. If true, token is a valid access token. More...
const utility::string_t &	access_token () const
	Get access token. More...
void	set_access_token (utility::string_t &&access_token)
	Set access token. More...
void	set_access_token (const utility::string_t &access_token)
	Set access token. More...
const utility::string_t &	secret () const
	Get token secret. More...
void	set_secret (utility::string_t &&secret)
	Set token secret. More...
void	set_secret (const utility::string_t &secret)
	Set token secret. More...
const std::map< utility::string_t, utility::string_t > &	additional_parameters () const
	Retrieves any additional parameters. More...
void	set_additional_parameter (utility::string_t &&paramName, utility::string_t &&paramValue)
	Sets a specific parameter additional parameter. More...
void	set_additional_parameter (const utility::string_t &paramName, const utility::string_t &paramValue)
	Sets a specific parameter additional parameter. More...
void	clear_additional_parameters ()
	Clears all additional parameters. More...

Friends
class	oauth1_config

Detailed Description

OAuth 1.0 token and associated information.

Constructor & Destructor Documentation

web::http::oauth1::experimental::oauth1_token::oauth1_token ( )

inline

Constructs an initially empty invalid access token.

web::http::oauth1::experimental::oauth1_token::oauth1_token ( utility::string_t  access_token, utility::string_t  secret  )

inline

Constructs a OAuth1 token from a given access token and secret.

Parameters

access_token	Access token string.
secret	Token secret string.

Member Function Documentation

const utility::string_t& web::http::oauth1::experimental::oauth1_token::access_token ( ) const

inline

Get access token.

Returns

The access token string.

const std::map<utility::string_t, utility::string_t>& web::http::oauth1::experimental::oauth1_token::additional_parameters ( ) const

inline

Retrieves any additional parameters.

Returns

A map containing the additional parameters.

void web::http::oauth1::experimental::oauth1_token::clear_additional_parameters ( )

inline

Clears all additional parameters.

bool web::http::oauth1::experimental::oauth1_token::is_valid_access_token ( ) const

inline

Get access token validity state. If true, token is a valid access token.

Returns

Access token validity state of the token.

const utility::string_t& web::http::oauth1::experimental::oauth1_token::secret ( ) const

inline

Get token secret.

Returns

Token secret string.

void web::http::oauth1::experimental::oauth1_token::set_access_token ( utility::string_t &&  access_token )

inline

Set access token.

Parameters

access_token

Access token string to set.

void web::http::oauth1::experimental::oauth1_token::set_access_token ( const utility::string_t &  access_token )

inline

Set access token.

Parameters

access_token

Access token string to set.

void web::http::oauth1::experimental::oauth1_token::set_additional_parameter ( utility::string_t &&  paramName, utility::string_t &&  paramValue  )

inline

Sets a specific parameter additional parameter.

Parameters

paramName	Parameter name.
paramValue	Parameter value.

void web::http::oauth1::experimental::oauth1_token::set_additional_parameter ( const utility::string_t &  paramName, const utility::string_t &  paramValue  )

inline

Sets a specific parameter additional parameter.

Parameters

paramName	Parameter name.
paramValue	Parameter value.

void web::http::oauth1::experimental::oauth1_token::set_secret ( utility::string_t &&  secret )

inline

Set token secret.

Parameters

secret

Token secret string to set.

void web::http::oauth1::experimental::oauth1_token::set_secret ( const utility::string_t &  secret )

inline

Set token secret.

Parameters

secret

Token secret string to set.

---

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

• include/cpprest/oauth1.h