Package us.zoom.sdk

Class ZoomSDK

  • public final class ZoomSDK
extends java.lang.Object
    ZOOM SDK global manager.

    • Method Detail

      • getInstance

        public static ZoomSDK getInstance()
        Get a shared instance of ZOOM SDK, must call from the main thread.
        Returns:
        The ZOOM SDK instance.

      • hasRawDataLicense

        public boolean hasRawDataLicense()
        Query is has raw data license, must call from the main thread.
        Returns:
        raw data license

      • getVideoSourceHelper

        public ZoomSDKVideoSourceHelper getVideoSourceHelper()
        Get video source helper
        Returns:
        video source helper

      • getShareSourceHelper

        public ZoomSDKShareSourceHelper getShareSourceHelper()
        Get share source helper
        Returns:
        share 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

        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 to initialize

      • uninitialize

        public void uninitialize()
        uninitialize Zoom SDK

      • 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, must call from main thread.
        Returns:
        TRUE means initialized. Otherwise not.

      • generateSSOLoginURL

        public java.lang.String generateSSOLoginURL​(java.lang.String ssoDomainPrefix)
        Get SSO login url By the domain prefix
        Parameters:
        ssoDomainPrefix - The domain prefix
        Returns:
        result the SSO login url, null for error

      • handleSSOLoginURIProtocol

        public boolean handleSSOLoginURIProtocol​(java.lang.String uriProtocol)
        Login with the SSO login uri, link zoommtg://*
        Parameters:
        uriProtocol - the sso login url, link zoommtg://*
        Returns:
        true for success, false for fail

      • 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 boolean setDomain​(java.lang.String domain)
        Set a new web domain name, must call from main thread.
        Parameters:
        domain - Domain name to be set. Default value: zoom.us.
        Returns:
        true means success, false means fail for not support domain.

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

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

      • get3DAvatarSettings

        public I3DAvatarSettingContext get3DAvatarSettings()
        Get 3D avatar settings interface.
        Returns:
        The shared instance of I3DAvatarSettingContext. It will return null if the SDK has not been initialized successfully.

      • getReminderHelper

        public IReminderHelper getReminderHelper()
        Get Reminder Helper interface;
        Returns:
        The shared instance of IReminderHelper. If the SDK hasn’t been successfully initialized, it returns null.

      • enableAutoRegisterNotificationServiceForLogin

        public void enableAutoRegisterNotificationServiceForLogin​(boolean enable)
        Enable or disable auto register notification service. This is enabled by default.
        Parameters:
        enable - true means enabled, otherwise not.

      • registerNotificationService

        public MobileRTCSDKError registerNotificationService​(java.lang.String accessToken)
        Register notification service.
        Parameters:
        accessToken - Initialize parameter of notification service.
        Returns:
        If the function succeeds, the return value is MobileRTCSDKError.SDKERR_SUCCESS.