ZOOM Windows SDK  5.2.41727.0928
Public Member Functions | List of all members
IAuthService Class Referenceabstract

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. More...
 
virtual SDKError SDKAuth (AuthParam &authParam)=0
 SDK Authentication. More...
 
virtual SDKError SDKAuth (AuthContext &authContext)=0
 SDK Authentication with jwt token. More...
 
virtual AuthResult GetAuthResult ()=0
 Get authentication status. More...
 
virtual const wchar_t * GetSDKIdentity ()=0
 Get SDK identity. More...
 
virtual SDKError IsEmailLoginEnabled (bool &bEnabled)=0
 Call the interface to determine whether email login is enabled. More...
 
virtual SDKError Login (LoginParam &param)=0
 Account login. More...
 
virtual SDKError LogOut ()=0
 Account logout. More...
 
virtual IAccountInfoGetAccountInfo ()=0
 Get login account information. More...
 
virtual LOGINSTATUS GetLoginStatus ()=0
 Get login status. More...
 
virtual IOutlookPluginIntegrationHelperGetOutlookPluginHeler ()=0
 Get Outlook plugin integration helper interface. More...
 
virtual IDirectShareServiceHelperGetDirectShareServiceHeler ()=0
 Get direct share service helper interface. More...
 

Detailed Description

Authentication Service Interface.

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 NULL.

◆ 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.

◆ GetDirectShareServiceHeler()

virtual IDirectShareServiceHelper* IAuthService::GetDirectShareServiceHeler ( )
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 NULL.

◆ 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.

◆ GetOutlookPluginHeler()

virtual IOutlookPluginIntegrationHelper* IAuthService::GetOutlookPluginHeler ( )
pure virtual

Get Outlook plugin integration helper interface.

Returns
If you logged in your account successfully, the return value is the object pointer to IOutlookPluginIntegrationHelper. Otherwise is NULL.

◆ GetSDKIdentity()

virtual const wchar_t* IAuthService::GetSDKIdentity ( )
pure virtual

Get SDK identity.

Returns
The SDK identity.

◆ IsEmailLoginEnabled()

virtual SDKError IAuthService::IsEmailLoginEnabled ( bool &  bEnabled)
pure virtual

Call the interface to determine whether email login is enabled.

Parameters
[out]

◆ Login()

virtual SDKError IAuthService::Login ( LoginParam param)
pure virtual

Account login.

Parameters
paramFor the parameter to be used for account login, see LoginParam structure.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum. You need to call this APIs after IAuthServiceEvent::onAuthenticationReturn() return SDKErr_Success.

◆ 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() [1/2]

virtual SDKError IAuthService::SDKAuth ( AuthParam authParam)
pure virtual

SDK Authentication.

Parameters
authParamThe parameter to be used for authentication SDK, see AuthParam structure.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SDKAuth() [2/2]

virtual SDKError IAuthService::SDKAuth ( AuthContext authContext)
pure virtual

SDK Authentication with jwt token.

Parameters
authContextThe 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
pEventA 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.

The documentation for this class was generated from the following file: