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.
virtual AuthResult	GetAuthResult ()=0
	Gets authentication status.
virtual const zchar_t *	GetSDKIdentity ()=0
	Gets SDK identity.
virtual const zchar_t *	GenerateSSOLoginWebURL (const zchar_t *prefix_of_vanity_url)=0
	Gets SSO login web URL.
virtual SDKError	SSOLoginWithWebUriProtocol (const zchar_t *uri_protocol)=0
	Performs account login.
virtual SDKError	LogOut ()=0
	Performs account logout.
virtual IAccountInfo *	GetAccountInfo ()=0
	Gets login account information.
virtual LOGINSTATUS	GetLoginStatus ()=0
	Gets login status.

Detailed Description

Authentication Service Interface.

Definition at line 274 of file auth_service_interface.h.

Member Function Documentation

GenerateSSOLoginWebURL()

virtual const zchar_t * IAuthService::GenerateSSOLoginWebURL ( const zchar_t * prefix_of_vanity_url )

pure virtual

Gets SSO login web URL.

Parameters

prefix_of_vanity_url

The prefix of vanity URL.

Returns

If the function succeeds, it returns the SSO login web URL. Otherwise, this function fails and returns nullptr.

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.

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.

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.

SDKAuth()

virtual SDKError IAuthService::SDKAuth ( AuthContext & authContext )

pure virtual

Authenticates SDK.

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.

SSOLoginWithWebUriProtocol()

virtual SDKError IAuthService::SSOLoginWithWebUriProtocol ( const zchar_t * uri_protocol )

pure virtual

Performs account login.

Parameters

uri_protocol

The parameter to be used for SSO account login.

Returns

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

Note

You need to call this API after IAuthServiceEvent::onAuthenticationReturn(AUTHRET_SUCCESS).