UNPKG

opennms

Version:

Client API for the OpenNMS network monitoring platform

804 lines 48.2 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>EventDAO | 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="eventdao.html">EventDAO</a> </li> </ul> <h1>Class EventDAO</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="onmsevent.html">OnmsEvent</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">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><a href="onmsevent.html" class="tsd-signature-type">OnmsEvent</a><span class="tsd-signature-symbol">&gt;</span> <ul class="tsd-hierarchy"> <li> <span class="target">EventDAO</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="eventdao.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="eventdao.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 tsd-is-overwrite"><a href="eventdao.html#find" class="tsd-kind-icon">find</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="eventdao.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="eventdao.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="eventdao.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="eventdao.html#getcount" class="tsd-kind-icon">get<wbr>Count</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="eventdao.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 tsd-is-protected"><a href="eventdao.html#getoptions" class="tsd-kind-icon">get<wbr>Options</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="eventdao.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="eventdao.html#parseresultlist" class="tsd-kind-icon">parse<wbr>Result<wbr>List</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="eventdao.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="eventdao.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="eventdao.html#searchpropertypath" class="tsd-kind-icon">search<wbr>Property<wbr>Path</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="eventdao.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="eventdao.html#tonumber" class="tsd-kind-icon">to<wbr>Number</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="eventdao.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>EventDAO<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="eventdao.html" class="tsd-signature-type">EventDAO</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/EventDAO.ts#L25">dao/EventDAO.ts:25</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="eventdao.html" class="tsd-signature-type">EventDAO</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 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">&lt;</span><a href="onmsevent.html" class="tsd-signature-type">OnmsEvent</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</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/EventDAO.ts#L40">dao/EventDAO.ts:40</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get an event, given a filter.</p> </div> </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> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmsevent.html" class="tsd-signature-type">OnmsEvent</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4> </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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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">&lt;</span><a href="onmsevent.html" class="tsd-signature-type">OnmsEvent</a><span class="tsd-signature-symbol">&gt;</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/EventDAO.ts#L31">dao/EventDAO.ts:31</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get an event, given the event&#39;s ID.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>id: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmsevent.html" class="tsd-signature-type">OnmsEvent</a><span class="tsd-signature-symbol">&gt;</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="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 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">&lt;</span><a href="../interfaces/ifilterprocessor.html" class="tsd-signature-type">IFilterProcessor</a><span class="tsd-signature-symbol">&gt;</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">&lt;</span><a href="../interfaces/ifilterprocessor.html" class="tsd-signature-type">IFilterProcessor</a><span class="tsd-signature-symbol">&gt;</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="getoptions" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Options</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>Options<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">&lt;</span><a href="onmshttpoptions.html" class="tsd-signature-type">OnmsHTTPOptions</a><span class="tsd-signature-symbol">&gt;</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#getoptions">getOptions</a></p> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AbstractDAO.ts#L173">dao/AbstractDAO.ts:173</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Create an <a href="onmshttpoptions.html">OnmsHTTPOptions</a> object for DAO calls given an optional filter.</p> </div> </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</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmshttpoptions.html" class="tsd-signature-type">OnmsHTTPOptions</a><span class="tsd-signature-symbol">&gt;</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">&lt;</span><a href="propertiescache.html" class="tsd-signature-type">PropertiesCache</a><span class="tsd-signature-symbol">&gt;</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">&lt;</span><a href="propertiescache.html" class="tsd-signature-type">PropertiesCache</a><span class="tsd-signature-symbol">&gt;</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 tsd-is-inherited"> <a name="searchproperties" class="tsd-anchor"></a> <h3>search<wbr>Properties</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">search<wbr>Properties<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">&lt;</span><a href="searchproperty.html" class="tsd-signature-type">SearchProperty</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</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#searchproperties">searchProperties</a></p> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AbstractDAO.ts#L70">dao/AbstractDAO.ts:70</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the list properties that can be used in queries.</p> </div> <dl class="tsd-comment-tags"> <dt>version</dt> <dd><p>ReST v2</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="searchproperty.html" class="tsd-signature-type">SearchProperty</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="searchproperty" class="tsd-anchor"></a> <h3>search<wbr>Property</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">search<wbr>Property<span class="tsd-signature-symbol">(</span>id<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><a href="searchproperty.html" class="tsd-signature-type">SearchProperty</a><span class="tsd-signature-symbol">&gt;</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#searchproperty">searchProperty</a></p> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/AbstractDAO.ts#L81">dao/AbstractDAO.ts:81</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets the property identified by the id if it exists.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>id: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The id to search the property by.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="searchproperty.html" class="tsd-signature-type">SearchProperty</a><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"> <a name="searchpropertypath" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> search<wbr>Property<wbr>Path</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">search<wbr>Property<wbr>Path<span class="tsd-signature-symbol">(</span><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"> <p>Overrides <a href="abstractdao.html">AbstractDAO</a>.<a href="abstractdao.html#searchpropertypath">searchPropertyPath</a></p> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/EventDAO.ts#L120">dao/EventDAO.ts:120</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The path to the event search properties endpoint.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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="todate" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> to<wbr>Date</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">to<wbr>Date<span class="tsd-signature-symbol">(</span>from<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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</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#todate">toDate</a></p> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/BaseDAO.ts#L96">dao/BaseDAO.ts:96</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Convert the given value to a date, or undefined if it cannot be converted.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>from: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Moment</span> <span class="tsd-signature-symbol"> | </span> <span class="tsd-signature-type">undefined</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="tonumber" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> to<wbr>Number</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">to<wbr>Number<span class="tsd-signature-symbol">(</span>from<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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</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#tonumber">toNumber</a></p> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/BaseDAO.ts#L106">dao/BaseDAO.ts:106</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Convert the given value to a number, or undefined if it cannot be converted.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>from: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol"> | </span> <span class="tsd-signature-type">undefined</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="usejson" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> use<wbr>Json</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">use<wbr>Json<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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#usejson">useJson</a></p> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/BaseDAO.ts#L68">dao/BaseDAO.ts:68</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether or not to use JSON when making ReST requests.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="eventdao.html" class="tsd-kind-icon">EventDAO</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a href="eventdao.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a href="eventdao.html#http" class="tsd-kind-icon">http</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a href="eventdao.html#find" class="tsd-kind-icon">find</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="eventdao.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="eventdao.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="eventdao.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="eventdao.html#getcount" class="tsd-kind-icon">get<wbr>Count</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="eventdao.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 tsd-is-protected"> <a href="eventdao.html#getoptions" class="tsd-kind-icon">get<wbr>Options</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="eventdao.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="eventdao.html#parseresultlist" class="tsd-kind-icon">parse<wbr>Result<wbr>List</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="eventdao.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="eventdao.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="eventdao.html#searchpropertypath" class="tsd-kind-icon">search<wbr>Property<wbr>Path</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a href="eventdao.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="eventdao.html#tonumber" class="tsd-kind-icon">to<wbr>Number</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a href="eventdao.html#usejson" class="tsd-kind-icon">use<wbr>Json</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-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <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> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>