Merge pull request #30 from iotum/add-set-hidden-elements

Add set hidden elements

dist/index.d.ts

@@ -156,6 +156,11 @@ declare module '@iotum/callbridge-js/dashboard' {
        * a positive value moves forwards.
        */
       go(delta: number): void;
+      /**
+       * Hides elements on the dashboard.
+       * @param ids An array of element IDs to hide.
+       */
+      setHiddenElements(ids: number[]): void;
   }
 
 }

dist/index.esm.js

@@ -358,6 +358,13 @@ var Dashboard = class extends Widget {
   go(delta) {
     this._send("dashboard", "go", { delta });
   }
+  /**
+   * Hides elements on the dashboard.
+   * @param ids An array of element IDs to hide.
+   */
+  setHiddenElements(ids) {
+    this._send("dashboard", "setHiddenElements", { ids });
+  }
 };
 
 // src/room.ts

dist/index.js

@@ -390,6 +390,13 @@ var Dashboard = class extends Widget {
   go(delta) {
     this._send("dashboard", "go", { delta });
   }
+  /**
+   * Hides elements on the dashboard.
+   * @param ids An array of element IDs to hide.
+   */
+  setHiddenElements(ids) {
+    this._send("dashboard", "setHiddenElements", { ids });
+  }
 };
 
 // src/room.ts

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@iotum/callbridge-js",
   "description": "Loading wrapper for Callbridge",
-  "version": "1.0.12",
+  "version": "1.0.13",
   "author": "Iotum (https://www.iotum.com)",
   "license": "MIT",
   "homepage": "https://www.callbridge.com/",

src/__tests__/dashboard-test.ts

@@ -125,4 +125,19 @@ describe('dashboard', () => {
       '*',
     );
   });
+
+  it('can set hidden elements', () => {
+    dashboard = new Dashboard({ container, domain }, service);
+
+    dashboard.setHiddenElements([1, 2, 3, 4]);
+
+    expect(dashboard.wnd?.postMessage).toHaveBeenCalledWith(
+      {
+        type: 'dashboard',
+        action: 'setHiddenElements',
+        ids: [1, 2, 3, 4],
+      },
+      '*',
+    );
+  });
 });

src/dashboard.ts

@@ -184,4 +184,12 @@ export default class Dashboard extends Widget<{
   go(delta: number) {
     this._send('dashboard', 'go', { delta });
   }
+
+  /**
+   * Hides elements on the dashboard.
+   * @param ids An array of element IDs to hide.
+   */
+  setHiddenElements(ids: number[]) {
+    this._send('dashboard', 'setHiddenElements', { ids });
+  }
 }

wiki/README.md

@@ -47,7 +47,7 @@ Audio output settings.
 
 #### Defined in
 
-[room.ts:6](https://github.com/iotum/callbridge-js/blob/c1b8887/src/room.ts#L6)
+[room.ts:6](https://github.com/iotum/callbridge-js/blob/8719b43/src/room.ts#L6)
 
 ___
 
@@ -65,7 +65,7 @@ ___
 
 #### Defined in
 
-[dashboard.ts:86](https://github.com/iotum/callbridge-js/blob/c1b8887/src/dashboard.ts#L86)
+[dashboard.ts:86](https://github.com/iotum/callbridge-js/blob/8719b43/src/dashboard.ts#L86)
 
 ___
 
@@ -85,7 +85,7 @@ Livestream options.
 
 #### Defined in
 
-[livestream.ts:6](https://github.com/iotum/callbridge-js/blob/c1b8887/src/livestream.ts#L6)
+[livestream.ts:6](https://github.com/iotum/callbridge-js/blob/8719b43/src/livestream.ts#L6)
 
 ___
 
@@ -116,7 +116,7 @@ Meeting options.
 
 #### Defined in
 
-[meeting.ts:7](https://github.com/iotum/callbridge-js/blob/c1b8887/src/meeting.ts#L7)
+[meeting.ts:7](https://github.com/iotum/callbridge-js/blob/8719b43/src/meeting.ts#L7)
 
 ___
 
@@ -138,7 +138,7 @@ Dashboard service options.
 
 #### Defined in
 
-[dashboard.ts:59](https://github.com/iotum/callbridge-js/blob/c1b8887/src/dashboard.ts#L59)
+[dashboard.ts:59](https://github.com/iotum/callbridge-js/blob/8719b43/src/dashboard.ts#L59)
 
 ___
 
@@ -165,4 +165,4 @@ Widget options.
 
 #### Defined in
 
-[widget.ts:9](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L9)
+[widget.ts:9](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L9)

wiki/classes/Dashboard.md

@@ -31,6 +31,7 @@ Callbridge Dashboard.
 - [on](Dashboard.md#on)
 - [once](Dashboard.md#once)
 - [removeAllListeners](Dashboard.md#removealllisteners)
+- [setHiddenElements](Dashboard.md#sethiddenelements)
 - [toggle](Dashboard.md#toggle)
 - [unload](Dashboard.md#unload)
 
@@ -54,7 +55,7 @@ Callbridge Dashboard.
 
 #### Defined in
 
-[dashboard.ts:139](https://github.com/iotum/callbridge-js/blob/c1b8887/src/dashboard.ts#L139)
+[dashboard.ts:139](https://github.com/iotum/callbridge-js/blob/8719b43/src/dashboard.ts#L139)
 
 ## Accessors
 
@@ -74,7 +75,7 @@ Widget.instance
 
 #### Defined in
 
-[widget.ts:267](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L267)
+[widget.ts:267](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L267)
 
 ___
 
@@ -94,7 +95,7 @@ Widget.isReady
 
 #### Defined in
 
-[widget.ts:260](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L260)
+[widget.ts:260](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L260)
 
 ___
 
@@ -114,7 +115,7 @@ Widget.wnd
 
 #### Defined in
 
-[widget.ts:274](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L274)
+[widget.ts:274](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L274)
 
 ## Methods
 
@@ -149,7 +150,7 @@ Returns true if the event had listeners, false otherwise.
 
 #### Defined in
 
-[widget.ts:313](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L313)
+[widget.ts:313](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L313)
 
 ___
 
@@ -171,7 +172,7 @@ Loads a specific page from the session history.
 
 #### Defined in
 
-[dashboard.ts:184](https://github.com/iotum/callbridge-js/blob/c1b8887/src/dashboard.ts#L184)
+[dashboard.ts:184](https://github.com/iotum/callbridge-js/blob/8719b43/src/dashboard.ts#L184)
 
 ___
 
@@ -194,7 +195,7 @@ Loads the service.
 
 #### Defined in
 
-[dashboard.ts:174](https://github.com/iotum/callbridge-js/blob/c1b8887/src/dashboard.ts#L174)
+[dashboard.ts:174](https://github.com/iotum/callbridge-js/blob/8719b43/src/dashboard.ts#L174)
 
 ___
 
@@ -227,7 +228,7 @@ Removes the specified `listener` from the listener array for the event named `ev
 
 #### Defined in
 
-[widget.ts:294](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L294)
+[widget.ts:294](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L294)
 
 ___
 
@@ -260,7 +261,7 @@ Adds the `listener` function to the end of the listeners array for the event nam
 
 #### Defined in
 
-[widget.ts:286](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L286)
+[widget.ts:286](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L286)
 
 ___
 
@@ -294,7 +295,7 @@ The next time eventName is triggered, this listener is removed and then invoked.
 
 #### Defined in
 
-[widget.ts:303](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L303)
+[widget.ts:303](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L303)
 
 ___
 
@@ -323,7 +324,29 @@ particularly when the instance was created by some other component or module.
 
 #### Defined in
 
-[widget.ts:323](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L323)
+[widget.ts:323](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L323)
+
+___
+
+### setHiddenElements
+
+▸ **setHiddenElements**(`ids`): `void`
+
+Hides elements on the dashboard.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `ids` | `number`[] | An array of element IDs to hide. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[dashboard.ts:192](https://github.com/iotum/callbridge-js/blob/8719b43/src/dashboard.ts#L192)
 
 ___
 
@@ -351,7 +374,7 @@ Not available for pop-up.
 
 #### Defined in
 
-[widget.ts:251](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L251)
+[widget.ts:251](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L251)
 
 ___
 
@@ -371,4 +394,4 @@ Unloads the widget by removing the iframe or close the tab/window.
 
 #### Defined in
 
-[widget.ts:223](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L223)
+[widget.ts:223](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L223)

wiki/classes/Livestream.md

@@ -52,7 +52,7 @@ Callbridge Livesteam Viewer.
 
 #### Defined in
 
-[livestream.ts:28](https://github.com/iotum/callbridge-js/blob/c1b8887/src/livestream.ts#L28)
+[livestream.ts:28](https://github.com/iotum/callbridge-js/blob/8719b43/src/livestream.ts#L28)
 
 ## Accessors
 
@@ -72,7 +72,7 @@ Widget.instance
 
 #### Defined in
 
-[widget.ts:267](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L267)
+[widget.ts:267](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L267)
 
 ___
 
@@ -92,7 +92,7 @@ Widget.isReady
 
 #### Defined in
 
-[widget.ts:260](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L260)
+[widget.ts:260](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L260)
 
 ___
 
@@ -112,7 +112,7 @@ Widget.wnd
 
 #### Defined in
 
-[widget.ts:274](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L274)
+[widget.ts:274](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L274)
 
 ## Methods
 
@@ -147,7 +147,7 @@ Returns true if the event had listeners, false otherwise.
 
 #### Defined in
 
-[widget.ts:313](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L313)
+[widget.ts:313](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L313)
 
 ___
 
@@ -180,7 +180,7 @@ Removes the specified `listener` from the listener array for the event named `ev
 
 #### Defined in
 
-[widget.ts:294](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L294)
+[widget.ts:294](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L294)
 
 ___
 
@@ -213,7 +213,7 @@ Adds the `listener` function to the end of the listeners array for the event nam
 
 #### Defined in
 
-[widget.ts:286](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L286)
+[widget.ts:286](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L286)
 
 ___
 
@@ -247,7 +247,7 @@ The next time eventName is triggered, this listener is removed and then invoked.
 
 #### Defined in
 
-[widget.ts:303](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L303)
+[widget.ts:303](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L303)
 
 ___
 
@@ -276,7 +276,7 @@ particularly when the instance was created by some other component or module.
 
 #### Defined in
 
-[widget.ts:323](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L323)
+[widget.ts:323](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L323)
 
 ___
 
@@ -304,7 +304,7 @@ Not available for pop-up.
 
 #### Defined in
 
-[widget.ts:251](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L251)
+[widget.ts:251](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L251)
 
 ___
 
@@ -324,4 +324,4 @@ Unloads the widget by removing the iframe or close the tab/window.
 
 #### Defined in
 
-[widget.ts:223](https://github.com/iotum/callbridge-js/blob/c1b8887/src/widget.ts#L223)
+[widget.ts:223](https://github.com/iotum/callbridge-js/blob/8719b43/src/widget.ts#L223)