10Duke Scale C++ Client
Loading...
Searching...
No Matches
Public Member Functions | List of all members
tenduke::oauth::OAuthClient Class Referenceabstract

#include <OAuthClient.h>

Detailed Description

OAuth-client to initiate OAuth authorization flow.

This is base interface for different types OAuth clients. The two main branches are browser-based clients (tenduke::oauth::OAuthBrowserFlow) and device-authentication client (tenduke::oauth::device::OAuthDeviceFlow).

Inheritance diagram for tenduke::oauth::OAuthClient:
tenduke::oauth::BaseOAuthClient tenduke::oauth::OAuthBrowserFlow tenduke::oauth::device::OAuthDeviceFlow tenduke::test::mocks::OAuthClientMock tenduke::oauth::device::DefaultOAuthDeviceFlow tenduke::oauth::pkce::OAuthPKCEFlow tenduke::oauth::pkce::OAuthPKCEFlow tenduke::test::mocks::OAuthBrowserFlowMock tenduke::oauth::device::DefaultOAuthDeviceFlow tenduke::test::mocks::OAuthDeviceFlowMock

Public Member Functions

virtual std::unique_ptr< const tenduke::oauth::OAuthRefreshRequest > refresh (std::shared_ptr< tenduke::oauth::OAuthState > state) const =0
 Creates OAuthRefreshRequest for refreshing the state.
 

Member Function Documentation

◆ refresh()

virtual std::unique_ptr< const tenduke::oauth::OAuthRefreshRequest > tenduke::oauth::OAuthClient::refresh ( std::shared_ptr< tenduke::oauth::OAuthState >  state) const
pure virtual

Creates OAuthRefreshRequest for refreshing the state.

After executing the request, assign the returned state back to the original state to get refresh results.

Parameters
statethe state to refresh
Returns
the refresh request
Exceptions
tenduke::oauth::OAuthExceptionif the state is not refreshable.

Implemented in tenduke::oauth::BaseOAuthClient.

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