UNPKG

opennms

Version:

Client API for the OpenNMS network monitoring platform

39 lines (38 loc) 43.2 kB
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SituationFeedbackDAO | OpenNMS.js - v2.5.11</title><meta name="description" content="Documentation for OpenNMS.js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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">OpenNMS.js - v2.5.11</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">OpenNMS.js</a></li><li><a href="../modules/DAO.html">DAO</a></li><li><a href="DAO.SituationFeedbackDAO.html">SituationFeedbackDAO</a></li></ul><h1>Class SituationFeedbackDAO</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Data access for [[OnmsSituationFeedback]] objects.</p> </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy" data-refl="1421"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">BaseDAO</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">SituationFeedbackDAO</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/dao/SituationFeedbackDAO.ts#L15">src/dao/SituationFeedbackDAO.ts:15</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-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="DAO.SituationFeedbackDAO.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="DAO.SituationFeedbackDAO.html#http" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>http</span></a> <a href="DAO.SituationFeedbackDAO.html#server" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>server</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="DAO.SituationFeedbackDAO.html#getcount" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Count</span></a> <a href="DAO.SituationFeedbackDAO.html#getdata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Data</span></a> <a href="DAO.SituationFeedbackDAO.html#getfeedback" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Feedback</span></a> <a href="DAO.SituationFeedbackDAO.html#gettags" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tags</span></a> <a href="DAO.SituationFeedbackDAO.html#onsetserver" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Set<wbr/>Server</span></a> <a href="DAO.SituationFeedbackDAO.html#savefeedback" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Feedback</span></a> <a href="DAO.SituationFeedbackDAO.html#todate" class="tsd-index-link deprecated tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Date</span></a> <a href="DAO.SituationFeedbackDAO.html#tonumber" class="tsd-index-link deprecated tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Number</span></a> <a href="DAO.SituationFeedbackDAO.html#usejson" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>use<wbr/>Json</span></a> </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructorsituationfeedbackdao" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">SituationFeedbackDAO</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">impl</span><span class="tsd-signature-symbol">:</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/API.IOnmsHTTP.html" class="tsd-signature-type tsd-kind-interface">IOnmsHTTP</a> <span class="tsd-signature-symbol">|</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/API.IHasHTTP.html" class="tsd-signature-type tsd-kind-interface">IHasHTTP</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../modules/DAO.html" class="tsd-signature-type tsd-kind-namespace">DAO</a><span class="tsd-signature-symbol">.</span><a href="DAO.SituationFeedbackDAO.html" class="tsd-signature-type tsd-kind-class">SituationFeedbackDAO</a><a href="#constructorsituationfeedbackdao" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">impl</span>: <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/API.IOnmsHTTP.html" class="tsd-signature-type tsd-kind-interface">IOnmsHTTP</a> <span class="tsd-signature-symbol">|</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/API.IHasHTTP.html" class="tsd-signature-type tsd-kind-interface">IHasHTTP</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/DAO.html" class="tsd-signature-type tsd-kind-namespace">DAO</a><span class="tsd-signature-symbol">.</span><a href="DAO.SituationFeedbackDAO.html" class="tsd-signature-type tsd-kind-class">SituationFeedbackDAO</a></h4><aside class="tsd-sources"><p>Overrides BaseDAO.constructor</p><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/dao/SituationFeedbackDAO.ts#L17">src/dao/SituationFeedbackDAO.ts:17</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="http" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>http</span><a href="#http" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature" id="http-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">http</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/API.IOnmsHTTP.html" class="tsd-signature-type tsd-kind-interface">IOnmsHTTP</a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The HTTP implementation to use internally when making DAO requests.</p> </div><h4 class="tsd-returns-title">Returns <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/API.IOnmsHTTP.html" class="tsd-signature-type tsd-kind-interface">IOnmsHTTP</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from BaseDAO.http</p><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/dao/BaseDAO.ts#L56">src/dao/BaseDAO.ts:56</a></li></ul></aside></li><li class="tsd-signature" id="http-2"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">http</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">impl</span><span class="tsd-signature-symbol">:</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/API.IOnmsHTTP.html" class="tsd-signature-type tsd-kind-interface">IOnmsHTTP</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">impl</span>: <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/API.IOnmsHTTP.html" class="tsd-signature-type tsd-kind-interface">IOnmsHTTP</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from BaseDAO.http</p><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/dao/BaseDAO.ts#L61">src/dao/BaseDAO.ts:61</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="server" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>server</span><a href="#server" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature" id="server-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">server</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.OnmsServer.html" class="tsd-signature-type tsd-kind-class">OnmsServer</a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The [[OnmsServer]] being connected to by this DAO.</p> </div><h4 class="tsd-returns-title">Returns <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.OnmsServer.html" class="tsd-signature-type tsd-kind-class">OnmsServer</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from BaseDAO.server</p><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/dao/BaseDAO.ts#L68">src/dao/BaseDAO.ts:68</a></li></ul></aside></li><li class="tsd-signature" id="server-2"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">server</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">s</span><span class="tsd-signature-symbol">:</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.OnmsServer.html" class="tsd-signature-type tsd-kind-class">OnmsServer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">s</span>: <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.OnmsServer.html" class="tsd-signature-type tsd-kind-class">OnmsServer</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from BaseDAO.server</p><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/dao/BaseDAO.ts#L76">src/dao/BaseDAO.ts:76</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="getcount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>get<wbr/>Count</span><a href="#getcount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getcount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getCount</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getcount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">status</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from BaseDAO.getCount</p><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/dao/BaseDAO.ts#L139">src/dao/BaseDAO.ts:139</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getdata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Data</span><a href="#getdata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getdata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getData</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="Model.OnmsSituationFeedback.html" class="tsd-signature-type tsd-kind-class">OnmsSituationFeedback</a><span class="tsd-signature-symbol">[]</span><a href="#getdata-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Extracts the data from an HTTP Request result.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">result</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>the HTTP Request result.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="Model.OnmsSituationFeedback.html" class="tsd-signature-type tsd-kind-class">OnmsSituationFeedback</a><span class="tsd-signature-symbol">[]</span></h4><p>An array of [[OnmsSituationFeedback]] objects.</p> <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/dao/SituationFeedbackDAO.ts#L79">src/dao/SituationFeedbackDAO.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getfeedback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Feedback</span><a href="#getfeedback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getfeedback-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getFeedback</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">situationId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="Model.OnmsSituationFeedback.html" class="tsd-signature-type tsd-kind-class">OnmsSituationFeedback</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#getfeedback-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieve feedback.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">situationId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The alarmId of the Situation to use when querying.</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="Model.OnmsSituationFeedback.html" class="tsd-signature-type tsd-kind-class">OnmsSituationFeedback</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>An array of [[OnmsSituationFeedback]] objects.</p> <div class="tsd-comment tsd-typography"><div class="tsd-tag-version"><h4 class="tsd-anchor-link"><a id="version" class="tsd-anchor"></a>Version<a href="#version" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>ReST v1</p> </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/dao/SituationFeedbackDAO.ts#L28">src/dao/SituationFeedbackDAO.ts:28</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="gettags" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Tags</span><a href="#gettags" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="gettags-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getTags</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prefix</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <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-symbol">&gt;</span><a href="#gettags-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieve the tags for a given prefix</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">prefix</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the prefix associated with the tags</p> </div><div class="tsd-comment tsd-typography"></div></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-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/dao/SituationFeedbackDAO.ts#L48">src/dao/SituationFeedbackDAO.ts:48</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="onsetserver" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>on<wbr/>Set<wbr/>Server</span><a href="#onsetserver" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="onsetserver-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">onSetServer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">server</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.OnmsServer.html" class="tsd-signature-type tsd-kind-class">OnmsServer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#onsetserver-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called whenever the OpenNMS server has changed.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">server</span>: <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.OnmsServer.html" class="tsd-signature-type tsd-kind-class">OnmsServer</a></span><div class="tsd-comment tsd-typography"><p>the new server</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from BaseDAO.onSetServer</p><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/dao/BaseDAO.ts#L121">src/dao/BaseDAO.ts:121</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="savefeedback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>Feedback</span><a href="#savefeedback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="savefeedback-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">saveFeedback</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">feedback</span><span class="tsd-signature-symbol">:</span> <a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="Model.OnmsSituationFeedback.html" class="tsd-signature-type tsd-kind-class">OnmsSituationFeedback</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">situationId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#savefeedback-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submit Correlation Feedback for a Situation.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">feedback</span>: <a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="Model.OnmsSituationFeedback.html" class="tsd-signature-type tsd-kind-class">OnmsSituationFeedback</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The [[OnmsSituationFeedback]].</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">situationId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The alarmId of the Situation to use when querying.</p> </div><div class="tsd-comment tsd-typography"></div></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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-version"><h4 class="tsd-anchor-link"><a id="version-1" class="tsd-anchor"></a>Version<a href="#version-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>ReST v1</p> </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/dao/SituationFeedbackDAO.ts#L69">src/dao/SituationFeedbackDAO.ts:69</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="todate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span class="deprecated">to<wbr/>Date</span><a href="#todate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="todate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toDate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Moment</span><a href="#todate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Convert the given value to a date, or undefined if it cannot be converted.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">from</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Moment</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated" class="tsd-anchor"></a>Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>use <a href="undefined">Util.toDate</a> instead.</p> </div></div><aside class="tsd-sources"><p>Inherited from BaseDAO.toDate</p><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/dao/BaseDAO.ts#L161">src/dao/BaseDAO.ts:161</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="tonumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span class="deprecated">to<wbr/>Number</span><a href="#tonumber" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="tonumber-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toNumber</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#tonumber-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Convert the given value to a number, or undefined if it cannot be converted.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">from</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-1" class="tsd-anchor"></a>Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>use <a href="undefined">Util.toNumber</a> instead.</p> </div></div><aside class="tsd-sources"><p>Inherited from BaseDAO.toNumber</p><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/dao/BaseDAO.ts#L169">src/dao/BaseDAO.ts:169</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="usejson" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>use<wbr/>Json</span><a href="#usejson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="usejson-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">useJson</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#usejson-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether or not to use JSON when making ReST requests.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from BaseDAO.useJson</p><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/dao/BaseDAO.ts#L128">src/dao/BaseDAO.ts:128</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#http" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>http</span></a><a href="#server" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>server</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#getcount" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Count</span></a><a href="#getdata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Data</span></a><a href="#getfeedback" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Feedback</span></a><a href="#gettags" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tags</span></a><a href="#onsetserver" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Set<wbr/>Server</span></a><a href="#savefeedback" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Feedback</span></a><a href="#todate" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Date</span></a><a href="#tonumber" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Number</span></a><a href="#usejson" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>use<wbr/>Json</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">OpenNMS.js - v2.5.11</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>