onboardapi  9.10.0
by Rheinmetall
M_Auth::IClient Class Reference

Public Member Functions

virtual ~IClient ()
 
virtual void EventLogin (std::string const &KeyUserId, M_Auth::LoginEventType const &LoginEvent)
 
virtual void ReportAuthStatus (std::string const &KeyUserId, M_Auth::AuthStatusType const &Status, bool IsRemoved)
 

Detailed Description

Auth client interface. Contains callback operations from the auth service to the client.

Constructor & Destructor Documentation

◆ ~IClient()

M_Auth::IClient::~IClient ( )
virtual

Member Function Documentation

◆ EventLogin()

void M_Auth::IClient::EventLogin ( std::string const &  KeyUserId,
M_Auth::LoginEventType const &  LoginEvent 
)
virtual

Login events.

Parameters
KeyUserIdThe id of the user.
LoginEventThe login event.

◆ ReportAuthStatus()

void M_Auth::IClient::ReportAuthStatus ( std::string const &  KeyUserId,
M_Auth::AuthStatusType const &  Status,
bool  IsRemoved 
)
virtual

Report the current auth status of a user.

Parameters
KeyUserIdThe id of the user.
StatusAuth status
IsRemovedIndicates if the auth status is no longer available. Note: This will always be set to true when a service has been shut down. After this has been set to true, the status will no longer be available to late joiners.