IAuthService Class Reference

Authentication Service Interface. More...

#include <auth_service_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IAuthServiceEvent *pEvent)=0
	Set the authentication service callback event handler.
virtual SDKError	SDKAuth (AuthContext &authContext)=0
	SDK Authentication with jwt token.
virtual AuthResult	GetAuthResult ()=0
	Get authentication status.
virtual const zchar_t *	GetSDKIdentity ()=0
	Get SDK identity.
virtual SDKError	LogOut ()=0
	Account logout.
virtual IAccountInfo *	GetAccountInfo ()=0
	Get login account information.
virtual LOGINSTATUS	GetLoginStatus ()=0
	Get login status.

Detailed Description

Authentication Service Interface.

Definition at line 185 of file auth_service_interface.h.

Member Function Documentation

GetAccountInfo()

virtual IAccountInfo * IAuthService::GetAccountInfo ( )

pure virtual

Get login account information.

Returns

If you has logged in your account successfully, the return value is a pointer to IAccountInfo, otherwise is nullptr.

GetAuthResult()

virtual AuthResult IAuthService::GetAuthResult ( )

pure virtual

Get authentication status.

Returns

The return value is authentication status. To get extended error information, see AuthResult enum.

GetLoginStatus()

virtual LOGINSTATUS IAuthService::GetLoginStatus ( )

pure virtual

Get login status.

Returns

The return value is login status. To get extended error information, see LOGINSTATUS enum.

GetSDKIdentity()

virtual const zchar_t * IAuthService::GetSDKIdentity ( )

pure virtual

Get SDK identity.

Returns

The SDK identity.

LogOut()

virtual SDKError IAuthService::LogOut ( )

pure virtual

Account logout.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

SDKAuth()

virtual SDKError IAuthService::SDKAuth ( AuthContext & authContext )

pure virtual

SDK Authentication with jwt token.

Parameters

authContext

The parameter to be used for authentication SDK, see AuthContext structure.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

SetEvent()

virtual SDKError IAuthService::SetEvent ( IAuthServiceEvent * pEvent )

pure virtual

Set the authentication service callback event handler.

Parameters

pEvent

A pointer to receive authentication event.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.