Meeting SDK for Linux API Reference
Loading...
Searching...
No Matches
auth_service_interface.h
Go to the documentation of this file.
1
5#ifndef _AUTH_SERVICE_INTERFACE_H_
6#define _AUTH_SERVICE_INTERFACE_H_
7#include "zoom_sdk_def.h"
8
10
43
58
95#if defined(WIN32)
99typedef enum
100{
102 SDK_Notification_Service_None = 0,
104 SDK_Notification_Service_Starting,
106 SDK_Notification_Service_Started,
108 SDK_Notification_Service_StartFailed,
110 SDK_Notification_Service_Closed,
111}SDKNotificationServiceStatus;
112
116typedef enum
117{
119 SDK_Notification_Service_Error_Success = 0,
121 SDK_Notification_Service_Error_Unknown,
123 SDK_Notification_Service_Error_Internal_Error,
125 SDK_Notification_Service_Error_Invalid_Token,
132 SDK_Notification_Service_Error_Multi_Connect,
134 SDK_Notification_Service_Error_Network_Issue,
140 SDK_Notification_Service_Error_Max_Duration,
141}SDKNotificationServiceError;
142
143#endif
144
148typedef struct tagAuthContext
149{
176 {
177 jwt_token = nullptr;
178 }
179
181
192
198{
199public:
204 virtual const zchar_t* GetDisplayName() = 0;
209 virtual LoginType GetLoginType() = 0;
210 virtual ~IAccountInfo(){};
211};
212
218{
219public:
221
226 virtual void onAuthenticationReturn(AuthResult ret) = 0;
227
234 virtual void onLoginReturnWithReason(LOGINSTATUS ret, IAccountInfo* pAccountInfo, LoginFailReason reason) = 0;
235
239 virtual void onLogout() = 0;
240
244 virtual void onZoomIdentityExpired() = 0;
245
249 virtual void onZoomAuthIdentityExpired() = 0;
250#if defined(WIN32)
256 virtual void onNotificationServiceStatus(SDKNotificationServiceStatus status, SDKNotificationServiceError error) = 0;
257#endif
258};
259#if defined(WIN32)
260class IDirectShareServiceHelper;
261class IOutlookPluginIntegrationHelper;
262class INotificationServiceHelper;
263#endif
269{
270public:
276 virtual SDKError SetEvent(IAuthServiceEvent* pEvent) = 0;
277
283 virtual SDKError SDKAuth(AuthContext& authContext) = 0;
284
290
295 virtual const zchar_t* GetSDKIdentity() = 0;
296
300
304 virtual const zchar_t* GenerateSSOLoginWebURL(const zchar_t* prefix_of_vanity_url) = 0;
305
312 virtual SDKError SSOLoginWithWebUriProtocol(const zchar_t* uri_protocol) = 0;
313
315
320 virtual SDKError LogOut() = 0;
321
327
333#if defined(WIN32)
338 virtual IDirectShareServiceHelper* GetDirectShareServiceHelper() = 0;
339
344 virtual void EnableAutoRegisterNotificationServiceForLogin(bool bEnable) = 0;
345
351 virtual SDKError RegisterNotificationService(const zchar_t* accessToken) = 0;
352
358
363 virtual INotificationServiceHelper* GetNotificationServiceHelper() = 0;
364#endif
365};
367#endif
LoginType
Enumeration of user login type.
@ LoginType_Unknown
struct tagAuthContext AuthContext
SDK authentication parameter with jwt token.
LOGINSTATUS
Enumeration of SDK login status.
@ LOGIN_PROCESSING
LoginFailReason
Enumeration of SDK login failed reason.
@ LoginFail_SMSCodeError
@ LoginFail_OtherIssue
@ LoginFail_Mfa_Required
@ LoginFail_PhoneNumberFormatInValid
@ LoginFail_SMSCodeExpired
@ LoginFail_Need_Bitrthday_ask
@ LoginFail_SDKNeedUpdate
@ LoginFail_LoginTokenInvalid
@ LoginFail_WrongPassword
@ LoginFail_EmailLoginDisable
@ LoginFail_UserDisagreeLoginDisclaimer
@ LoginFail_UserNotExist
@ LoginFail_TooManyFailedAttempts
@ LoginFail_AccountLocked
AuthResult
Enumeration of SDK authentication result.
@ AUTHRET_UNKNOWN
@ AUTHRET_OVERTIME
@ AUTHRET_SERVICE_BUSY
@ AUTHRET_SUCCESS
@ AUTHRET_LIMIT_EXCEEDED_EXCEPTION
@ AUTHRET_JWTTOKENWRONG
@ AUTHRET_ACCOUNTNOTSUPPORT
@ AUTHRET_KEYORSECRETEMPTY
@ AUTHRET_NETWORKISSUE
@ AUTHRET_ACCOUNTNOTENABLESDK
@ AUTHRET_CLIENT_INCOMPATIBLE
@ AUTHRET_KEYORSECRETWRONG
Account information interface.
virtual const zchar_t * GetDisplayName()=0
Get the screen name of user.
virtual LoginType GetLoginType()=0
Get login type.
Authentication service callback event.
virtual void onZoomIdentityExpired()=0
Notification of Zoom identity has expired, please re-login or generate a new zoom access token via RE...
virtual void onLoginReturnWithReason(LOGINSTATUS ret, IAccountInfo *pAccountInfo, LoginFailReason reason)=0
Notification of login result with fail reason.
virtual void onAuthenticationReturn(AuthResult ret)=0
Notification of authentication result.
virtual void onZoomAuthIdentityExpired()=0
Notification of Zoom authentication identity will be expired in 10 minutes, please re-auth.
virtual void onLogout()=0
Notification of logout.
Authentication Service Interface.
virtual AuthResult GetAuthResult()=0
Get authentication status.
virtual IDirectShareServiceHelper * GetDirectShareServiceHelper()=0
Get direct share service helper interface.
virtual SDKError SetEvent(IAuthServiceEvent *pEvent)=0
Set the authentication service callback event handler.
virtual SDKError RegisterNotificationService(const zchar_t *accessToken)=0
Register notification service.
virtual LOGINSTATUS GetLoginStatus()=0
Get login status.
virtual const zchar_t * GetSDKIdentity()=0
Get SDK identity.
virtual IAccountInfo * GetAccountInfo()=0
Get login account information.
virtual SDKError LogOut()=0
Account logout.
virtual SDKError SDKAuth(AuthContext &authContext)=0
SDK Authentication with jwt token.
virtual INotificationServiceHelper * GetNotificationServiceHelper()=0
Get notification service helper interface.
virtual void EnableAutoRegisterNotificationServiceForLogin(bool bEnable)=0
Enable or disable auto register notification service. This is enabled by default.
virtual SDKError UnregisterNotificationService()=0
UnRegister notification service.
SDK authentication parameter with jwt token.
const zchar_t * jwt_token
JWT token. You may generate your JWT token using the online tool https://jwt.io/.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
SDKError
Enumeration of common errors of SDK.