Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@tbjolset
tbjolset committed Sep 25, 2023
1 parent bb10faa commit 0b219de
Show file tree
Hide file tree
Showing 29 changed files with 528 additions and 156 deletions.
2 changes: 1 addition & 1 deletion docs/assets/search.js
View file

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<div class="site-menu">
<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>workspace-<wbr/>integrations</span></a>
<ul class="tsd-small-nested-navigation">
<li><a href="interfaces/AppInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>App<wbr/>Info</span></a></li>
<li><a href="interfaces/ActivationCode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Activation<wbr/>Code</span></a></li>
<li><a href="interfaces/AppConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>App<wbr/>Config</span></a></li>
<li><a href="interfaces/AppInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>App<wbr/>Info</span></a></li>
<li><a href="interfaces/Config.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Config</span></a></li>
<li><a href="interfaces/Device.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Device</span></a></li>
<li><a href="interfaces/Devices.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Devices</span></a></li>
Expand All @@ -65,6 +67,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="types/ErrorHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Error<wbr/>Handler</span></a></li>
<li><a href="types/EventListener.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Event<wbr/>Listener</span></a></li>
<li><a href="types/LogLevel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Log<wbr/>Level</span></a></li>
<li><a href="types/NotificationType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Notification<wbr/>Type</span></a></li>
<li><a href="types/StatusListener.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Status<wbr/>Listener</span></a></li>
<li><a href="types/XapiPath.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Xapi<wbr/>Path</span></a></li>
<li><a href="types/connect.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>connect</span></a></li></ul></nav></div></div></div>
Expand Down
112 changes: 112 additions & 0 deletions docs/interfaces/ActivationCode.html
View file

Large diffs are not rendered by default.

126 changes: 126 additions & 0 deletions docs/interfaces/AppConfig.html
View file

Large diffs are not rendered by default.

31 changes: 17 additions & 14 deletions docs/interfaces/AppInfo.html
View file

Large diffs are not rendered by default.

13 changes: 8 additions & 5 deletions docs/interfaces/Config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">Config</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cisco-ce/workspace-integrations-nodejs/blob/22ccdb9/src/types.ts#L206">types.ts:206</a></li></ul></aside>
<li>Defined in <a href="https://github.com/cisco-ce/workspace-integrations-nodejs/blob/bb10faa/src/types.ts#L219">types.ts:219</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -65,7 +65,7 @@ <h5><span class="tsd-kind-parameter">deviceId</span>: <span class="tsd-signature
<h5><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../types/DataObject.html" class="tsd-signature-type tsd-kind-type-alias">DataObject</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cisco-ce/workspace-integrations-nodejs/blob/22ccdb9/src/types.ts#L207">types.ts:207</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/cisco-ce/workspace-integrations-nodejs/blob/bb10faa/src/types.ts#L220">types.ts:220</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="set" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set</span><a href="#set" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">set</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">deviceId</span>, <span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/DataObject.html" class="tsd-signature-type tsd-kind-type-alias">DataObject</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div>
Expand All @@ -90,7 +90,7 @@ <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-ty
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/DataObject.html" class="tsd-signature-type tsd-kind-type-alias">DataObject</a><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cisco-ce/workspace-integrations-nodejs/blob/22ccdb9/src/types.ts#L212">types.ts:212</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/cisco-ce/workspace-integrations-nodejs/blob/bb10faa/src/types.ts#L225">types.ts:225</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="setMany" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Many</span><a href="#setMany" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">set<wbr/>Many</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">deviceId</span>, <span class="tsd-kind-parameter">values</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/DataObject.html" class="tsd-signature-type tsd-kind-type-alias">DataObject</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div>
Expand Down Expand Up @@ -119,7 +119,7 @@ <h5><span class="tsd-kind-parameter">values</span>: <a href="../types/DataObject
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/DataObject.html" class="tsd-signature-type tsd-kind-type-alias">DataObject</a><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/cisco-ce/workspace-integrations-nodejs/blob/22ccdb9/src/types.ts#L227">types.ts:227</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/cisco-ce/workspace-integrations-nodejs/blob/bb10faa/src/types.ts#L240">types.ts:240</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand All @@ -145,7 +145,9 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<div class="site-menu">
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>workspace-<wbr/>integrations</span></a>
<ul class="tsd-small-nested-navigation">
<li><a href="AppInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>App<wbr/>Info</span></a></li>
<li><a href="ActivationCode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Activation<wbr/>Code</span></a></li>
<li><a href="AppConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>App<wbr/>Config</span></a></li>
<li><a href="AppInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>App<wbr/>Info</span></a></li>
<li><a href="Config.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Config</span></a></li>
<li><a href="Device.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Device</span></a></li>
<li><a href="Devices.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Devices</span></a></li>
Expand All @@ -165,6 +167,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../types/ErrorHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Error<wbr/>Handler</span></a></li>
<li><a href="../types/EventListener.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Event<wbr/>Listener</span></a></li>
<li><a href="../types/LogLevel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Log<wbr/>Level</span></a></li>
<li><a href="../types/NotificationType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Notification<wbr/>Type</span></a></li>
<li><a href="../types/StatusListener.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Status<wbr/>Listener</span></a></li>
<li><a href="../types/XapiPath.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Xapi<wbr/>Path</span></a></li>
<li><a href="../types/connect.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>connect</span></a></li></ul></nav></div></div></div>
Expand Down
Loading

0 comments on commit 0b219de

Please sign in to comment.