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.
virtual IDirectShareServiceHelper *	GetDirectShareServiceHelper ()=0
	Get direct share service helper interface.
virtual void	EnableAutoRegisterNotificationServiceForLogin (bool bEnable)=0
	Enable or disable auto register notification service. This is enabled by default.
virtual SDKError	RegisterNotificationService (const zchar_t *accessToken)=0
	Register notification service.
virtual SDKError	UnregisterNotificationService ()=0
	UnRegister notification service.
virtual INotificationServiceHelper *	GetNotificationServiceHelper ()=0
	Get notification service helper interface.

Detailed Description

Authentication Service Interface.

Definition at line 266 of file auth_service_interface.h.

Member Function Documentation

EnableAutoRegisterNotificationServiceForLogin()

virtual void IAuthService::EnableAutoRegisterNotificationServiceForLogin ( bool bEnable )

pure virtual

Enable or disable auto register notification service. This is enabled by default.

Parameters

bEnable

true means enabled.

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 returns nullptr.

GetAuthResult()

virtual AuthResult IAuthService::GetAuthResult ( )

pure virtual

Get authentication status.

Returns

The return value is authentication status. For more details, see AuthResult enum.

GetDirectShareServiceHelper()

virtual IDirectShareServiceHelper * IAuthService::GetDirectShareServiceHelper ( )

pure virtual

Get direct share service helper interface.

Returns

If you logged in your account successfully, the return value is the object pointer IDirectShareServiceHelper. Otherwise is nullptr.

GetLoginStatus()

virtual LOGINSTATUS IAuthService::GetLoginStatus ( )

pure virtual

Get login status.

Returns

The return value is login status. For more details, see LOGINSTATUS enum.

GetNotificationServiceHelper()

virtual INotificationServiceHelper * IAuthService::GetNotificationServiceHelper ( )

pure virtual

Get notification service helper interface.

Returns

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

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. For detailed error codes, see SDKError enum.

RegisterNotificationService()

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

pure virtual

Register notification service.

Parameters

accessToken

Initialize parameter of notification service.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, 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. For detailed error codes, 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. For detailed error codes, see SDKError enum.

UnregisterNotificationService()

virtual SDKError IAuthService::UnregisterNotificationService ( )

pure virtual

UnRegister notification service.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see SDKError enum.