TPG.ClientLogin.AuthenticationManager Class Reference

Inheritance diagram for TPG.ClientLogin.AuthenticationManager:

Public Member Functions
string	GetAccessToken ()
async Task< string >	GetAccessTokenAsync ()
string	GetAccessTokenHeaderName ()
async Task< bool >	CheckRefresh ()
	Call from main thread to ensure fresh tokens.
async Task< bool >	Logout ()
async Task< bool >	Authenticate (AuthenticationSettings settings)
	Call to perform initial authentication or to change authentication parameters.
string	GetAccessToken ()
Task< string >	GetAccessTokenAsync ()
string	GetAccessTokenHeaderName ()
Task< bool >	Authenticate (AuthenticationSettings settings)
	Call to perform initial authentication or to change authentication parameters.
string	GetAccessToken ()
	Get current access token.
Task< bool >	CheckRefresh ()
	Call from main thread to ensure fresh tokens.

Properties
static AuthenticationManager	Instance = new AuthenticationManager() [get]
TimeSpan	MinIntervalBetweenAuthenticateRetry = new TimeSpan(0, 0, 0, 120) [get, set]
	Min time interval between internal reauthentications.
TimeSpan	MinRefreshTimeMargin = new TimeSpan(0, 0, 0, 120) [get, set]
	Automatic token refresh may occur when time to access token expiry is less than this value.
Properties inherited from TPG.OidcConnect.Contracts.IAuthenticationManager
TimeSpan	MinIntervalBetweenAuthenticateRetry [get, set]
	Min time interval between internal reauthentications.
TimeSpan	MinRefreshTimeMargin [get, set]
	Automatic token refresh may occur when time to access token expiry is less than this value.

Member Function Documentation

Authenticate()

async Task< bool > TPG.ClientLogin.AuthenticationManager.Authenticate ( AuthenticationSettings  settings )

inline

Call to perform initial authentication or to change authentication parameters.

Parameters

settings

Authentication settings, including authentication server and abstract login dialog

Returns

true on success

Implements TPG.OidcConnect.Contracts.IAuthenticationManager.

CheckRefresh()

async Task< bool > TPG.ClientLogin.AuthenticationManager.CheckRefresh ( )

inline

Call from main thread to ensure fresh tokens.

Returns

false if refresh failed

Implements TPG.OidcConnect.Contracts.IAuthenticationManager.

GetAccessToken()

string TPG.ClientLogin.AuthenticationManager.GetAccessToken ( )

inline

Implements TPG.OidcConnect.Contracts.IAccessTokenProvider.

GetAccessTokenAsync()

async Task< string > TPG.ClientLogin.AuthenticationManager.GetAccessTokenAsync ( )

inline

Implements TPG.OidcConnect.Contracts.IAccessTokenProvider.

GetAccessTokenHeaderName()

string TPG.ClientLogin.AuthenticationManager.GetAccessTokenHeaderName ( )

inline

Implements TPG.OidcConnect.Contracts.IAccessTokenProvider.

Property Documentation

MinIntervalBetweenAuthenticateRetry

TimeSpan TPG.ClientLogin.AuthenticationManager.MinIntervalBetweenAuthenticateRetry = new TimeSpan(0, 0, 0, 120)

getset

Min time interval between internal reauthentications.

Implements TPG.OidcConnect.Contracts.IAuthenticationManager.

MinRefreshTimeMargin

TimeSpan TPG.ClientLogin.AuthenticationManager.MinRefreshTimeMargin = new TimeSpan(0, 0, 0, 120)

getset

Automatic token refresh may occur when time to access token expiry is less than this value.

Implements TPG.OidcConnect.Contracts.IAuthenticationManager.

---

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

• Src/Libraries/TPG.ClientLogin/AuthenticationManager.cs