ZOOM Windows SDK  5.2.42037.1112
auth_service_interface.h
Go to the documentation of this file.
1 
6 #ifndef _AUTH_SERVICE_INTERFACE_H_
7 #define _AUTH_SERVICE_INTERFACE_H_
8 #include "zoom_sdk_def.h"
9 
10 BEGIN_ZOOM_SDK_NAMESPACE
11 
17 {
28  AUTHRET_CLIENT_INCOMPATIBLE,
29 };
30 
36 {
41 };
42 
47 typedef struct tagAuthParam
48 {
49  const wchar_t* appKey;
50  const wchar_t* appSecret;
51  tagAuthParam()
52  {
53  appKey = NULL;
54  appSecret = NULL;
55  }
56 }AuthParam;
57 
62 typedef struct tagAuthContext
63 {
64  const wchar_t* jwt_token;
87  {
88  jwt_token = NULL;
89  }
90 
92 
98 {
102 };
103 
108 typedef struct tagLoginParam4Email
109 {
110  const wchar_t* userName;
111  const wchar_t* password;
114 
119 typedef struct tagLoginParam4SSO
120 {
121  const wchar_t* ssoToken;
122  bool bRememberMe;
124 
129 typedef struct tagLoginParam
130 {
132  union
133  {
136  }ut;
137 
138  tagLoginParam()
139  {
141  memset(&ut, 0, sizeof(ut));
142 
143  }
144 }LoginParam;
145 
149 {
150 public:
153  virtual const wchar_t* GetDisplayName() = 0;
154 
157  virtual LoginType GetLoginType() = 0;
158  virtual ~IAccountInfo(){};
159 };
160 
164 {
165 public:
168  virtual void onAuthenticationReturn(AuthResult ret) = 0;
169 
173  virtual void onLoginRet(LOGINSTATUS ret, IAccountInfo* pAccountInfo) = 0;
174 
176  virtual void onLogout() = 0;
177 
179  virtual void onZoomIdentityExpired() = 0;
180 
182  virtual void onZoomAuthIdentityExpired() = 0;
183 };
184 
190 {
191 public:
196  virtual SDKError SetEvent(IAuthServiceEvent* pEvent) = 0;
197 
202  virtual SDKError SDKAuth(AuthParam& authParam) = 0;
203 
208  virtual SDKError SDKAuth(AuthContext& authContext) = 0;
209 
212  virtual AuthResult GetAuthResult() = 0;
213 
216  virtual const wchar_t* GetSDKIdentity() = 0;
217 
223  virtual SDKError IsEmailLoginEnabled(bool& bEnabled) = 0;
224 
230  virtual SDKError Login(LoginParam& param) = 0;
231 
235  virtual SDKError LogOut() = 0;
236 
239  virtual IAccountInfo* GetAccountInfo() = 0;
240 
243  virtual LOGINSTATUS GetLoginStatus() = 0;
244 
248 
252 };
253 END_ZOOM_SDK_NAMESPACE
254 #endif
virtual SDKError SDKAuth(AuthParam &authParam)=0
SDK Authentication.
Account login parameter. Here are more detailed structural descriptions.
Definition: auth_service_interface.h:129
virtual LOGINSTATUS GetLoginStatus()=0
Get login status.
virtual IDirectShareServiceHelper * GetDirectShareServiceHeler()=0
Get direct share service helper interface.
Login with SSO token.
Definition: auth_service_interface.h:101
const wchar_t * userName
Username. It is usually working mailbox or other mailbox.
Definition: auth_service_interface.h:110
virtual IAccountInfo * GetAccountInfo()=0
Get login account information.
ZOOM windows SDK Common Definition File.
virtual void onZoomIdentityExpired()=0
Zoom identity has expired, please re-login or generate a new zoom access token via REST Api...
SDK Authentication parameter with sdk key/secret. Here are more detailed structural descriptions...
Definition: auth_service_interface.h:47
virtual SDKError LogOut()=0
Account logout.
LOGINSTATUS
Login status. Here are more detailed structural descriptions.
Definition: auth_service_interface.h:35
Login with work mailbox.
Definition: auth_service_interface.h:100
Outlook plugin integration helper interface.
Definition: outlook_plugin_integration_helper_interface.h:30
bool bRememberMe
True indicates to save the information for next login.
Definition: auth_service_interface.h:112
virtual void onZoomAuthIdentityExpired()=0
Zoom authentication identity will be expired in 10 minutes, please re-auth.
virtual AuthResult GetAuthResult()=0
Get authentication status.
const wchar_t * ssoToken
Account SSO token when logging.
Definition: auth_service_interface.h:121
Authentication service callback event.
Definition: auth_service_interface.h:163
virtual SDKError Login(LoginParam &param)=0
Account login.
The key or secret to authenticate is empty.
Definition: auth_service_interface.h:19
virtual SDKError SetEvent(IAuthServiceEvent *pEvent)=0
Set the authentication service callback event handler.
Service is busy.
Definition: auth_service_interface.h:24
In process of login.
Definition: auth_service_interface.h:38
The key or secret to authenticate is wrong.
Definition: auth_service_interface.h:20
Initial status.
Definition: auth_service_interface.h:25
Unknown type.
Definition: auth_service_interface.h:99
SDKError
SDK error types. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:29
virtual void onLoginRet(LOGINSTATUS ret, IAccountInfo *pAccountInfo)=0
Callback of login result.
virtual SDKError IsEmailLoginEnabled(bool &bEnabled)=0
Call the interface to determine whether email login is enabled.
LoginParam4Email emailLogin
Login with mailbox.
Definition: auth_service_interface.h:134
const wchar_t * password
Account password.
Definition: auth_service_interface.h:111
virtual const wchar_t * GetDisplayName()=0
Get the screen name of user.
AuthResult
SDK Authentication Result. Here are more detailed structural descriptions.
Definition: auth_service_interface.h:16
const wchar_t * appKey
APP Key string.
Definition: auth_service_interface.h:49
SDK parameter for login via email. Here are more detailed structural descriptions.
Definition: auth_service_interface.h:108
Unknown error.
Definition: auth_service_interface.h:23
Authentication Service Interface.
Definition: auth_service_interface.h:189
virtual void onAuthenticationReturn(AuthResult ret)=0
Authentication result callback.
Login failed.
Definition: auth_service_interface.h:40
Direct sharing helper Interface.
Definition: direct_share_helper_interface.h:68
LoginType loginType
Type of login.
Definition: auth_service_interface.h:131
LoginParam4SSO ssoLogin
Login with SSO token.
Definition: auth_service_interface.h:135
const wchar_t * appSecret
APP Secret string.
Definition: auth_service_interface.h:50
virtual const wchar_t * GetSDKIdentity()=0
Get SDK identity.
Account information interface.
Definition: auth_service_interface.h:148
The user account is not enabled for SDK.
Definition: auth_service_interface.h:22
LoginType
User login type. Here are more detailed structural descriptions.
Definition: auth_service_interface.h:97
The user account does not support.
Definition: auth_service_interface.h:21
SDK Authentication parameter with jwt token. Here are more detailed structural descriptions.
Definition: auth_service_interface.h:62
bool bRememberMe
True indicates to save the information for next login.
Definition: auth_service_interface.h:122
virtual LoginType GetLoginType()=0
Get login type.
Network issues.
Definition: auth_service_interface.h:27
virtual void onLogout()=0
Logout result callback.
Unlogged in.
Definition: auth_service_interface.h:37
SDK parameter for login via SSO. Here are more detailed structural descriptions.
Definition: auth_service_interface.h:119
tagAuthContext()
Definition: auth_service_interface.h:86
Authentication is successful.
Definition: auth_service_interface.h:18
virtual IOutlookPluginIntegrationHelper * GetOutlookPluginHeler()=0
Get Outlook plugin integration helper interface.
Time out.
Definition: auth_service_interface.h:26
Login successful.
Definition: auth_service_interface.h:39