UNPKG

@19labs/gale-wellness

Version:

## Overview Welcome to the [19Labs](https://19labs.com) Custom Wellness Portal SDK .

422 lines 18.6 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>GaleEventTypes | @19labs/gale-wellness</title> <meta name="description" content="Documentation for @19labs/gale-wellness"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <script async src="../assets/js/search.js" id="search-script"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">@19labs/gale-wellness</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../modules.html">@19labs/gale-wellness</a> </li> <li> <a href="galeeventtypes.html">GaleEventTypes</a> </li> </ul> <h1>Interface GaleEventTypes</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">GaleEventTypes</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="galeeventtypes.html#apierror" class="tsd-kind-icon">apierror</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="galeeventtypes.html#callend" class="tsd-kind-icon">callend</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="galeeventtypes.html#callstart" class="tsd-kind-icon">callstart</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="galeeventtypes.html#callupdate" class="tsd-kind-icon">callupdate</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="galeeventtypes.html#externallogin" class="tsd-kind-icon">externallogin</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="galeeventtypes.html#intake" class="tsd-kind-icon">intake</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="galeeventtypes.html#languagechange" class="tsd-kind-icon">languagechange</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="galeeventtypes.html#loginchange" class="tsd-kind-icon">loginchange</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="galeeventtypes.html#loginerror" class="tsd-kind-icon">loginerror</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="galeeventtypes.html#loginsuccess" class="tsd-kind-icon">loginsuccess</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="galeeventtypes.html#sensordata" class="tsd-kind-icon">sensordata</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="galeeventtypes.html#sensormeasurementdata" class="tsd-kind-icon">sensormeasurementdata</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="galeeventtypes.html#sessionchange" class="tsd-kind-icon">sessionchange</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="galeeventtypes.html#signuperror" class="tsd-kind-icon">signuperror</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="galeeventtypes.html#signupsuccess" class="tsd-kind-icon">signupsuccess</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="apierror" class="tsd-anchor"></a> <h3>apierror</h3> <div class="tsd-signature tsd-kind-icon">apierror<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:60</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when an error is thrown from the API, with the error message</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="callend" class="tsd-anchor"></a> <h3>callend</h3> <div class="tsd-signature tsd-kind-icon">callend<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:51</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when a zoom call has ended</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="callstart" class="tsd-anchor"></a> <h3>callstart</h3> <div class="tsd-signature tsd-kind-icon">callstart<span class="tsd-signature-symbol">:</span> <a href="zoomcallurl.html" class="tsd-signature-type" data-tsd-kind="Interface">ZoomCallUrl</a></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:54</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when a zoom call has started</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="callupdate" class="tsd-anchor"></a> <h3>callupdate</h3> <div class="tsd-signature tsd-kind-icon">callupdate<span class="tsd-signature-symbol">:</span> <a href="participants.html" class="tsd-signature-type" data-tsd-kind="Interface">Participants</a></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:57</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when a zoom call has updated</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="externallogin" class="tsd-anchor"></a> <h3>externallogin</h3> <div class="tsd-signature tsd-kind-icon">externallogin<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">JSON</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:27</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when an external authentication login JSON is received</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="intake" class="tsd-anchor"></a> <h3>intake</h3> <div class="tsd-signature tsd-kind-icon">intake<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:21</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when the user fills out an intake form.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="languagechange" class="tsd-anchor"></a> <h3>languagechange</h3> <div class="tsd-signature tsd-kind-icon">languagechange<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:18</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when the user changes the system language.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="loginchange" class="tsd-anchor"></a> <h3>loginchange</h3> <div class="tsd-signature tsd-kind-icon">loginchange<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:33</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when the user logs in or out.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="loginerror" class="tsd-anchor"></a> <h3>loginerror</h3> <div class="tsd-signature tsd-kind-icon">loginerror<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:39</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when a login request fails.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="loginsuccess" class="tsd-anchor"></a> <h3>loginsuccess</h3> <div class="tsd-signature tsd-kind-icon">loginsuccess<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:36</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when a login request succeeeds.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="sensordata" class="tsd-anchor"></a> <h3>sensordata</h3> <div class="tsd-signature tsd-kind-icon">sensordata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:30</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when a sensor measurement is complete.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="sensormeasurementdata" class="tsd-anchor"></a> <h3>sensormeasurementdata</h3> <div class="tsd-signature tsd-kind-icon">sensormeasurementdata<span class="tsd-signature-symbol">:</span> <a href="../modules.html#sensormeasurementdata" class="tsd-signature-type" data-tsd-kind="Type alias">SensorMeasurementData</a></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:24</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when a new sesnor measurement is available.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="sessionchange" class="tsd-anchor"></a> <h3>sessionchange</h3> <div class="tsd-signature tsd-kind-icon">sessionchange<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:48</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when a patient session has started or ended</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="signuperror" class="tsd-anchor"></a> <h3>signuperror</h3> <div class="tsd-signature tsd-kind-icon">signuperror<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:45</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when creating a new account has failed, with the reason for failure.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="signupsuccess" class="tsd-anchor"></a> <h3>signupsuccess</h3> <div class="tsd-signature tsd-kind-icon">signupsuccess<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:42</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called when a new account is created.</p> </div> </div> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class=" "> <a href="../modules.html">Exports</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-interface"> <a href="galeeventtypes.html" class="tsd-kind-icon">Gale<wbr>Event<wbr>Types</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="galeeventtypes.html#apierror" class="tsd-kind-icon">apierror</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="galeeventtypes.html#callend" class="tsd-kind-icon">callend</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="galeeventtypes.html#callstart" class="tsd-kind-icon">callstart</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="galeeventtypes.html#callupdate" class="tsd-kind-icon">callupdate</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="galeeventtypes.html#externallogin" class="tsd-kind-icon">externallogin</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="galeeventtypes.html#intake" class="tsd-kind-icon">intake</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="galeeventtypes.html#languagechange" class="tsd-kind-icon">languagechange</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="galeeventtypes.html#loginchange" class="tsd-kind-icon">loginchange</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="galeeventtypes.html#loginerror" class="tsd-kind-icon">loginerror</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="galeeventtypes.html#loginsuccess" class="tsd-kind-icon">loginsuccess</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="galeeventtypes.html#sensordata" class="tsd-kind-icon">sensordata</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="galeeventtypes.html#sensormeasurementdata" class="tsd-kind-icon">sensormeasurementdata</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="galeeventtypes.html#sessionchange" class="tsd-kind-icon">sessionchange</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="galeeventtypes.html#signuperror" class="tsd-kind-icon">signuperror</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="galeeventtypes.html#signupsuccess" class="tsd-kind-icon">signupsuccess</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> </body> </html>