us.zoom.sdk

Class ZoomSDK

java.lang.Object

us.zoom.sdk.ZoomSDK

public final class ZoomSDK
extends java.lang.Object

ZOOM SDK global manager.

Method Summary

Modifier and Type	Method and Description
void	addAuthenticationListener(ZoomSDKAuthenticationListener listener) Register a listener for the callback events of user authentication.
void	addNetworkConnectionListener(NetworkConnectionListener listener) Register a listener to receive the NetworkConnectionHandler.
AccountService	getAccountService() Get account service instance.
java.lang.String	getDomain() Get current domain.
InMeetingService	getInMeetingService() Get InMeetingService instance.
static ZoomSDK	getInstance() Get a shared instance of ZOOM SDK.
MeetingService	getMeetingService() Get the instance of meeting service.
MeetingSettingsHelper	getMeetingSettingsHelper() Get MeetingSettingsHelper instance.
java.lang.String	getPreferenceKeyIsAppVerified()
java.lang.String	getPreferenceKeyLastVerifiedAppKey()
java.lang.String	getPreferenceKeyLastVerifiedAppSecret()
java.lang.String	getPreferenceKeyLastVerifiedJwtToken()
PreMeetingService	getPreMeetingService() Get preMeetingService instance.
java.util.Locale	getSdkLocale(android.content.Context context) Get current ZOOM SDK locale configuration.
SmsService	getSmsService() Get Sms Service for real name auth for chinese user.
java.lang.String	getVersion(android.content.Context context) Get ZOOM SDK version on Android.
ZoomSDKVideoSourceHelper	getVideoSourceHelper() Get video source helper
ZoomUIService	getZoomUIService() Get ZoomUIService instance.
boolean	hasRawDataLicense() Query is has raw data license.
void	initialize(android.content.Context context, java.lang.String appKey, java.lang.String appSecret, boolean autoRetryVerifyApp, ZoomSDKInitializeListener listener) Deprecated.
void	initialize(android.content.Context context, java.lang.String appKey, java.lang.String appSecret, java.lang.String domain, boolean autoRetryVerifyApp, ZoomSDKInitializeListener listener) Deprecated.
void	initialize(android.content.Context context, java.lang.String appKey, java.lang.String appSecret, java.lang.String domain, boolean autoRetryVerifyApp, ZoomSDKInitializeListener listener, boolean enableLog) Deprecated.
void	initialize(android.content.Context context, java.lang.String appKey, java.lang.String appSecret, java.lang.String domain, boolean autoRetryVerifyApp, ZoomSDKInitializeListener listener, boolean enableLog, int logSize) Deprecated.
void	initialize(android.content.Context context, java.lang.String appKey, java.lang.String appSecret, java.lang.String domain, ZoomSDKInitializeListener listener) Deprecated.
void	initialize(android.content.Context context, java.lang.String appKey, java.lang.String appSecret, java.lang.String domain, ZoomSDKInitializeListener listener, boolean enableLog) Deprecated.
void	initialize(android.content.Context context, java.lang.String appKey, java.lang.String appSecret, java.lang.String domain, ZoomSDKInitializeListener listener, boolean enableLog, int logSize) Deprecated.
void	initialize(android.content.Context context, java.lang.String appKey, java.lang.String appSecret, ZoomSDKInitializeListener listener) Deprecated.
void	initialize(android.content.Context context, ZoomSDKInitializeListener listener, ZoomSDKInitParams params)
boolean	isDeviceSupported(android.content.Context context) Query if the current device is able to run SDK.
boolean	isEmailLoginEnable() Query is email login enable
boolean	isInitialized() Query if ZOOM SDK has been initialized.
boolean	isLoggedIn() Query if ZOOM user has logged in.
int	loginWithSSOToken(java.lang.String ssoToken) Login ZOOM SDK with SSO token.
int	loginWithZoom(java.lang.String email, java.lang.String password) Login ZOOM SDK with working email.
boolean	logoutZoom() Logout ZOOM SDK.
void	removeAuthenticationListener(ZoomSDKAuthenticationListener listener) Unregister the listener for the callback events of user authentication.
void	removeNetworkConnectionListener(NetworkConnectionListener listener) Unregister a listener for the callback event of user authentication.
void	setDomain(java.lang.String domain) Set a new web domain name.
void	setSdkLocale(android.content.Context context, java.util.Locale locale) Configure ZOOM SDK locale.
void	setShowProxyServerDialogImmediatelyIfNeeded(boolean show) Set if display immediately the setting dialog of proxy server.
boolean	switchDomain(java.lang.String newDomain, boolean force) Call the method to switch sdk domain.
int	tryAutoLoginZoom() Login ZOOM SDK automatically with local ZOOM/SSO token once you have logged in successfully.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static ZoomSDK getInstance()

Get a shared instance of ZOOM SDK.

Returns:

The ZOOM SDK instance.

hasRawDataLicense

public boolean hasRawDataLicense()

Query is has raw data license.

Returns:

raw data license

getVideoSourceHelper

public ZoomSDKVideoSourceHelper getVideoSourceHelper()

Get video source helper

Returns:

video source helper

addAuthenticationListener

public void addAuthenticationListener(ZoomSDKAuthenticationListener listener)

Register a listener for the callback events of user authentication.

Parameters:

listener - The listener instance.

removeAuthenticationListener

public void removeAuthenticationListener(ZoomSDKAuthenticationListener listener)

Unregister the listener for the callback events of user authentication.

Parameters:

listener - The listener instance.

addNetworkConnectionListener

public void addNetworkConnectionListener(NetworkConnectionListener listener)

Register a listener to receive the NetworkConnectionHandler.

Parameters:

listener - The listener instance

removeNetworkConnectionListener

public void removeNetworkConnectionListener(NetworkConnectionListener listener)

Unregister a listener for the callback event of user authentication.

Parameters:

listener - The listener instance.

initialize

@Deprecated
public void initialize(android.content.Context context,
                                    java.lang.String appKey,
                                    java.lang.String appSecret,
                                    ZoomSDKInitializeListener listener)

Deprecated.

Initialize ZOOM SDK.

Deprecated, use initialize(Context, ZoomSDKInitializeListener, ZoomSDKInitParams) instead.

Parameters:

context - Android context.

appKey - APP Key got from zoom.us.

appSecret - APP secret got from zoom.us.

listener - Listener for the initialization result.

initialize

@Deprecated
public void initialize(android.content.Context context,
                                    java.lang.String appKey,
                                    java.lang.String appSecret,
                                    boolean autoRetryVerifyApp,
                                    ZoomSDKInitializeListener listener)

Deprecated.

Initialize ZOOM SDK. Deprecated, use initialize(Context, ZoomSDKInitializeListener, ZoomSDKInitParams) instead.

Parameters:

context - Android context

appKey - APP Key got from zoom.us.

appSecret - APP secret got from zoom.us.

autoRetryVerifyApp - If it is TRUE, ZOOM SDK will retry to call verifyApp automatically.

listener - Listener for the result of initialization.

initialize

@Deprecated
public void initialize(android.content.Context context,
                                    java.lang.String appKey,
                                    java.lang.String appSecret,
                                    java.lang.String domain,
                                    ZoomSDKInitializeListener listener)

Deprecated.

Initialize ZOOM SDK Deprecated, use initialize(Context, ZoomSDKInitializeListener, ZoomSDKInitParams) instead.

Parameters:

context - Android context.

appKey - APP Key got from zoom.us.

appSecret - APP secret got from zoom.us.

domain - ZOOM domain name. Default value: zoom.us

listener - Listener for the result of initialization.

initialize

@Deprecated
public void initialize(android.content.Context context,
                                    java.lang.String appKey,
                                    java.lang.String appSecret,
                                    java.lang.String domain,
                                    ZoomSDKInitializeListener listener,
                                    boolean enableLog)

Deprecated.

Initialize Zoom SDK. Deprecated, use initialize(Context, ZoomSDKInitializeListener, ZoomSDKInitParams) instead.

Parameters:

context - Android context

appKey - APP Key got from zoom.us.

appSecret - APP secret got from zoom.us.

domain - ZOOM domain name. Default value: zoom.us

listener - Listener for the result of initialization.

enableLog - Enable/Disable the default debug log.

initialize

@Deprecated
public void initialize(android.content.Context context,
                                    java.lang.String appKey,
                                    java.lang.String appSecret,
                                    java.lang.String domain,
                                    ZoomSDKInitializeListener listener,
                                    boolean enableLog,
                                    int logSize)

Deprecated.

Initialize Zoom SDK. Deprecated, use initialize(Context, ZoomSDKInitializeListener, ZoomSDKInitParams) instead.

Parameters:

context - Android context

appKey - APP Key got from zoom.us.

appSecret - APP secret got from zoom.us.

domain - ZOOM domain name. Default value: zoom.us

listener - Listener for the result of initialization.

enableLog - Enable/Disable the default debug log.

logSize - Log File Size.

initialize

@Deprecated
public void initialize(android.content.Context context,
                                    java.lang.String appKey,
                                    java.lang.String appSecret,
                                    java.lang.String domain,
                                    boolean autoRetryVerifyApp,
                                    ZoomSDKInitializeListener listener)

Deprecated.

Initialize ZOOM SDK. Deprecated, use initialize(Context, ZoomSDKInitializeListener, ZoomSDKInitParams) instead.

Parameters:

context - Android context

appKey - APP Key got from zoom.us.

appSecret - APP secret got from zoom.us.

domain - ZOOM domain name. Default value: zoom.us

autoRetryVerifyApp - If it is TRUE, Zoom SDK will retry to call verifyApp automatically. Otherwise user needs to call verifyApp manually once initialize failed.

listener - Listener for the result of initialization.

initialize

@Deprecated
public void initialize(android.content.Context context,
                                    java.lang.String appKey,
                                    java.lang.String appSecret,
                                    java.lang.String domain,
                                    boolean autoRetryVerifyApp,
                                    ZoomSDKInitializeListener listener,
                                    boolean enableLog)

Deprecated.

Initialize ZOOM SDK. Deprecated, use initialize(Context, ZoomSDKInitializeListener, ZoomSDKInitParams) instead.

Parameters:

context - Android context

appKey - APP Key got from zoom.us.

appSecret - APP secret got from zoom.us.

domain - ZOOM domain name. Default value: zoom.us

autoRetryVerifyApp - If it is TRUE, Zoom SDK will retry to call verifyApp automatically. Otherwise user needs to call verifyApp manually once initialize failed.

listener - Listener for initialization result.

enableLog - Enable/Disable the default debug log.

initialize

@Deprecated
public void initialize(android.content.Context context,
                                    java.lang.String appKey,
                                    java.lang.String appSecret,
                                    java.lang.String domain,
                                    boolean autoRetryVerifyApp,
                                    ZoomSDKInitializeListener listener,
                                    boolean enableLog,
                                    int logSize)

Deprecated.

Initialize ZOOM SDK. Deprecated, use initialize(Context, ZoomSDKInitializeListener, ZoomSDKInitParams) instead.

Parameters:

context - Android context

appKey - APP Key got from zoom.us.

appSecret - APP secret got from zoom.us.

domain - ZOOM domain name. Default value: zoom.us

autoRetryVerifyApp - If it is TRUE, Zoom SDK will retry to call verifyApp automatically. Otherwise user needs to call verifyApp manually once initialize failed.

listener - Listener for initialization result.

enableLog - Enable/Disable the default debug log.

logSize - Log File Size. 1-50M

initialize

public void initialize(android.content.Context context,
                       ZoomSDKInitializeListener listener,
                       ZoomSDKInitParams params)

Parameters:

context - Android context

listener - Listener for initialization result.

params - initparams ZoomSDKInitParams. you can use jwtToken or (appKey and appSecret) to initialize

switchDomain

public boolean switchDomain(java.lang.String newDomain,
                            boolean force)

Call the method to switch sdk domain.

Parameters:

newDomain - The new domain.

force - true:force switch

Returns:

true indicates successfully. Otherwise not.

getVersion

public java.lang.String getVersion(android.content.Context context)

Get ZOOM SDK version on Android.

Parameters:

context - See Context

Returns:

ZOOM SDK version

isDeviceSupported

public boolean isDeviceSupported(android.content.Context context)

Query if the current device is able to run SDK.

Parameters:

context - See Context

Returns:

TRUE means able, otherwise not.

isInitialized

public boolean isInitialized()

Query if ZOOM SDK has been initialized.

Returns:

TRUE means initialized. Otherwise not.

loginWithZoom

public int loginWithZoom(java.lang.String email,
                         java.lang.String password)

Login ZOOM SDK with working email. *Note* This function is optional, ignore it if you do not have the account of working email in ZOOM.

Parameters:

email - The email to login.

password - Login password.

Returns:

result Error code defined in ZoomApiError.

loginWithSSOToken

public int loginWithSSOToken(java.lang.String ssoToken)

Login ZOOM SDK with SSO token.

Parameters:

ssoToken - SSO token.

Returns:

Error code defined in ZoomApiError.

logoutZoom

public boolean logoutZoom()

Logout ZOOM SDK. *Note* This function is optional, ignore it if you do not have the account of working email/SSO in ZOOM.

Returns:

TRUE means that the user can logout. Otherwise not.

isLoggedIn

public boolean isLoggedIn()

Query if ZOOM user has logged in. *Note* This function is optional, ignore it if you do not have the account of working email in ZOOM.

Returns:

TRUE means that the user has logged in. Otherwise not.

tryAutoLoginZoom

public int tryAutoLoginZoom()

Login ZOOM SDK automatically with local ZOOM/SSO token once you have logged in successfully. *Note* This function is optional, ignore it if you do not have the account of working email/SSO account in ZOOM.

Returns:

Login ZOOM successfully or not. See ZoomApiError.

setDomain

public void setDomain(java.lang.String domain)

Set a new web domain name.

Parameters:

domain - Domain name to be set. Default value: zoom.us.

getDomain

public java.lang.String getDomain()

Get current domain.

Returns:

current The current domain.

setSdkLocale

public void setSdkLocale(android.content.Context context,
                         java.util.Locale locale)

Configure ZOOM SDK locale.

Parameters:

context - Android context.

locale - The language item of the locale object can not be null.

getSdkLocale

public java.util.Locale getSdkLocale(android.content.Context context)

Get current ZOOM SDK locale configuration.

Parameters:

context - Android context.

Returns:

Current ZOOM SDK locale configuration.

setShowProxyServerDialogImmediatelyIfNeeded

public void setShowProxyServerDialogImmediatelyIfNeeded(boolean show)

Set if display immediately the setting dialog of proxy server.

Parameters:

show - TRUE means to show proxy server dialog when needed. FALSE not.

isEmailLoginEnable

public boolean isEmailLoginEnable()

Query is email login enable

Returns:

true: enable

getMeetingService

public MeetingService getMeetingService()

Get the instance of meeting service.

Returns:

The shared instance of MeetingService. Return null if the SDK has not been initialized successfully.

getSmsService

public SmsService getSmsService()

Get Sms Service for real name auth for chinese user.

Returns:

SmsService SmsService

getAccountService

public AccountService getAccountService()

Get account service instance.

Returns:

The shared instance of account service. It will return null if the SDK has not been initialized successfully or the user didn't login.

getPreMeetingService

public PreMeetingService getPreMeetingService()

Get preMeetingService instance.

Returns:

The shared instance of PreMeetingService. It will return null if the SDK has not been initialized successfully or the user didn't login.

getInMeetingService

public InMeetingService getInMeetingService()

Get InMeetingService instance.

Returns:

The shared instance of InMeetingService. It will return null if the SDK has not been initialized successfully.

getZoomUIService

public ZoomUIService getZoomUIService()

Get ZoomUIService instance.

Returns:

The shared instance of ZoomUIService. It will return null if the SDK has not been initialized successfully.

getMeetingSettingsHelper

public MeetingSettingsHelper getMeetingSettingsHelper()

Get MeetingSettingsHelper instance.

Returns:

The shared instance of MeetingSettingsHelper. It will return null if the SDK has not been initialized successfully.

getPreferenceKeyLastVerifiedAppSecret

public java.lang.String getPreferenceKeyLastVerifiedAppSecret()

getPreferenceKeyLastVerifiedAppKey

public java.lang.String getPreferenceKeyLastVerifiedAppKey()

getPreferenceKeyLastVerifiedJwtToken

public java.lang.String getPreferenceKeyLastVerifiedJwtToken()

getPreferenceKeyIsAppVerified

public java.lang.String getPreferenceKeyIsAppVerified()