Skip to content

Implement BigBlueButton 3.0 API updates #265

@GhaziTriki

Description

@GhaziTriki

API create Endpoint Updates

  • Add New Parameters: Update API calls to include the following new parameters where applicable:
    • allowOverrideClientSettingsOnCreateCall
    • loginURL
    • pluginManifests
    • pluginManifestsFetchUrl
    • presentationConversionCacheEnabled
    • maxNumPages
    • multiUserWhiteboardEnabled
  • Remove Deprecated Parameters: Ensure these parameters are no longer sent in requests (Keep deprecation for previous versions support)
    • breakoutRoomsEnabled
    • learningDashboardEnabled
    • virtualBackgroundsDisabled
  • Update meetingLayout: Implement support for the new layout options:
    • CAMERAS_ONLY
    • PARTICIPANTS_CHAT_ONLY
    • PRESENTATION_ONLY
    • MEDIA_ONLY
  • Implement clientSettingsOverride POST Module: Integrate the new module for overriding client settings.
  • Review disabledFeatures: Update logic to handle the new disabled feature flags:
    • infiniteWhiteboard
    • deleteChatMessage, editChatMessage, replyChatMessage, chatMessageReactions
    • raiseHand, userReactions, chatEmojiPicker
    • quizzes

API join Endpoint Updates

  • Add New Parameters: Update API calls to include the following new parameters:
    • bot
    • enforceLayout
    • logoutURL
    • firstName
    • lastName
  • Handle User Data Changes:
    • Replace: defaultLayout $\rightarrow$ userdata-bbb_default_layout
    • Add New User Data Fields:
      • userdata-bbb_skip_echotest_if_previous_device
      • userdata-bbb_prefer_dark_theme
      • userdata-bbb_hide_notifications
      • userdata-bbb_hide_controls
      • userdata-bbb_initial_selected_tool
  • Remove Deprecated Items:
    • Stop using userdata-bbb_ask_for_feedback_on_logout
    • HTTP Method Restriction: Ensure all join requests use GET (support for other methods removed).

New Endpoints & Features

  • Implement sendChatMessage: Add logic to utilize the newly introduced endpoint.
  • Implement getJoinUrl: Integrate the new helper endpoint for retrieving join URLs.

Endpoint Removals & Refactoring

  • Remove enter Endpoint: Delete any internal code referencing the /enter endpoint.
  • Remove html5client/check Endpoint: Delete any health check code relying on /html5client/check returning {"html5clientStatus":"running"}.
  • Update Feedback Submission:
    • Refactor code calling /html5client/feedback to point to the new /api/feedback endpoint.

Sub-issues

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions