Package us.zoom.contactscenter.api

Interface ZoomCCService

  • All Implemented Interfaces:
    
public interface ZoomCCService

    Service API

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Unit init(ZoomCCItem item) Initialize the service.
      abstract Integer login() After calling init(), call this method to request to log in to the server.
      abstract Unit logoff() When you don’t need to use the service, call this method to log out of the server.
      abstract Boolean isLogin() Get service login status.
      abstract String getUserZoomId() Get user ID from Zoom server.
      abstract Integer fetchUI() Fetch the video, chat, ZVA, or scheduled callback instance to display.
      abstract ZoomCCItem getZoomCCItem() Get service's ZoomCCItem that was used to initialize the service.
      abstract String getKey() Get ZoomCCItem's apiKey or entryId that was used to initialize the service.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • init

         abstract Unit init(ZoomCCItem item)

        Initialize the service. After using the getZoomCCVideoService, getZoomCCChatService, getZoomCCZVAService, getZoomCCScheduledCallbackService, or getZoomCCWebCampaignService methods to get the service, call the init(item: ZoomCCItem) method once to initialize the service before using it. The init(item: ZoomCCItem) method creates an internal instance to communicate with the server. For video service, this method also initializes the ZoomVideoSDK. For either the chat service or ZVA service, once this method has been called, the service is ready to communicate with the server. Call the login() method to start the request to the server at a flexible time when needed. This method initializes campaign web service, and the calls the requestCampaign() method to ask for campaign information.

        Parameters:
        item - Retrieves information about the service.

      • login

         abstract Integer login()

        After calling init(), call this method to request to log in to the server. For ZoomCCChatService, call this method before calling "fetchUI()". For ZoomCCVideoService and ZoomCCScheduledCallbackService, directly call fetchUI() because the login() method is called internally. For ZoomCCWebCampaignService, directly call requestCampaign().

      • logoff

         abstract Unit logoff()

        When you don’t need to use the service, call this method to log out of the server. For ZoomCCChatService and ZoomCCScheduledCallbackService, call this method to disconnect from the server. For ZoomCCVideoService, do not call this method directly. It will be called internally when video views disappear.

      • isLogin

         abstract Boolean isLogin()

        Get service login status.

        Returns:

        return true if called login() success.

      • getUserZoomId

         abstract String getUserZoomId()

        Get user ID from Zoom server.

        Returns:

        user ID

      • fetchUI

         abstract Integer fetchUI()

        Fetch the video, chat, ZVA, or scheduled callback instance to display. For ZoomCCWebCampaignService, don't call this. Call requestCampaign() in your own activity/fragment.

      • getZoomCCItem

         abstract ZoomCCItem getZoomCCItem()

        Get service's ZoomCCItem that was used to initialize the service.

      • getKey

         abstract String getKey()

        Get ZoomCCItem's apiKey or entryId that was used to initialize the service.