opennms
Version:
Client API for the OpenNMS network monitoring platform
8 lines (7 loc) • 14.8 kB
HTML
<html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IHasUrlValue | 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/API.html">API</a></li><li><a href="API.IHasUrlValue.html">IHasUrlValue</a></li></ul><h1>Interface IHasUrlValue</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Interface for a class that has a URL value.</p>
<p>Any module implementing this interface should have a <code>urlValue</code> property
(ideally a property <code>get</code>ter) which represents how the object should be
represented when serialized to an OpenNMS URL parameter.</p>
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IHasUrlValue</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="API.IHasUrlValue.html#urlvalue">urlValue</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsAlarm.html" class="tsd-signature-type tsd-kind-class">OnmsAlarm</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsAlarmSummary.html" class="tsd-signature-type tsd-kind-class">OnmsAlarmSummary</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsAlarmType.html" class="tsd-signature-type tsd-kind-class">OnmsAlarmType</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsCategory.html" class="tsd-signature-type tsd-kind-class">OnmsCategory</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsCollectType.html" class="tsd-signature-type tsd-kind-class">OnmsCollectType</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsEvent.html" class="tsd-signature-type tsd-kind-class">OnmsEvent</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsIpInterface.html" class="tsd-signature-type tsd-kind-class">OnmsIpInterface</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsManagedType.html" class="tsd-signature-type tsd-kind-class">OnmsManagedType</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsMonitoredService.html" class="tsd-signature-type tsd-kind-class">OnmsMonitoredService</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsNode.html" class="tsd-signature-type tsd-kind-class">OnmsNode</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsNodeLabelSource.html" class="tsd-signature-type tsd-kind-class">OnmsNodeLabelSource</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsNodeType.html" class="tsd-signature-type tsd-kind-class">OnmsNodeType</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsOutage.html" class="tsd-signature-type tsd-kind-class">OnmsOutage</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsParm.html" class="tsd-signature-type tsd-kind-class">OnmsParm</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsPrimaryType.html" class="tsd-signature-type tsd-kind-class">OnmsPrimaryType</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsServiceStatusType.html" class="tsd-signature-type tsd-kind-class">OnmsServiceStatusType</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsServiceType.html" class="tsd-signature-type tsd-kind-class">OnmsServiceType</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsSeverity.html" class="tsd-signature-type tsd-kind-class">OnmsSeverity</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsSituationFeedback.html" class="tsd-signature-type tsd-kind-class">OnmsSituationFeedback</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsSituationFeedbackType.html" class="tsd-signature-type tsd-kind-class">OnmsSituationFeedbackType</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsSnmpInterface.html" class="tsd-signature-type tsd-kind-class">OnmsSnmpInterface</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsSnmpStatusType.html" class="tsd-signature-type tsd-kind-class">OnmsSnmpStatusType</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.OnmsTroubleTicketState.html" class="tsd-signature-type tsd-kind-class">OnmsTroubleTicketState</a></li><li><a href="../modules/Model.html" class="tsd-signature-type tsd-kind-namespace">Model</a><span class="tsd-signature-symbol">.</span><a href="../classes/Model.PhysAddr.html" class="tsd-signature-type tsd-kind-class">PhysAddr</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/api/IHasUrlValue.ts#L11">src/api/IHasUrlValue.ts:11</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">Properties</h3><div class="tsd-index-list"><a href="API.IHasUrlValue.html#urlvalue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>url<wbr/>Value</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-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="urlvalue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>url<wbr/>Value</span><a href="#urlvalue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">urlValue</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The value of this object when added to an OpenNMS URL parameter.</p>
</div><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/api/IHasUrlValue.ts#L13">src/api/IHasUrlValue.ts:13</a></li></ul></aside></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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#urlvalue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>url<wbr/>Value</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>