10Duke Enterprise C++ SDK
Loading...
Searching...
No Matches
tenduke::oidc::OIDCSessionEventListener Class Referenceabstract

#include <OIDCSessionEventListener.h>

Detailed Description

Event listener for OIDC session events.

NOTE: the event listener code is called synchronously in the same thread the OIDCSession is executing, so keep this in mind if you need to manage UI.

NOTE: We recommend that your event listeners inherit from tenduke::oidc::DefaultOIDCSessionEventListener because it is possible that new methods are added to this interface.

Inheritance diagram for tenduke::oidc::OIDCSessionEventListener:
tenduke::oidc::DefaultOIDCSessionEventListener

Public Member Functions

virtual void loginStarting ()=0
 Called when OIDCSession starts login.
virtual void loginComplete (const ::tenduke::oidc::OIDCState &state)=0
 Called when OIDC login is complete.
virtual void refreshComplete (const ::tenduke::oidc::OIDCState &state)=0
 Called when OIDC session refresh is complete.

Member Function Documentation

◆ loginComplete()

virtual void tenduke::oidc::OIDCSessionEventListener::loginComplete ( const ::tenduke::oidc::OIDCState & state)
pure virtual

Called when OIDC login is complete.

To keep the user logged in across application restarts, store the state here (and in refreshComplete()). The state is a credential, see tenduke::oidc::stateToJson() for how to store it.

Parameters
statethe new state.

Implemented in DefaultOIDCSessionEventListener, and tenduke::oidc::DefaultOIDCSessionEventListener.

◆ loginStarting()

virtual void tenduke::oidc::OIDCSessionEventListener::loginStarting ( )
pure virtual

◆ refreshComplete()

virtual void tenduke::oidc::OIDCSessionEventListener::refreshComplete ( const ::tenduke::oidc::OIDCState & state)
pure virtual

Called when OIDC session refresh is complete.

The refresh may have replaced the refresh token, so store the new state if you store the state, see loginComplete().

Parameters
statethe new state.

Implemented in DefaultOIDCSessionEventListener, and tenduke::oidc::DefaultOIDCSessionEventListener.


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