Package us.zoom.sdk

Interface IBOCreator

public interface IBOCreator

  • Method Details

    • setEvent

      void setEvent(IBOCreatorEvent event)

    • createBO

      @Deprecated String createBO(String strBoName)
      Deprecated.
      This interface is marked as deprecated, and it is recommended to use createBreakoutRoom(String).
      Create a breakout room.
      Parameters:
      strBoName - the BO name.
      Returns:
      if success the return value is BO ID, otherwise "".

    • createGroupBO

      MobileRTCSDKError createGroupBO(List<String> boNameList)
      Batch create BO rooms. If the function succeeds, all the created BO rooms will be removed. Note: The max number of the prepared list is 50. The max length of the BO room name is 32. If any element in the list is empty or the length exceeds the maximum length, the creation will fail
      Parameters:
      boNameList - the prepared bo Name list
      Returns:
      If the function succeeds, the return value is MobileRTCSDKError.SDKERR_SUCCESS. Otherwise failed. To get extended error information, see MobileRTCSDKError

    • updateBOName

      boolean updateBOName(String boId, String newBoName)
      Update BO name, 'IBOCreatorEvent.onUpdateBONameResponse' is the corresponding callback notification.
      Parameters:
      boId - is the breakout room' ID.
      newBoName - is the new breakout room's name.
      Returns:
      if success the return value is true. Otherwise the return value is false.

    • removeBO

      boolean removeBO(String boId)
      Remove a breakout room,IBOCreatorEvent.onRemoveBOResponse(boolean, String) is the corresponding callback notification.
      Parameters:
      boId - is the breakout room ID.
      Returns:
      if success the return value is true.Otherwise the return value is false.

    • assignUserToBO

      boolean assignUserToBO(String strUserID, String strBOId)

    • removeUserFromBO

      boolean removeUserFromBO(String strUserID, String strBOId)

    • setBOOption

      boolean setBOOption(BOOption option)
      Set BO option
      Parameters:
      option - the option that you want to set.
      Returns:
      if success the return value is true, otherwise false.

    • getBOOption

      BOOption getBOOption()
      Get BO option
      Returns:
      if success the return value is null

    • isWebPreAssignBOEnabled

      boolean isWebPreAssignBOEnabled()
      Check whether web enabled the pre-assigned option when scheduling a meeting.
      Returns:
      true if it is enabled, otherwise false.

    • requestAndUseWebPreAssignBOList

      MobileRTCSDKError requestAndUseWebPreAssignBOList()
      Request web pre-assigned data and create those rooms.
      Returns:
      If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, see MobileRTCSDKError

    • getWebPreAssignBODataStatus

      PreAssignBODataStatus getWebPreAssignBODataStatus()
      Get the downloading status of pre-assigned data.
      Returns:
      The return value is a enum for download status. For more details, see PreAssignBODataStatus

    • createWebinarBo

      boolean createWebinarBo(List<String> boNameList)

    • createBreakoutRoom

      boolean createBreakoutRoom(String strBOName)
      Create a breakout room. Note: 1. This function is compatible with meeting breakout rooms and webinar breakout rooms. 2. This function is asynchronous, onCreateBOResponse is the corresponding callback notification.
      Parameters:
      strBOName - the breakout room name.
      Returns:
      if success the return value is true, Otherwise false.