feat(MeetingsAdapter): add types for meeting controls

webex · Aug 27, 2021 · f762b09 · f762b09
1 parent 71a7c5a
commit f762b09
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/src/MeetingsAdapter.js b/src/MeetingsAdapter.js
@@ -59,6 +59,20 @@ import WebexAdapter from './WebexAdapter';
  * @returns {external:Observable.<MeetingControlDisplay>}
  */
 
+/**
+ * Enum for meeting control types
+ *
+ * @readonly
+ * @enum {string}
+ */
+export const MeetingControlType = {
+  JOIN: 'JOIN',
+  CANCEL: 'CANCEL',
+  CLOSE: 'CLOSE',
+  TOGGLE: 'TOGGLE',
+  MULTISELECT: 'MULTISELECT',
+};
+
 /**
  * Display options of a meeting control.
  *
@@ -67,6 +81,7 @@ import WebexAdapter from './WebexAdapter';
  * @property {string}               tooltip  The text to display when user hovers over control
  * @property {string}               icon     Momentum-ui icon name to display for the meeting control
  * @property {string}               text     Text to display on the meeting control. If there is an icon and text, text takes precedence
+ * @property {MeetingControlType}   type     Type of the meeting control
  */
 
 /**

diff --git a/src/index.js b/src/index.js
@@ -3,6 +3,7 @@ export {default as ActivitiesAdapter} from './ActivitiesAdapter';
 export {
   default as MeetingsAdapter,
   MeetingControlState,
+  MeetingControlType,
   MeetingState,
   MediaPermissions,
 } from './MeetingsAdapter';