opennms
Version:
Client API for the OpenNMS network monitoring platform
822 lines (821 loc) • 84.9 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AlarmDAO | OpenNMS.js</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.js" 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">OpenNMS.js</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>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a>
</li>
<li>
<a href="alarmdao.html">AlarmDAO</a>
</li>
</ul>
<h1>Class AlarmDAO</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Data access for <a href="onmsalarm.html">OnmsAlarm</a> objects.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="abstractdao.html" class="tsd-signature-type">AbstractDAO</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a><span class="tsd-signature-symbol">></span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AlarmDAO</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/ivalueprovider.html" class="tsd-signature-type">IValueProvider</a></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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="alarmdao.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="alarmdao.html#http" class="tsd-kind-icon">http</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="alarmdao.html#acknowledge" class="tsd-kind-icon">acknowledge</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="alarmdao.html#clear" class="tsd-kind-icon">clear</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="alarmdao.html#closeticket" class="tsd-kind-icon">close<wbr>Ticket</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="alarmdao.html#createticket" class="tsd-kind-icon">create<wbr>Ticket</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="alarmdao.html#deletejournalmemo" class="tsd-kind-icon">delete<wbr>Journal<wbr>Memo</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="alarmdao.html#deletestickymemo" class="tsd-kind-icon">delete<wbr>Sticky<wbr>Memo</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="alarmdao.html#escalate" class="tsd-kind-icon">escalate</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="alarmdao.html#find" class="tsd-kind-icon">find</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="alarmdao.html#findvalues" class="tsd-kind-icon">find<wbr>Values</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="alarmdao.html#get" class="tsd-kind-icon">get</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="alarmdao.html#getapiversion" class="tsd-kind-icon">get<wbr>Api<wbr>Version</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="alarmdao.html#getcount" class="tsd-kind-icon">get<wbr>Count</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="alarmdao.html#getdata" class="tsd-kind-icon">get<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="alarmdao.html#getdetailspage" class="tsd-kind-icon">get<wbr>Details<wbr>Page</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="alarmdao.html#getfilterprocessor" class="tsd-kind-icon">get<wbr>Filter<wbr>Processor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="alarmdao.html#getpropertiescache" class="tsd-kind-icon">get<wbr>Properties<wbr>Cache</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="alarmdao.html#parseresultlist" class="tsd-kind-icon">parse<wbr>Result<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="alarmdao.html#savejournalmemo" class="tsd-kind-icon">save<wbr>Journal<wbr>Memo</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="alarmdao.html#savestickymemo" class="tsd-kind-icon">save<wbr>Sticky<wbr>Memo</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="alarmdao.html#searchproperties" class="tsd-kind-icon">search<wbr>Properties</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="alarmdao.html#searchproperty" class="tsd-kind-icon">search<wbr>Property</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="alarmdao.html#searchpropertypath" class="tsd-kind-icon">search<wbr>Property<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="alarmdao.html#settticketid" class="tsd-kind-icon">setTTicket<wbr>Id</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="alarmdao.html#settticketstate" class="tsd-kind-icon">setTTicket<wbr>State</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="alarmdao.html#todate" class="tsd-kind-icon">to<wbr>Date</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="alarmdao.html#tonumber" class="tsd-kind-icon">to<wbr>Number</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="alarmdao.html#triggerticketupdate" class="tsd-kind-icon">trigger<wbr>Ticket<wbr>Update</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="alarmdao.html#unacknowledge" class="tsd-kind-icon">unacknowledge</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="alarmdao.html#usejson" class="tsd-kind-icon">use<wbr>Json</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>AlarmDAO<span class="tsd-signature-symbol">(</span>impl<span class="tsd-signature-symbol">: </span><a href="../interfaces/ihashttp.html" class="tsd-signature-type">IHasHTTP</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ionmshttp.html" class="tsd-signature-type">IOnmsHTTP</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="alarmdao.html" class="tsd-signature-type">AlarmDAO</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="basedao.html">BaseDAO</a>.<a href="basedao.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AlarmDAO.ts#L37">dao/AlarmDAO.ts:37</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>impl: <a href="../interfaces/ihashttp.html" class="tsd-signature-type">IHasHTTP</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ionmshttp.html" class="tsd-signature-type">IOnmsHTTP</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="alarmdao.html" class="tsd-signature-type">AlarmDAO</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<a name="http" class="tsd-anchor"></a>
<h3>http</h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> http<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ionmshttp.html" class="tsd-signature-type">IOnmsHTTP</a></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> http<span class="tsd-signature-symbol">(</span>impl<span class="tsd-signature-symbol">: </span><a href="../interfaces/ionmshttp.html" class="tsd-signature-type">IOnmsHTTP</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="basedao.html">BaseDAO</a>.<a href="basedao.html#http">http</a></p>
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/BaseDAO.ts#L57">dao/BaseDAO.ts:57</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The HTTP implementation to use internally when making DAO requests.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/ionmshttp.html" class="tsd-signature-type">IOnmsHTTP</a></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="basedao.html">BaseDAO</a>.<a href="basedao.html#http">http</a></p>
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/BaseDAO.ts#L61">dao/BaseDAO.ts:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The HTTP implementation to use internally when making DAO requests.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>impl: <a href="../interfaces/ionmshttp.html" class="tsd-signature-type">IOnmsHTTP</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="acknowledge" class="tsd-anchor"></a>
<h3>acknowledge</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">acknowledge<span class="tsd-signature-symbol">(</span>alarm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a>, user<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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AlarmDAO.ts#L116">dao/AlarmDAO.ts:116</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Acknowledge an alarm.</p>
</div>
<dl class="tsd-comment-tags">
<dt>version</dt>
<dd><p>ReST v1+</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>alarm: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> user: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The user to ack the alarm as.
(Only administrators have the right to do this.)</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="clear" class="tsd-anchor"></a>
<h3>clear</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">clear<span class="tsd-signature-symbol">(</span>alarm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AlarmDAO.ts#L161">dao/AlarmDAO.ts:161</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Clear an alarm.</p>
</div>
<dl class="tsd-comment-tags">
<dt>version</dt>
<dd><p>ReST v1+</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>alarm: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a></h5>
<div class="tsd-comment tsd-typography">
<p>The <a href="onmsalarm.html">OnmsAlarm</a> or alarm ID.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="closeticket" class="tsd-anchor"></a>
<h3>close<wbr>Ticket</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">close<wbr>Ticket<span class="tsd-signature-symbol">(</span>alarm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AlarmDAO.ts#L252">dao/AlarmDAO.ts:252</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Close the ticket associated with the given alarm.</p>
</div>
<dl class="tsd-comment-tags">
<dt>version</dt>
<dd><p>ReST v2</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>alarm: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a></h5>
<div class="tsd-comment tsd-typography">
<p>The <a href="onmsalarm.html">OnmsAlarm</a> or alarm ID.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="createticket" class="tsd-anchor"></a>
<h3>create<wbr>Ticket</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>Ticket<span class="tsd-signature-symbol">(</span>alarm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AlarmDAO.ts#L202">dao/AlarmDAO.ts:202</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create a trouble ticket for the specified alarm.</p>
</div>
<dl class="tsd-comment-tags">
<dt>version</dt>
<dd><p>ReST v2</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>alarm: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a></h5>
<div class="tsd-comment tsd-typography">
<p>The <a href="onmsalarm.html">OnmsAlarm</a> or alarm ID.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="deletejournalmemo" class="tsd-anchor"></a>
<h3>delete<wbr>Journal<wbr>Memo</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">delete<wbr>Journal<wbr>Memo<span class="tsd-signature-symbol">(</span>alarm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AlarmDAO.ts#L313">dao/AlarmDAO.ts:313</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Delete the journal memo ticket associated with the given alarm.</p>
</div>
<dl class="tsd-comment-tags">
<dt>version</dt>
<dd><p>ReST v2</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>alarm: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a></h5>
<div class="tsd-comment tsd-typography">
<p>The <a href="onmsalarm.html">OnmsAlarm</a> or alarm ID.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="deletestickymemo" class="tsd-anchor"></a>
<h3>delete<wbr>Sticky<wbr>Memo</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">delete<wbr>Sticky<wbr>Memo<span class="tsd-signature-symbol">(</span>alarm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AlarmDAO.ts#L303">dao/AlarmDAO.ts:303</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Delete the sticky memo ticket associated with the given alarm.</p>
</div>
<dl class="tsd-comment-tags">
<dt>version</dt>
<dd><p>ReST v2</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>alarm: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a></h5>
<div class="tsd-comment tsd-typography">
<p>The <a href="onmsalarm.html">OnmsAlarm</a> or alarm ID.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="escalate" class="tsd-anchor"></a>
<h3>escalate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">escalate<span class="tsd-signature-symbol">(</span>alarm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AlarmDAO.ts#L148">dao/AlarmDAO.ts:148</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Escalate an alarm.</p>
</div>
<dl class="tsd-comment-tags">
<dt>version</dt>
<dd><p>ReST v1+</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>alarm: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a></h5>
<div class="tsd-comment tsd-typography">
<p>The <a href="onmsalarm.html">OnmsAlarm</a> or alarm ID.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="find" class="tsd-anchor"></a>
<h3>find</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">find<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">?: </span><a href="filter.html" class="tsd-signature-type">Filter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="abstractdao.html">AbstractDAO</a>.<a href="abstractdao.html#find">find</a></p>
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AlarmDAO.ts#L66">dao/AlarmDAO.ts:66</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Find matching alarms.</p>
</div>
<dl class="tsd-comment-tags">
<dt>version</dt>
<dd><p>ReST v1+</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> filter: <a href="filter.html" class="tsd-signature-type">Filter</a></h5>
<div class="tsd-comment tsd-typography">
<p>The filter to use when querying.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
<p>An array of <a href="onmsalarm.html">OnmsAlarm</a> objects.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="findvalues" class="tsd-anchor"></a>
<h3>find<wbr>Values</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">find<wbr>Values<span class="tsd-signature-symbol">(</span>propertyId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/ivalueprovider.html">IValueProvider</a>.<a href="../interfaces/ivalueprovider.html#findvalues">findValues</a></p>
<p>Inherited from <a href="abstractdao.html">AbstractDAO</a>.<a href="abstractdao.html#findvalues">findValues</a></p>
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AbstractDAO.ts#L123">dao/AbstractDAO.ts:123</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Finds the values for the given propertyId, if it exists.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>propertyId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The propertyId to find the values for</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Some additional options. May be implementer dependent, such as limit, or value restrictions</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
<p>A promise containing the values.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="get" class="tsd-anchor"></a>
<h3>get</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>id<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"><</span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="abstractdao.html">AbstractDAO</a>.<a href="abstractdao.html#get">get</a></p>
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AlarmDAO.ts#L51">dao/AlarmDAO.ts:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Fetch an alarm.</p>
</div>
<dl class="tsd-comment-tags">
<dt>version</dt>
<dd><p>ReST v1+</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The alarm's ID.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a><span class="tsd-signature-symbol">></span></h4>
<p>An <a href="onmsalarm.html">OnmsAlarm</a>.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="getapiversion" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Api<wbr>Version</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">get<wbr>Api<wbr>Version<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="abstractdao.html">AbstractDAO</a>.<a href="abstractdao.html#getapiversion">getApiVersion</a></p>
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AbstractDAO.ts#L214">dao/AbstractDAO.ts:214</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve the API version from the currently configured server.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="getcount" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Count</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">get<wbr>Count<span class="tsd-signature-symbol">(</span>data<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="basedao.html">BaseDAO</a>.<a href="basedao.html#getcount">getCount</a></p>
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/BaseDAO.ts#L79">dao/BaseDAO.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A convenience method to make it easy for implementers to extract the count
(or totalCount) values from response data.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getdata" class="tsd-anchor"></a>
<h3>get<wbr>Data</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Data<span class="tsd-signature-symbol">(</span>result<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="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AlarmDAO.ts#L89">dao/AlarmDAO.ts:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Extracts the data from an HTTP Request result.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>result: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>the HTTP Request result.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a><span class="tsd-signature-symbol">[]</span></h4>
<p>An array of <a href="onmsalarm.html">OnmsAlarm</a> objects.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="getdetailspage" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr>Details<wbr>Page</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">get<wbr>Details<wbr>Page<span class="tsd-signature-symbol">(</span>alarm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AlarmDAO.ts#L533">dao/AlarmDAO.ts:533</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves the URL to the details page for the given alarm.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>alarm: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a></h5>
<div class="tsd-comment tsd-typography">
<p>The <a href="onmsalarm.html">OnmsAlarm</a> or alarm ID.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>URL on the associated OpenNMS server for the alarm details page.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getfilterprocessor" class="tsd-anchor"></a>
<h3>get<wbr>Filter<wbr>Processor</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Filter<wbr>Processor<span class="tsd-signature-symbol">(</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"><</span><a href="../interfaces/ifilterprocessor.html" class="tsd-signature-type">IFilterProcessor</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="abstractdao.html">AbstractDAO</a>.<a href="abstractdao.html#getfilterprocessor">getFilterProcessor</a></p>
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AbstractDAO.ts#L43">dao/AbstractDAO.ts:43</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the Promise for a <a href="../interfaces/ifilterprocessor.html">IFilterProcessor</a>.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ifilterprocessor.html" class="tsd-signature-type">IFilterProcessor</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getpropertiescache" class="tsd-anchor"></a>
<h3>get<wbr>Properties<wbr>Cache</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Properties<wbr>Cache<span class="tsd-signature-symbol">(</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"><</span><a href="propertiescache.html" class="tsd-signature-type">PropertiesCache</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="abstractdao.html">AbstractDAO</a>.<a href="abstractdao.html#getpropertiescache">getPropertiesCache</a></p>
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AbstractDAO.ts#L92">dao/AbstractDAO.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns or creates the <a href="propertiescache.html">PropertiesCache</a> for this dao.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="propertiescache.html" class="tsd-signature-type">PropertiesCache</a><span class="tsd-signature-symbol">></span></h4>
<p>the <a href="propertiescache.html">PropertiesCache</a> for this dao. It is created if it does not exist.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="parseresultlist" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> parse<wbr>Result<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">parse<wbr>Result<wbr>List<span class="tsd-signature-symbol">(</span>result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, dataFieldName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, mapCallbackFunction<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">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="abstractdao.html">AbstractDAO</a>.<a href="abstractdao.html#parseresultlist">parseResultList</a></p>
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AbstractDAO.ts#L152">dao/AbstractDAO.ts:152</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Fetches the data from the result and verfifes that the <code>dataFieldName</code> exists in the data property.
If it does not exist, an exception is thrown.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>result: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>The result to fetch the data from</p>
</div>
</li>
<li>
<h5>dataFieldName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The property name (basically <code>result.data[dataFieldName]</code>.</p>
</div>
</li>
<li>
<h5>path: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The path where the result was fetched from. This is for error handling</p>
</div>
</li>
<li>
<h5>mapCallbackFunction: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Callback function to convert each entry from <code>result.data[dataFieldName]</code>.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="savejournalmemo" class="tsd-anchor"></a>
<h3>save<wbr>Journal<wbr>Memo</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">save<wbr>Journal<wbr>Memo<span class="tsd-signature-symbol">(</span>alarm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="onmsalarm.html" class="tsd-signature-type">OnmsAlarm</a>, body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, user<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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AlarmDAO.ts#L293">dao/AlarmDAO.ts:293</a></li>