IAuthService Class Reference

Authentication Service Interface. More...

#include <auth_service_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IAuthServiceEvent *pEvent)=0
	Sets the authentication service callback event handler.
virtual SDKError	SDKAuth (AuthContext &authContext)=0
	Authenticates SDK with JWT token.
virtual AuthResult	GetAuthResult ()=0
	Gets authentication status.
virtual const zchar_t *	GetSDKIdentity ()=0
	Gets SDK identity.
virtual SDKError	LogOut ()=0
	Performs account logout.
virtual IAccountInfo *	GetAccountInfo ()=0
	Gets login account information.
virtual LOGINSTATUS	GetLoginStatus ()=0
	Gets login status.
virtual IDirectShareServiceHelper *	GetDirectShareServiceHelper ()=0
	Gets direct share service helper interface.
virtual void	EnableAutoRegisterNotificationServiceForLogin (bool bEnable)=0
	Enables or disables auto register notification service. This is enabled by default.
virtual SDKError	RegisterNotificationService (const zchar_t *accessToken)=0
	Registers notification service.
virtual SDKError	UnregisterNotificationService ()=0
	Unregisters notification service.
virtual INotificationServiceHelper *	GetNotificationServiceHelper ()=0
	Gets notification service helper interface.

Detailed Description

Authentication Service Interface.

Definition at line 268 of file auth_service_interface.h.

Member Function Documentation

EnableAutoRegisterNotificationServiceForLogin()

virtual void IAuthService::EnableAutoRegisterNotificationServiceForLogin ( bool bEnable )

pure virtual

Enables or disables auto register notification service. This is enabled by default.

Parameters

bEnable

true to enable, false to disable.

GetAccountInfo()

virtual IAccountInfo * IAuthService::GetAccountInfo ( )

pure virtual

Gets login account information.

Returns

If you have logged in your account successfully, the return value is a pointer to IAccountInfo. Otherwise, this function returns nullptr.

GetAuthResult()

virtual AuthResult IAuthService::GetAuthResult ( )

pure virtual

Gets authentication status.

Returns

If the function succeeds, it returns the authentication status.

GetDirectShareServiceHelper()

virtual IDirectShareServiceHelper * IAuthService::GetDirectShareServiceHelper ( )

pure virtual

Gets direct share service helper interface.

Returns

If you have logged in your account successfully, the return value is a pointer to IDirectShareServiceHelper. Otherwise, this function returns nullptr.

GetLoginStatus()

virtual LOGINSTATUS IAuthService::GetLoginStatus ( )

pure virtual

Gets login status.

Returns

If the function succeeds, it returns the login status. Otherwise, this function returns an error.

GetNotificationServiceHelper()

virtual INotificationServiceHelper * IAuthService::GetNotificationServiceHelper ( )

pure virtual

Gets notification service helper interface.

Returns

If the function succeeds, the return value is a pointer to INotificationServiceHelper. Otherwise, this function fails and returns nullptr.

GetSDKIdentity()

virtual const zchar_t * IAuthService::GetSDKIdentity ( )

pure virtual

Gets SDK identity.

Returns

If the function succeeds, it returns the SDK identity. Otherwise, this function fails and returns nullptr.

LogOut()

virtual SDKError IAuthService::LogOut ( )

pure virtual

Performs account logout.

/

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

RegisterNotificationService()

virtual SDKError IAuthService::RegisterNotificationService ( const zchar_t * accessToken )

pure virtual

Registers notification service.

Parameters

accessToken

The initialization parameter of notification service.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

SDKAuth()

virtual SDKError IAuthService::SDKAuth ( AuthContext & authContext )

pure virtual

Authenticates SDK with JWT token.

Parameters

authContext

The parameter to be used for authentication SDK.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

SetEvent()

virtual SDKError IAuthService::SetEvent ( IAuthServiceEvent * pEvent )

pure virtual

Sets 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, this function returns an error.

UnregisterNotificationService()

virtual SDKError IAuthService::UnregisterNotificationService ( )

pure virtual

Unregisters notification service.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.