Merge pull request #137 from GuiLeme/actions-bar-set-display

feat(plugin): add setDisplayActionsBar ui-command

samples/sample-action-button-dropdown-plugin/src/components/sample-action-button-dropdown-plugin-item/component.tsx

@@ -128,6 +128,18 @@ function SampleActionButtonDropdownPlugin(
             handleFetchPresentationData(currentPresentation);
           },
         }),
+        new ActionButtonDropdownOption({
+          label: 'Close actions bar for 5 seconds',
+          icon: 'copy',
+          tooltip: 'this is a button injected by plugin',
+          allowed: true,
+          onClick: () => {
+            pluginApi.uiCommands.actionsBar.setDisplayActionBar({ displayActionBar: false });
+            setTimeout(() => {
+              pluginApi.uiCommands.actionsBar.setDisplayActionBar({ displayActionBar: true });
+            }, 5000);
+          },
+        }),
         new ActionButtonDropdownOption({
           label: showingGenericContentInPresentationArea ? 'Return previous presentation content' : 'Set different content in presentation area',
           icon: 'copy',

src/ui-commands/actions-bar/commands.ts

@@ -0,0 +1,22 @@
+import { ActionsBarEnum } from './enums';
+import { SetDisplayActionBarCommandArguments } from './types';
+
+export const actionsBar = {
+  /**
+   * Decides whether to display the actions bar
+   *
+   * @param setSpeakerLevelCommandArgumentsthe volume to which the core will set the speaker
+   * level.
+   * Refer to {@link SetDisplayActionBarCommandArguments} to understand the argument structure.
+   */
+  setDisplayActionBar: (arg: SetDisplayActionBarCommandArguments) => {
+    const { displayActionBar } = arg;
+    window.dispatchEvent(new CustomEvent<
+      SetDisplayActionBarCommandArguments
+    >(ActionsBarEnum.SET_DISPLAY_ACTIONS_BAR, {
+      detail: {
+        displayActionBar,
+      },
+    }));
+  },
+};

src/ui-commands/actions-bar/enums.ts

@@ -0,0 +1,3 @@
+export enum ActionsBarEnum {
+  SET_DISPLAY_ACTIONS_BAR = 'SET_DISPLAY_ACTIONS_BAR_COMMAND',
+}

src/ui-commands/actions-bar/types.ts

@@ -0,0 +1,9 @@
+export interface SetDisplayActionBarCommandArguments {
+  displayActionBar: boolean;
+}
+
+export interface UiCommandsActionsBarObject {
+  setDisplayActionBar: (
+    arg: SetDisplayActionBarCommandArguments
+  ) => void;
+}

src/ui-commands/commands.ts

@@ -5,8 +5,10 @@ import { presentationArea } from './presentation-area/commands';
 import { userStatus } from './user-status/commands';
 import { conference } from './conference/commands';
 import { notification } from './notification/commands';
+import { actionsBar } from './actions-bar/commands';
 
 export const uiCommands = {
+  actionsBar,
   chat,
   externalVideo,
   sidekickOptionsContainer,

src/ui-commands/types.ts

@@ -5,8 +5,10 @@ import { UiCommandsPresentationAreaObject } from './presentation-area/types';
 import { UiCommandsUserStatusObject } from './user-status/types';
 import { UiCommandsConferenceObject } from './conference/types';
 import { UiCommandsNotificationObject } from './notification/types';
+import { UiCommandsActionsBarObject } from './actions-bar/types';
 
 export interface UiCommands {
+  actionsBar: UiCommandsActionsBarObject;
   chat: UiCommandsChatObject;
   externalVideo: UiCommandsExternalVideoObject;
   sidekickOptionsContainer: UiCommandsSidekickOptionsContainerObject;