Listener for the events related to user authentication. More...

#include <IUser.h>

Inheritance diagram for IAuthListener:

Public Types
enum	FailureReason { FAILURE_REASON_UNDEFINED , FAILURE_REASON_GALAXY_SERVICE_NOT_AVAILABLE , FAILURE_REASON_GALAXY_SERVICE_NOT_SIGNED_IN , FAILURE_REASON_CONNECTION_FAILURE , FAILURE_REASON_NO_LICENSE , FAILURE_REASON_INVALID_CREDENTIALS , FAILURE_REASON_GALAXY_NOT_INITIALIZED , FAILURE_REASON_EXTERNAL_SERVICE_FAILURE }
	Reason of authentication failure. More...

Public Member Functions
virtual void	OnAuthSuccess ()=0
	Notification for the event of successful sign in.

virtual void	OnAuthFailure (FailureReason failureReason)=0
	Notification for the event of unsuccessful sign in. More...

virtual void	OnAuthLost ()=0
	Notification for the event of loosing authentication. More...

Additional Inherited Members
Static Public Member Functions inherited from GalaxyTypeAwareListener< AUTH >
static ListenerType	GetListenerType ()
	Returns the type of the listener. More...

Detailed Description

Listener for the events related to user authentication.

Member Enumeration Documentation

Reason of authentication failure.

Enumerator
FAILURE_REASON_UNDEFINED	Undefined error.
FAILURE_REASON_GALAXY_SERVICE_NOT_AVAILABLE	Galaxy Service is not installed properly or fails to start.
FAILURE_REASON_GALAXY_SERVICE_NOT_SIGNED_IN	Galaxy Service is not signed in properly.
FAILURE_REASON_CONNECTION_FAILURE	Unable to communicate with backend services.
FAILURE_REASON_NO_LICENSE	User that is being signed in has no license for this application.
FAILURE_REASON_INVALID_CREDENTIALS	Unable to match client credentials (ID, secret) or user credentials (username, password).
FAILURE_REASON_GALAXY_NOT_INITIALIZED	Galaxy has not been initialized.
FAILURE_REASON_EXTERNAL_SERVICE_FAILURE	Unable to communicate with external service.

virtual void OnAuthFailure ( FailureReason failureReason )

pure virtual

Notification for the event of unsuccessful sign in.

Parameters

[in] failureReason The cause of the failure.

virtual void OnAuthLost ( )

pure virtual

Notification for the event of loosing authentication.