Meeting SDK for Android API Reference
Loading...
Searching...
No Matches
ZoomSDK.java
Go to the documentation of this file.
1package us.zoom.sdk;
2
3import android.content.Context;
4
5import java.util.Locale;
6
7import us.zoom.internal.impl.ZoomSDKImpl;
8
12public final class ZoomSDK {
13 private static volatile ZoomSDK instance;
14 private final ZoomSDKImpl mZoomSDKImpl;
15
16 private ZoomSDK() {
17 mZoomSDKImpl = ZoomSDKImpl.getInstance();
18 }
19
25 public static ZoomSDK getInstance() {
26 if (instance == null) {
27 synchronized (ZoomSDK.class) {
28 if (instance == null) {
29 instance = new ZoomSDK();
30 }
31 }
32 }
33 return instance;
34 }
35
41 public boolean hasRawDataLicense() {
42 return mZoomSDKImpl.hasRawDataLicense();
43 }
44
51 return mZoomSDKImpl.getVideoSourceHelper();
52 }
53
60 return mZoomSDKImpl.getShareSourceHelper();
61 }
62
69 mZoomSDKImpl.addAuthenticationListener(listener);
70 }
71
78 mZoomSDKImpl.removeAuthenticationListener(listener);
79 }
80
87 mZoomSDKImpl.addNetworkConnectionListener(listener);
88 }
89
96 mZoomSDKImpl.removeNetworkConnectionListener(listener);
97 }
98
106 public void initialize(Context context, ZoomSDKInitializeListener listener, ZoomSDKInitParams params) {
107 mZoomSDKImpl.initialize(context, listener, params);
108 }
109
113 public void uninitialize() {
114 mZoomSDKImpl.uninitialize();
115 }
116
124 public boolean switchDomain(String newDomain, boolean force) {
125 return mZoomSDKImpl.switchDomain(newDomain, force);
126 }
127
134 public String getVersion(Context context) {
135 return mZoomSDKImpl.getVersion(context);
136 }
137
144 public boolean isDeviceSupported(Context context) {
145 return mZoomSDKImpl.isDeviceSupported(context);
146 }
147
153 public boolean isInitialized() {
154 return mZoomSDKImpl.isInitialized();
155 }
156
163 public String generateSSOLoginURL(String ssoDomainPrefix) {
164 return mZoomSDKImpl.generateSSOLoginURL(ssoDomainPrefix);
165 }
166
173 public boolean handleSSOLoginURIProtocol(String uriProtocol) {
174 return mZoomSDKImpl.handleSSOLoginURIProtocol(uriProtocol);
175 }
176
177
185 public boolean logoutZoom() {
186 return mZoomSDKImpl.logoutZoom();
187 }
188
196 public boolean isLoggedIn() {
197 return mZoomSDKImpl.isLoggedIn();
198 }
199
206 return mZoomSDKImpl.getAccountInfo();
207 }
208
216 public int tryAutoLoginZoom() {
217 return mZoomSDKImpl.tryAutoLoginZoom();
218 }
219
220
227 public boolean setDomain(String domain) {
228 return mZoomSDKImpl.setDomain(domain);
229 }
230
236 public String getDomain() {
237 return mZoomSDKImpl.getDomain();
238 }
239
240
247 public void setSdkLocale(Context context, Locale locale) {
248 mZoomSDKImpl.setSdkLocale(context, locale);
249 }
250
257 public Locale getSdkLocale(Context context) {
258 return mZoomSDKImpl.getSdkLocale(context);
259 }
260
267 mZoomSDKImpl.setShowProxyServerDialogImmediatelyIfNeeded(show);
268 }
269
276 return mZoomSDKImpl.getMeetingService();
277 }
278
285 return mZoomSDKImpl.getSmsService();
286 }
287
288
295 return mZoomSDKImpl.getPreMeetingService();
296 }
297
304 return mZoomSDKImpl.getInMeetingService();
305 }
306
313 return mZoomSDKImpl.getZoomUIService();
314 }
315
322 return mZoomSDKImpl.getMeetingSettingsHelper();
323 }
324
331 return mZoomSDKImpl.get3DAvatarSettings();
332 }
333
340 return mZoomSDKImpl.getReminderHelper();
341 }
342
349 return mZoomSDKImpl.getNotificationServiceHelper();
350 }
351
358 mZoomSDKImpl.enableAutoRegisterNotificationServiceForLogin(enable);
359 }
360
368 return mZoomSDKImpl.registerNotificationService(accessToken);
369 }
370
377 return mZoomSDKImpl.unRegisterNotificationService();
378 }
379}
String generateSSOLoginURL(String ssoDomainPrefix)
Gets the SSO login URL by the domain prefix.
Definition ZoomSDK.java:163
ZoomSDKVideoSourceHelper getVideoSourceHelper()
Gets the video source helper.
Definition ZoomSDK.java:50
final ZoomSDKImpl mZoomSDKImpl
Definition ZoomSDK.java:14
static volatile ZoomSDK instance
Definition ZoomSDK.java:13
MobileRTCSDKError registerNotificationService(String accessToken)
Registers notification service.
Definition ZoomSDK.java:367
boolean isDeviceSupported(Context context)
Determines whether the current device is able to run the SDK.
Definition ZoomSDK.java:144
void removeNetworkConnectionListener(NetworkConnectionListener listener)
Unregisters the listener for network connection events.
Definition ZoomSDK.java:95
void setShowProxyServerDialogImmediatelyIfNeeded(boolean show)
Sets whether to display the setting dialog of proxy server immediately when needed.
Definition ZoomSDK.java:266
I3DAvatarSettingContext get3DAvatarSettings()
Gets the 3D avatar settings interface.
Definition ZoomSDK.java:330
void enableAutoRegisterNotificationServiceForLogin(boolean enable)
Enables or disables auto-register notification service. This is enabled by default.
Definition ZoomSDK.java:357
ZoomSDKAccountInfo getAccountInfo()
Gets the currently logged-in account's information.
Definition ZoomSDK.java:205
boolean isLoggedIn()
Determines whether the Zoom user has logged in.
Definition ZoomSDK.java:196
boolean setDomain(String domain)
Sets a new web domain name. Must call from the main thread.
Definition ZoomSDK.java:227
void addAuthenticationListener(ZoomSDKAuthenticationListener listener)
Registers a listener for the callback events of user authentication.
Definition ZoomSDK.java:68
boolean logoutZoom()
Logs out Zoom SDK.
Definition ZoomSDK.java:185
InMeetingService getInMeetingService()
Gets the in-meeting service instance.
Definition ZoomSDK.java:303
void setSdkLocale(Context context, Locale locale)
Configures Zoom SDK locale.
Definition ZoomSDK.java:247
Locale getSdkLocale(Context context)
Gets the current Zoom SDK locale configuration.
Definition ZoomSDK.java:257
void addNetworkConnectionListener(NetworkConnectionListener listener)
Registers a listener to receive the NetworkConnectionHandler.
Definition ZoomSDK.java:86
ZoomUIService getZoomUIService()
Gets the Zoom UI service instance.
Definition ZoomSDK.java:312
boolean switchDomain(String newDomain, boolean force)
Switches the SDK domain.
Definition ZoomSDK.java:124
PreMeetingService getPreMeetingService()
Gets the pre-meeting service instance.
Definition ZoomSDK.java:294
IReminderHelper getReminderHelper()
Gets the reminder helper interface.
Definition ZoomSDK.java:339
void initialize(Context context, ZoomSDKInitializeListener listener, ZoomSDKInitParams params)
Initializes Zoom SDK.
Definition ZoomSDK.java:106
boolean handleSSOLoginURIProtocol(String uriProtocol)
Logs in with the SSO login URI, link zoommtg://*.
Definition ZoomSDK.java:173
String getVersion(Context context)
Gets the Zoom SDK version on Android.
Definition ZoomSDK.java:134
MobileRTCSDKError unregisterNotificationService()
Unregisters notification service.
Definition ZoomSDK.java:376
static ZoomSDK getInstance()
Gets a shared instance of Zoom SDK. Must call from the main thread.
Definition ZoomSDK.java:25
boolean isInitialized()
Determines whether Zoom SDK has been initialized. Must call from the main thread.
Definition ZoomSDK.java:153
ZoomSDKShareSourceHelper getShareSourceHelper()
Gets the share source helper.
Definition ZoomSDK.java:59
INotificationServiceHelper getNotificationServiceHelper()
Gets the notification service helper interface.
Definition ZoomSDK.java:348
SmsService getSmsService()
Gets SMS service for real name authentication for Chinese users.
Definition ZoomSDK.java:284
String getDomain()
Gets the current domain.
Definition ZoomSDK.java:236
MeetingService getMeetingService()
Gets the instance of meeting service.
Definition ZoomSDK.java:275
int tryAutoLoginZoom()
Logs in Zoom SDK automatically with local Zoom or SSO token once you have logged in successfully.
Definition ZoomSDK.java:216
MeetingSettingsHelper getMeetingSettingsHelper()
Gets the meeting settings helper instance.
Definition ZoomSDK.java:321
void uninitialize()
Uninitializes Zoom SDK.
Definition ZoomSDK.java:113
boolean hasRawDataLicense()
Determines whether the SDK has a raw data license. Must call from the main thread.
Definition ZoomSDK.java:41
void removeAuthenticationListener(ZoomSDKAuthenticationListener listener)
Unregisters the listener for the callback events of user authentication.
Definition ZoomSDK.java:77
Zoom SDK initialization parameters.
Enumeration of common SDK errors.
Helper to handle reminder dialog. The AI Companion brand has been retired. AI-powered features are no...
Interfaces of Zoom services in meeting. The AI Companion brand has been retired. AI-powered features ...
ZOOM meeting service.
Callback event of completing the detection of proxy.
ZOOM pre-meeting service.
SMS service interface.
Account information of the currently logged-in user.
Listener for the result of Zoom SDK user authentication.
Listener for Zoom SDK initialization results.
Interface to set external share source.
Service for users' to operate with Zoom UI.