From 4adaf3b887a18ad4ce49d6622a2de52614d72aa3 Mon Sep 17 00:00:00 2001 From: CI/CD System Date: Fri, 5 Jan 2024 16:29:02 +0000 Subject: [PATCH] publish latest API docs --- docs/assets/main.js | 4 +- docs/assets/style.css | 50 +++++--- docs/classes/API.Clause.html | 10 +- docs/classes/API.Comparator.html | 22 ++-- docs/classes/API.Filter.html | 18 +-- docs/classes/API.Logger.html | 30 ++--- docs/classes/API.NestedRestriction.html | 14 +-- docs/classes/API.OnmsAuthConfig.html | 12 +- docs/classes/API.OnmsError.html | 20 ++-- docs/classes/API.OnmsHTTPOptions.html | 24 ++-- docs/classes/API.OnmsHTTPOptionsBuilder.html | 26 ++--- docs/classes/API.OnmsResult.html | 22 ++-- docs/classes/API.OnmsServer.html | 26 ++--- docs/classes/API.OnmsServerBuilder.html | 14 +-- docs/classes/API.OnmsVersion.html | 24 ++-- docs/classes/API.Operator.html | 22 ++-- docs/classes/API.Order.html | 22 ++-- docs/classes/API.OrderBy.html | 12 +- docs/classes/API.Restriction.html | 16 +-- docs/classes/API.SearchProperty.html | 18 +-- docs/classes/API.SearchPropertyType.html | 20 ++-- docs/classes/API.ServerMetadata.html | 46 ++++---- docs/classes/API.ServerType.html | 16 +-- docs/classes/API.TicketerConfig.html | 12 +- docs/classes/Client.html | 32 ++--- docs/classes/DAO.AlarmDAO.html | 110 +++++++++--------- docs/classes/DAO.EventDAO.html | 50 ++++---- docs/classes/DAO.FlowDAO.html | 64 +++++----- docs/classes/DAO.IpInterfaceDAO.html | 50 ++++---- docs/classes/DAO.MonitoredServiceDAO.html | 50 ++++---- docs/classes/DAO.NodeDAO.html | 60 +++++----- docs/classes/DAO.OutageDAO.html | 50 ++++---- docs/classes/DAO.SituationFeedbackDAO.html | 32 ++--- docs/classes/DAO.SnmpInterfaceDAO.html | 50 ++++---- docs/classes/DAO.V1FilterProcessor.html | 4 +- docs/classes/DAO.V2FilterProcessor.html | 24 ++-- docs/classes/Model.OnmsAlarm.html | 74 ++++++------ docs/classes/Model.OnmsAlarmSummary.html | 18 +-- docs/classes/Model.OnmsAlarmType.html | 18 +-- docs/classes/Model.OnmsCategory.html | 12 +- docs/classes/Model.OnmsCollectType.html | 24 ++-- docs/classes/Model.OnmsEvent.html | 40 +++---- docs/classes/Model.OnmsFlowExporter.html | 14 +-- .../Model.OnmsFlowExporterSummary.html | 12 +- docs/classes/Model.OnmsFlowSeries.html | 12 +- docs/classes/Model.OnmsFlowSeriesColumn.html | 8 +- docs/classes/Model.OnmsFlowSnmpInterface.html | 10 +- docs/classes/Model.OnmsFlowTable.html | 12 +- docs/classes/Model.OnmsIpInterface.html | 34 +++--- docs/classes/Model.OnmsManagedType.html | 24 ++-- docs/classes/Model.OnmsMemo.html | 12 +- docs/classes/Model.OnmsMonitoredService.html | 20 ++-- docs/classes/Model.OnmsNode.html | 48 ++++---- docs/classes/Model.OnmsNodeLabelSource.html | 22 ++-- docs/classes/Model.OnmsNodeType.html | 22 ++-- docs/classes/Model.OnmsOutage.html | 32 ++--- docs/classes/Model.OnmsParm.html | 16 +-- docs/classes/Model.OnmsPrimaryType.html | 24 ++-- docs/classes/Model.OnmsServiceStatusType.html | 24 ++-- docs/classes/Model.OnmsServiceType.html | 12 +- docs/classes/Model.OnmsSeverity.html | 18 +-- docs/classes/Model.OnmsSituationFeedback.html | 22 ++-- .../Model.OnmsSituationFeedbackType.html | 22 ++-- docs/classes/Model.OnmsSnmpInterface.html | 38 +++--- docs/classes/Model.OnmsSnmpStatusType.html | 22 ++-- .../classes/Model.OnmsTroubleTicketState.html | 18 +-- docs/classes/Model.PhysAddr.html | 10 +- docs/classes/Rest.AbstractHTTP.html | 34 +++--- docs/classes/Rest.AxiosHTTP.html | 38 +++--- docs/classes/Rest.GrafanaError.html | 16 +-- docs/classes/Rest.GrafanaHTTP.html | 34 +++--- docs/classes/Rest.JsonTransformer.html | 4 +- docs/classes/Rest.XmlTransformer.html | 4 +- docs/hierarchy.html | 1 + docs/index.html | 2 +- docs/interfaces/API.IFilterProcessor.html | 4 +- docs/interfaces/API.IFilterVisitor.html | 16 ++- docs/interfaces/API.IHasHTTP.html | 4 +- docs/interfaces/API.IHasUrlValue.html | 4 +- docs/interfaces/API.IHash.html | 4 +- docs/interfaces/API.IOnmsHTTP.html | 26 ++--- docs/interfaces/DAO.ITopNOptions.html | 16 +-- docs/interfaces/DAO.IValueProvider.html | 8 +- docs/modules.html | 2 +- docs/modules/API.html | 4 +- docs/modules/DAO.html | 4 +- docs/modules/Model.html | 4 +- docs/modules/Rest.html | 4 +- docs/variables/API.Comparators.html | 2 +- docs/variables/API.Operators.html | 2 +- docs/variables/API.Orders.html | 2 +- docs/variables/API.SearchPropertyTypes.html | 2 +- docs/variables/API.ServerTypes.html | 2 +- docs/variables/API.log.html | 2 +- docs/variables/Model.AlarmTypes.html | 2 +- docs/variables/Model.CollectTypes.html | 2 +- docs/variables/Model.FeedbackTypes.html | 2 +- docs/variables/Model.ManagedTypes.html | 2 +- docs/variables/Model.NodeLabelSources.html | 2 +- docs/variables/Model.NodeTypes.html | 2 +- docs/variables/Model.PrimaryTypes.html | 2 +- docs/variables/Model.ServiceStatusTypes.html | 2 +- docs/variables/Model.Severities.html | 2 +- docs/variables/Model.SnmpStatusTypes.html | 2 +- docs/variables/Model.TroubleTicketStates.html | 2 +- 105 files changed, 1033 insertions(+), 1004 deletions(-) create mode 100644 docs/hierarchy.html diff --git a/docs/assets/main.js b/docs/assets/main.js index d0aa8d5f9a..7270cff8dc 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,8 +1,8 @@ "use strict"; "use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. `,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var Z=class extends C{constructor(n){super(n);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(B,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.handleValueChange()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(e=>{e.style.display="block";let n=Array.from(e.querySelectorAll(".tsd-index-link")).every(r=>r.offsetParent==null);e.style.display=n?"none":"block"})}};var Z=class extends C{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/style.css b/docs/assets/style.css index 07a385b731..98a4377942 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -29,7 +29,7 @@ --light-color-ts-constructor-signature: var(--light-color-ts-constructor); --light-color-ts-parameter: var(--light-color-ts-variable); /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: var(--light-color-ts-type-alias); + --light-color-ts-type-parameter: #a55c0e; --light-color-ts-accessor: var(--light-color-ts-property); --light-color-ts-get-signature: var(--light-color-ts-accessor); --light-color-ts-set-signature: var(--light-color-ts-accessor); @@ -69,7 +69,7 @@ --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); --dark-color-ts-parameter: var(--dark-color-ts-variable); /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); + --dark-color-ts-type-parameter: #e07d13; --dark-color-ts-accessor: var(--dark-color-ts-property); --dark-color-ts-get-signature: var(--dark-color-ts-accessor); --dark-color-ts-set-signature: var(--dark-color-ts-accessor); @@ -266,12 +266,12 @@ h6 { line-height: 1.2; } -h1 > a, -h2 > a, -h3 > a, -h4 > a, -h5 > a, -h6 > a { +h1 > a:not(.link), +h2 > a:not(.link), +h3 > a:not(.link), +h4 > a:not(.link), +h5 > a:not(.link), +h6 > a:not(.link) { text-decoration: none; color: var(--color-text); } @@ -649,6 +649,28 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { font-weight: bold; } +.tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + .tsd-panel-group.tsd-index-group { margin-bottom: 0; } @@ -714,12 +736,15 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { } .tsd-navigation > a, .tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.5rem); + width: calc(100% - 0.25rem); + display: flex; + align-items: center; } .tsd-navigation a, .tsd-navigation summary > span, .tsd-page-navigation a { - display: inline-flex; + display: flex; + width: calc(100% - 0.25rem); align-items: center; padding: 0.25rem; color: var(--color-text); @@ -759,11 +784,6 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { margin-left: -1.5rem; } -.tsd-nested-navigation > li > a, -.tsd-nested-navigation > li > span { - width: calc(100% - 1.75rem - 0.5rem); -} - .tsd-page-navigation ul { padding-left: 1.75rem; } diff --git a/docs/classes/API.Clause.html b/docs/classes/API.Clause.html index 517a0a333f..ecdf7ace05 100644 --- a/docs/classes/API.Clause.html +++ b/docs/classes/API.Clause.html @@ -1,9 +1,9 @@ Clause | OpenNMS.js - v2.5.9-SNAPSHOT

Class Clause

A restriction and boolean operator pair.

-

Constructors

constructor +

Constructors

constructor

Properties

operator restriction

Methods

fromJson -

Constructors

constructor

Properties

operator

operator: Operator

The boolean operator to apply.

-

restriction

restriction: Restriction | NestedRestriction

The associated restriction.

-

Methods

Static fromJson

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

operator

operator: Operator

The boolean operator to apply.

+

restriction

restriction: Restriction | NestedRestriction

The associated restriction.

+

Methods

Static fromJson

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/API.Comparator.html b/docs/classes/API.Comparator.html index 4dd51abafa..18e45e1d6e 100644 --- a/docs/classes/API.Comparator.html +++ b/docs/classes/API.Comparator.html @@ -1,5 +1,5 @@ Comparator | OpenNMS.js - v2.5.9-SNAPSHOT

Class Comparator

Represents a filter comparator.

-

Hierarchy

  • OnmsEnum<number>
    • Comparator

Constructors

constructor +

Hierarchy

  • OnmsEnum<number>
    • Comparator

Constructors

constructor

Properties

aliases

Accessors

id index @@ -9,13 +9,13 @@ toJSON toString find -

Constructors

constructor

Properties

Private aliases

aliases: string[] = ...

Aliases for the command-line.

-

Accessors

id

index

label

Methods

matches

  • matches(comparator): boolean

  • Whether this comparator matches the given comparator string.

    -

    Parameters

    • comparator: string

    Returns boolean

toDisplayString

  • toDisplayString(): string

  • convert this enum to a string suitable for display

    -

    Returns string

toJSON

  • toJSON(): {
        id: number;
        label: string;
    }

  • convert to the JSON representation

    -

    Returns {
        id: number;
        label: string;
    }

    • id: number
    • label: string

toString

Static find

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private aliases

aliases: string[] = ...

Aliases for the command-line.

+

Accessors

id

index

label

Methods

matches

  • matches(comparator): boolean

  • Whether this comparator matches the given comparator string.

    +

    Parameters

    • comparator: string

    Returns boolean

toDisplayString

  • toDisplayString(): string

  • convert this enum to a string suitable for display

    +

    Returns string

toJSON

  • toJSON(): {
        id: number;
        label: string;
    }

  • convert to the JSON representation

    +

    Returns {
        id: number;
        label: string;
    }

    • id: number
    • label: string

toString

Static find

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/API.Filter.html b/docs/classes/API.Filter.html index 2d07e9098d..238e25ec9e 100644 --- a/docs/classes/API.Filter.html +++ b/docs/classes/API.Filter.html @@ -1,5 +1,5 @@ Filter | OpenNMS.js - v2.5.9-SNAPSHOT

Class Filter

A query filter for DAOs.

-

Hierarchy

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

clauses limit orderBy @@ -7,11 +7,11 @@ withOrRestriction withOrderBy fromJson -

Constructors

constructor

Properties

clauses

clauses: Clause[]

The clauses containing the nested restrictions and their logical operators.

-

limit

limit: number = 1000

how many results to get back by default

-

orderBy

orderBy: OrderBy[] = []

how to sort results

-

Methods

withAndRestriction

withOrRestriction

withOrderBy

Static fromJson

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

clauses

clauses: Clause[]

The clauses containing the nested restrictions and their logical operators.

+

limit

limit: number = 1000

how many results to get back by default

+

orderBy

orderBy: OrderBy[] = []

how to sort results

+

Methods

withAndRestriction

withOrRestriction

withOrderBy

Static fromJson

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/API.Logger.html b/docs/classes/API.Logger.html index d2deab7a6c..b7c7eb2419 100644 --- a/docs/classes/API.Logger.html +++ b/docs/classes/API.Logger.html @@ -1,5 +1,5 @@ Logger | OpenNMS.js - v2.5.9-SNAPSHOT

Class Logger

Simple logger used for both CLI and browser use.

-

Constructors

constructor +

Constructors

constructor

Properties

impl

Methods

clear debug @@ -13,24 +13,24 @@ setSilent trace warn -

Constructors

constructor

Properties

Private impl

impl: Console = console

The actual "console" implementation to use.

-

Methods

clear

debug

  • debug(...parms): void

  • Normal debug logging. Enabled only if debug is enabled.

    +

Constructors

constructor

Properties

Private impl

impl: Console = console

The actual "console" implementation to use.

+

Methods

clear

debug

  • debug(...parms): void

  • Normal debug logging. Enabled only if debug is enabled.

    Parameters

    • Rest ...parms: any[]

      logging parameters

      -

    Returns void

error

  • error(...parms): void

  • Error logging. Enabled unless in silent mode.

    +

Returns void

error

  • error(...parms): void

  • Error logging. Enabled unless in silent mode.

    Parameters

    • Rest ...parms: any[]

      logging parameters

      -

    Returns void

fatal

  • fatal(...parms): void

  • "Fatal" logging. Enabled unless in silent mode.

    +

Returns void

fatal

  • fatal(...parms): void

  • "Fatal" logging. Enabled unless in silent mode.

    Parameters

    • Rest ...parms: any[]

      logging parameters

      -

    Returns void

info

  • info(...parms): void

  • Info logging. Enabled by default.

    +

Returns void

info

  • info(...parms): void

  • Info logging. Enabled by default.

    Parameters

    • Rest ...parms: any[]

      logging parameters

      -

    Returns void

log

  • log(...parms): void

  • Standard console logging.

    +

Returns void

log

  • log(...parms): void

  • Standard console logging.

    Parameters

    • Rest ...parms: any[]

      logging parameters

      -

    Returns void

setDebug

setInfo

setQuiet

  • setQuiet(): void

  • Turn off all logging other than error.

    -

    Returns void

setSilent

trace

  • trace(...parms): void

  • Chatty debug logging. Enabled only if debug is enabled.

    +

Returns void

setDebug

setInfo

setQuiet

  • setQuiet(): void

  • Turn off all logging other than error.

    +

    Returns void

setSilent

trace

  • trace(...parms): void

  • Chatty debug logging. Enabled only if debug is enabled.

    Parameters

    • Rest ...parms: any[]

      logging parameters

      -

    Returns void

warn

  • warn(...parms): void

  • Warning logging. Enabled by default.

    +

Returns void

warn

  • warn(...parms): void

  • Warning logging. Enabled by default.

    Parameters

    • Rest ...parms: any[]

      logging parameters

      -

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/API.NestedRestriction.html b/docs/classes/API.NestedRestriction.html index c81b4a5082..6da3f1e236 100644 --- a/docs/classes/API.NestedRestriction.html +++ b/docs/classes/API.NestedRestriction.html @@ -1,13 +1,13 @@ NestedRestriction | OpenNMS.js - v2.5.9-SNAPSHOT

Class NestedRestriction

Nested query restrictions.

-

Hierarchy

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

clauses

Methods

withAndRestriction withClause withOrRestriction fromJson -

Constructors

constructor

Properties

clauses

clauses: Clause[]

The clauses containing the nested restrictions and their logical operators.

-

Methods

withAndRestriction

Private withClause

withOrRestriction

Static fromJson

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

clauses

clauses: Clause[]

The clauses containing the nested restrictions and their logical operators.

+

Methods

withAndRestriction

Private withClause

withOrRestriction

Static fromJson

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/API.OnmsAuthConfig.html b/docs/classes/API.OnmsAuthConfig.html index 600983d741..3df8ed9332 100644 --- a/docs/classes/API.OnmsAuthConfig.html +++ b/docs/classes/API.OnmsAuthConfig.html @@ -1,12 +1,12 @@ OnmsAuthConfig | OpenNMS.js - v2.5.9-SNAPSHOT

Class OnmsAuthConfig

Represents server authentication config.

-

Constructors

constructor +

Constructors

constructor

Properties

password username

Methods

clone equals

Constructors

constructor

Properties

Readonly password

password: string

The password to authenticate with.

-

Readonly username

username: string

The username to connect as.

-

Methods

clone

equals

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • Optional username: string
  • Optional password: string

Returns OnmsAuthConfig

Properties

Readonly password

password: string

The password to authenticate with.

+

Readonly username

username: string

The username to connect as.

+

Methods

clone

equals

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/API.OnmsError.html b/docs/classes/API.OnmsError.html index 6f27e7f377..306781ba5c 100644 --- a/docs/classes/API.OnmsError.html +++ b/docs/classes/API.OnmsError.html @@ -1,5 +1,5 @@ OnmsError | OpenNMS.js - v2.5.9-SNAPSHOT

Class OnmsError

Represents an OpenNMS.js error.

-

Hierarchy

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

data message name @@ -13,11 +13,13 @@

Constructors

constructor

  • new OnmsError(message, code?, options?, data?): OnmsError

  • Create a new error.

    Parameters

    • message: string

      The error message.

    • Optional code: number

      An optional error code to associate with the error.

      -
    • Optional options: any
    • Optional data: any

    Returns OnmsError

Properties

Private Readonly data

data: any

The data (payload) associated with a response.

-

message

message: string

name

name: string

Private Readonly options

options: any

The options provided as part of the request that resulted in this erro.

-

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

code

Methods

toString

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +
  • Optional options: any
  • Optional data: any

    • Returns OnmsError

    Properties

    Private Readonly data

    data: any

    The data (payload) associated with a response.

    +

    message

    message: string

    name

    name: string

    Private Readonly options

    options: any

    The options provided as part of the request that resulted in this erro.

    +

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Type declaration

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    +

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    code

    Methods

    toString

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      +

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/API.OnmsHTTPOptions.html b/docs/classes/API.OnmsHTTPOptions.html index c0d10c9d51..a45aa9a245 100644 --- a/docs/classes/API.OnmsHTTPOptions.html +++ b/docs/classes/API.OnmsHTTPOptions.html @@ -1,5 +1,5 @@ OnmsHTTPOptions | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsHTTPOptions

    Options to be used when making HTTP ReST calls.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    [AUTH_PROP] [TIMEOUT_PROP] data @@ -11,19 +11,19 @@

    Methods

    toJSON newBuilder

    Constructors

    constructor

    Properties

    Private Readonly [AUTH_PROP]

    [AUTH_PROP]: OnmsAuthConfig

    The default authentication credentials associated with these options.

    +

    Parameters

    • Optional timeout: number
    • Optional server: OnmsServer
    • Optional auth: OnmsAuthConfig
    • Optional headers: IHash<string>
    • Optional parameters: IHash<string | string[]>
    • Optional data: any

    Returns OnmsHTTPOptions

    Properties

    Private Readonly [AUTH_PROP]

    [AUTH_PROP]: OnmsAuthConfig

    The default authentication credentials associated with these options.

    This is a trick for making sure serialization to JSON happens properly without exposing internals.

    -

    Private Readonly [TIMEOUT_PROP]

    [TIMEOUT_PROP]: number

    The default timeout associated with these options.

    +

    Private Readonly [TIMEOUT_PROP]

    [TIMEOUT_PROP]: number

    The default timeout associated with these options.

    This is a trick for making sure serialization to JSON happens properly without exposing internals.

    -

    Readonly data

    data: any

    HTTP data to be passed when POSTing

    -

    Readonly headers

    headers: IHash<string> = ...

    HTTP headers to be passed to the request.

    -

    Readonly parameters

    parameters: IHash<string | string[]> = ...

    HTTP parameters to be passed on the URL.

    -

    Readonly server

    server: OnmsServer

    The server to use instead of that provided by the HTTP implementation.

    -

    Accessors

    auth

    timeout

    Methods

    toJSON

    Static newBuilder

    Readonly data

    data: any

    HTTP data to be passed when POSTing

    +

    Readonly headers

    headers: IHash<string> = ...

    HTTP headers to be passed to the request.

    +

    Readonly parameters

    parameters: IHash<string | string[]> = ...

    HTTP parameters to be passed on the URL.

    +

    Readonly server

    server: OnmsServer

    The server to use instead of that provided by the HTTP implementation.

    +

    Accessors

    auth

    timeout

    Methods

    toJSON

    Static newBuilder

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns OnmsHTTPOptionsBuilder

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/API.OnmsHTTPOptionsBuilder.html b/docs/classes/API.OnmsHTTPOptionsBuilder.html index 6ea8e9c9dc..37e430206a 100644 --- a/docs/classes/API.OnmsHTTPOptionsBuilder.html +++ b/docs/classes/API.OnmsHTTPOptionsBuilder.html @@ -1,5 +1,5 @@ OnmsHTTPOptionsBuilder | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsHTTPOptionsBuilder

    A builder for [[OnmsHTTPOptions]]. Create a new one with [[OnmsHTTPOptions.newBuilder]].

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    addParameter build merge @@ -14,41 +14,41 @@

    Constructors

    constructor

    Methods

    addParameter

    Methods

    addParameter

    • addParameter(parameter, value?): OnmsHTTPOptionsBuilder

    • A parameter to add or append to the request.

      If undefined is passed, that parameter will be reset to defaults. If the value is a string array, the existing value in the builder will be replaced. Otherwise, if the parameter already exists in the builder, the parameter will be converted to an array if necessary and this parameter will be added to it.

      Parameters

      • parameter: string

        the parameter name

      • Optional value: string | number | boolean | string[]

        the value of the parameter to add (or undefined)

        -

      Returns OnmsHTTPOptionsBuilder

    build

    merge

    • merge(options?): OnmsHTTPOptionsBuilder

    • Merge the contents of the provided [[OnmsHTTPOptions]] object, additively. +

    Returns OnmsHTTPOptionsBuilder

    build

    merge

    setAuth

    Returns OnmsHTTPOptionsBuilder

    setAuth

    setData

    Returns OnmsHTTPOptionsBuilder

    setData

    setDefaultHeader

    • setDefaultHeader(header, value): OnmsHTTPOptionsBuilder

    • A header to set in the request only if it is not already set.

      +

    Returns OnmsHTTPOptionsBuilder

    setDefaultHeader

    setHeader

    Returns OnmsHTTPOptionsBuilder

    setHeader

    setHeaders

    Returns OnmsHTTPOptionsBuilder

    setHeaders

    setParameters

    Returns OnmsHTTPOptionsBuilder

    setParameters

    setServer

    Returns OnmsHTTPOptionsBuilder

    setServer

    setTimeout

    Returns OnmsHTTPOptionsBuilder

    setTimeout

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns OnmsHTTPOptionsBuilder

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/API.OnmsResult.html b/docs/classes/API.OnmsResult.html index c99eff6366..4e98ebdbb1 100644 --- a/docs/classes/API.OnmsResult.html +++ b/docs/classes/API.OnmsResult.html @@ -1,5 +1,5 @@ OnmsResult | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsResult<T>

    An [[IOnmsHTTP]] query result.

    -

    Type Parameters

    • T

    Constructors

    constructor +

    Type Parameters

    • T

    Constructors

    constructor

    Properties

    code? data message? @@ -7,16 +7,16 @@

    Methods

    isSuccess noContent ok -

    Constructors

    constructor

    • new OnmsResult<T>(data, message?, code?, type?): OnmsResult<T>

    • Construct a new result.

      -

      Type Parameters

      • T

      Parameters

      • data: T

        The payload of the response.

        +

    Constructors

    constructor

    • new OnmsResult<T>(data, message?, code?, type?): OnmsResult<T>

    • Construct a new result.

      +

      Type Parameters

      • T

      Parameters

      • data: T

        The payload of the response.

      • Optional message: string

        The status message associated with the result.

      • Optional code: number

        The response code of the response.

      • Optional type: string

        The request type of the response.

        -

      Returns OnmsResult<T>

    Properties

    Optional Readonly code

    code?: number

    The response code associated with this result.

    -

    Readonly data

    data: T

    The data, if any.

    -

    Optional Readonly message

    message?: string

    The status message associated with this result.

    -

    Optional Readonly type

    type?: string

    The request type, if any.

    -

    Methods

    isSuccess

    Static noContent

    Static ok

    • ok(response, message?, code?, type?): OnmsResult<any>

    • Create a new success result.

      -

      Parameters

      • response: any
      • Optional message: string
      • Optional code: number
      • Optional type: string

      Returns OnmsResult<any>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns OnmsResult<T>

    Properties

    Optional Readonly code

    code?: number

    The response code associated with this result.

    +

    Readonly data

    data: T

    The data, if any.

    +

    Optional Readonly message

    message?: string

    The status message associated with this result.

    +

    Optional Readonly type

    type?: string

    The request type, if any.

    +

    Methods

    isSuccess

    Static noContent

    Static ok

    • ok(response, message?, code?, type?): OnmsResult<any>

    • Create a new success result.

      +

      Parameters

      • response: any
      • Optional message: string
      • Optional code: number
      • Optional type: string

      Returns OnmsResult<any>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/API.OnmsServer.html b/docs/classes/API.OnmsServer.html index b6eb9853e5..08bad9c3a8 100644 --- a/docs/classes/API.OnmsServer.html +++ b/docs/classes/API.OnmsServer.html @@ -1,5 +1,5 @@ OnmsServer | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsServer

    Represents a remote OpenNMS server.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    auth id metadata @@ -15,18 +15,18 @@

    Parameters

    Returns OnmsServer

    Example

    provide a pre-existing [[OnmsAuthConfig]] for auth ```javascript const server = new OnmsServer('Test', 'https://myserver/opennms/', auth); -```

    Properties

    Readonly auth

    auth: OnmsAuthConfig

    The authorization configuration associated with the server.

    -

    Readonly id

    id: string

    A unique identifier for this server.

    -

    Readonly metadata

    metadata: ServerMetadata

    The capabilities of the server

    -

    Optional Readonly name

    name?: string

    An optional name associated with this server.

    -

    Readonly url

    url: string

    The base URL to the server.

    -

    Accessors

    host

    • get host(): any

    • Get the hostname portion of the URL associated with this server.

      -

      Returns any

    Methods

    clone

    equals

    • equals(that?): boolean

    • Check whether the provided server has the same settings as this one.

      -

      Parameters

      Returns boolean

    resolveURL

    • resolveURL(forFragment?, withQuery?): any

    • Given a relative URL fragment, construct a URL for that fragment on the server.

      +```

    Properties

    Readonly auth

    auth: OnmsAuthConfig

    The authorization configuration associated with the server.

    +

    Readonly id

    id: string

    A unique identifier for this server.

    +

    Readonly metadata

    metadata: ServerMetadata

    The capabilities of the server

    +

    Optional Readonly name

    name?: string

    An optional name associated with this server.

    +

    Readonly url

    url: string

    The base URL to the server.

    +

    Accessors

    host

    • get host(): any

    • Get the hostname portion of the URL associated with this server.

      +

      Returns any

    Methods

    clone

    equals

    • equals(that?): boolean

    • Check whether the provided server has the same settings as this one.

      +

      Parameters

      Returns boolean

    resolveURL

    • resolveURL(forFragment?, withQuery?): any

    • Given a relative URL fragment, construct a URL for that fragment on the server.

      Parameters

      • Optional forFragment: string

        The URL fragment to append to the server URL.

      • Optional withQuery: any

      Returns any

      A complete URL.

      Parm

      withQuery - Query parameters to be appended to the URL.

      -

    toString

    • toString(): string

    • A string representation of this server suitable for display.

      -

      Returns string

    Static newBuilder

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    toString

    • toString(): string

    • A string representation of this server suitable for display.

      +

      Returns string

    Static newBuilder

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/API.OnmsServerBuilder.html b/docs/classes/API.OnmsServerBuilder.html index 701cbf5d4b..95866aee40 100644 --- a/docs/classes/API.OnmsServerBuilder.html +++ b/docs/classes/API.OnmsServerBuilder.html @@ -1,5 +1,5 @@ OnmsServerBuilder | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsServerBuilder

    A builder for [[OnmsServer]]. Create a new one with [[OnmsServer.newBuilder]].

    -

    Constructors

    constructor +

    Constructors

    constructor

    Accessors

    auth metadata name @@ -10,17 +10,17 @@ setName setUrl

    Constructors

    constructor

    Accessors

    auth

    metadata

    name

    url

    Methods

    build

    setAuth

    Accessors

    auth

    metadata

    name

    url

    Methods

    build

    setAuth

    setMetadata

    • setMetadata(metadata?): OnmsServerBuilder

    • The server metadata to associate with the server.

      +

    Returns OnmsServerBuilder

    setMetadata

    setName

    Returns OnmsServerBuilder

    setName

    setUrl

    Returns OnmsServerBuilder

    setUrl

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns OnmsServerBuilder

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/API.OnmsVersion.html b/docs/classes/API.OnmsVersion.html index c8f09a1902..fa34d588bb 100644 --- a/docs/classes/API.OnmsVersion.html +++ b/docs/classes/API.OnmsVersion.html @@ -1,5 +1,5 @@ OnmsVersion | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsVersion

    An OpenNMS version.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    version

    Accessors

    displayVersion

    Methods

    clone @@ -14,14 +14,14 @@

    Parameters

    • Optional version: string

      The numeric version.

    • Optional displayVersion: string

      The full display version (including extra designators like x.x.x-SNAPSHOT).

      -

    Returns OnmsVersion

    Properties

    Readonly version

    version: string

    The numeric version (ex: 19.0.0).

    -

    Accessors

    displayVersion

    Methods

    clone

    eq

    • eq(compare?): boolean

    • Returns true if this version is equal to the passed version.

      -

      Parameters

      • compare: string = '0.0.0'

      Returns boolean

    equals

    ge

    • ge(compare?): boolean

    • Returns true if this version is greater than or equal to the passed version.

      -

      Parameters

      • compare: string = '0.0.0'

      Returns boolean

    gt

    • gt(compare?): boolean

    • Returns true if this version is greater than the passed version.

      -

      Parameters

      • compare: string = '0.0.0'

      Returns boolean

    le

    • le(compare?): boolean

    • Returns true if this version is less than or equal to the passed version.

      -

      Parameters

      • compare: string = '0.0.0'

      Returns boolean

    lt

    • lt(compare?): boolean

    • Returns true if this version is less than the passed version.

      -

      Parameters

      • compare: string = '0.0.0'

      Returns boolean

    toString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns OnmsVersion

    Properties

    Readonly version

    version: string

    The numeric version (ex: 19.0.0).

    +

    Accessors

    displayVersion

    Methods

    clone

    eq

    • eq(compare?): boolean

    • Returns true if this version is equal to the passed version.

      +

      Parameters

      • compare: string = '0.0.0'

      Returns boolean

    equals

    ge

    • ge(compare?): boolean

    • Returns true if this version is greater than or equal to the passed version.

      +

      Parameters

      • compare: string = '0.0.0'

      Returns boolean

    gt

    • gt(compare?): boolean

    • Returns true if this version is greater than the passed version.

      +

      Parameters

      • compare: string = '0.0.0'

      Returns boolean

    le

    • le(compare?): boolean

    • Returns true if this version is less than or equal to the passed version.

      +

      Parameters

      • compare: string = '0.0.0'

      Returns boolean

    lt

    • lt(compare?): boolean

    • Returns true if this version is less than the passed version.

      +

      Parameters

      • compare: string = '0.0.0'

      Returns boolean

    toString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/API.Operator.html b/docs/classes/API.Operator.html index a5f04773c1..2cc5e92a3d 100644 --- a/docs/classes/API.Operator.html +++ b/docs/classes/API.Operator.html @@ -1,5 +1,5 @@ Operator | OpenNMS.js - v2.5.9-SNAPSHOT

    Class Operator

    Represents a filter comparator.

    -

    Hierarchy

    • OnmsEnum<number>
      • Operator

    Constructors

    constructor +

    Hierarchy

    • OnmsEnum<number>
      • Operator

    Constructors

    constructor

    Properties

    aliases

    Accessors

    id index @@ -9,13 +9,13 @@ toJSON toString forLabel -

    Constructors

    constructor

    • new Operator(id, label, ...aliases): Operator

    • Parameters

      • id: number
      • label: string
      • Rest ...aliases: string[]

      Returns Operator

    Properties

    Private Readonly aliases

    aliases: string[] = ...

    Aliases for the command-line.

    -

    Accessors

    id

    index

    label

    Methods

    matches

    • matches(comparator): boolean

    • Whether this comparator matches the given comparator string.

      -

      Parameters

      • comparator: string

      Returns boolean

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      -

      Returns string

    toJSON

    • toJSON(): {
          id: number;
          label: string;
      }

    • convert to the JSON representation

      -

      Returns {
          id: number;
          label: string;
      }

      • id: number
      • label: string

    toString

    Static forLabel

    • forLabel(label): any

    • Given a label ('and', 'or'), return the corresponding operator.

      -

      Parameters

      • label: string

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    • new Operator(id, label, ...aliases): Operator

    • Parameters

      • id: number
      • label: string
      • Rest ...aliases: string[]

      Returns Operator

    Properties

    Private Readonly aliases

    aliases: string[] = ...

    Aliases for the command-line.

    +

    Accessors

    id

    index

    label

    Methods

    matches

    • matches(comparator): boolean

    • Whether this comparator matches the given comparator string.

      +

      Parameters

      • comparator: string

      Returns boolean

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      +

      Returns string

    toJSON

    • toJSON(): {
          id: number;
          label: string;
      }

    • convert to the JSON representation

      +

      Returns {
          id: number;
          label: string;
      }

      • id: number
      • label: string

    toString

    Static forLabel

    • forLabel(label): any

    • Given a label ('and', 'or'), return the corresponding operator.

      +

      Parameters

      • label: string

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/API.Order.html b/docs/classes/API.Order.html index 480c0c2cac..d905ab2775 100644 --- a/docs/classes/API.Order.html +++ b/docs/classes/API.Order.html @@ -1,5 +1,5 @@ Order | OpenNMS.js - v2.5.9-SNAPSHOT

    Class Order

    Represents a sort order.

    -

    Hierarchy

    • OnmsEnum<string>
      • Order

    Constructors

    constructor +

    Hierarchy

    • OnmsEnum<string>
      • Order

    Constructors

    constructor

    Accessors

    id index label @@ -10,13 +10,13 @@ forLabel fromString

    Constructors

    constructor

    • new Order(id, label): Order

    • construct an enum object with an id and label

      -

      Parameters

      • id: string
      • label: string

      Returns Order

    Accessors

    id

    index

    label

    Methods

    matches

    • matches(label): boolean

    • Whether this order matches the given order string.

      -

      Parameters

      • label: string

      Returns boolean

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      -

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      -

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forLabel

    • forLabel(label): any

    • Given a label ('ASC', 'DESC'), return the corresponding order.

      -

      Parameters

      • label: string

      Returns any

    Static fromString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • id: string
    • label: string

    Returns Order

    Accessors

    id

    index

    label

    Methods

    matches

    • matches(label): boolean

    • Whether this order matches the given order string.

      +

      Parameters

      • label: string

      Returns boolean

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      +

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      +

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forLabel

    • forLabel(label): any

    • Given a label ('ASC', 'DESC'), return the corresponding order.

      +

      Parameters

      • label: string

      Returns any

    Static fromString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/API.OrderBy.html b/docs/classes/API.OrderBy.html index d3f0e6e7b2..2f62254bbe 100644 --- a/docs/classes/API.OrderBy.html +++ b/docs/classes/API.OrderBy.html @@ -1,11 +1,11 @@ OrderBy | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OrderBy

    Column ordering.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    attribute order

    Methods

    fromJson fromString -

    Constructors

    constructor

    Properties

    Readonly attribute

    attribute: string

    the attribute to order by

    -

    Readonly order

    order: Order

    the order to sort

    -

    Methods

    Static fromJson

    Static fromString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly attribute

    attribute: string

    the attribute to order by

    +

    Readonly order

    order: Order

    the order to sort

    +

    Methods

    Static fromJson

    Static fromString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/API.Restriction.html b/docs/classes/API.Restriction.html index e0e6e9c1bd..2bdf278f46 100644 --- a/docs/classes/API.Restriction.html +++ b/docs/classes/API.Restriction.html @@ -1,15 +1,15 @@ Restriction | OpenNMS.js - v2.5.9-SNAPSHOT

    Class Restriction

    A query restriction.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    attribute comparator value?

    Methods

    toString fromJson fromString -

    Constructors

    constructor

    Properties

    attribute

    attribute: string

    The model attribute (name, id, etc.) to query.

    -

    comparator

    comparator: Comparator

    The comparator to use when querying.

    -

    Optional value

    value?: any

    The value to compare the attribute property to.

    -

    Methods

    toString

    Static fromJson

    Static fromString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    attribute

    attribute: string

    The model attribute (name, id, etc.) to query.

    +

    comparator

    comparator: Comparator

    The comparator to use when querying.

    +

    Optional value

    value?: any

    The value to compare the attribute property to.

    +

    Methods

    toString

    Static fromJson

    Static fromString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/API.SearchProperty.html b/docs/classes/API.SearchProperty.html index 822ef6222f..07cbaddd3a 100644 --- a/docs/classes/API.SearchProperty.html +++ b/docs/classes/API.SearchProperty.html @@ -1,5 +1,5 @@ SearchProperty | OpenNMS.js - v2.5.9-SNAPSHOT

    Class SearchProperty

    Represents a query search property.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    id? name? orderBy? @@ -7,12 +7,12 @@ valueProvider values

    Methods

    findValues -

    Constructors

    constructor

    Properties

    Optional id

    id?: string

    the search property ID

    -

    Optional name

    name?: string

    a descriptive name for the property

    -

    Optional orderBy

    orderBy?: boolean

    whether the property is sortable

    -

    Optional type

    type?: SearchPropertyType

    the property type

    -

    Private valueProvider

    valueProvider: IValueProvider

    The value provider

    -

    values

    values: any

    the values if any

    -

    Methods

    findValues

    • findValues(options): Promise<any>

    • Hook to gather all the values for this property.

      +

    Constructors

    constructor

    Properties

    Optional id

    id?: string

    the search property ID

    +

    Optional name

    name?: string

    a descriptive name for the property

    +

    Optional orderBy

    orderBy?: boolean

    whether the property is sortable

    +

    Optional type

    type?: SearchPropertyType

    the property type

    +

    Private valueProvider

    valueProvider: IValueProvider

    The value provider

    +

    values

    values: any

    the values if any

    +

    Methods

    findValues

    • findValues(options): Promise<any>

    • Hook to gather all the values for this property.

      Parameters

      • options: any

        Some additional options, to for example restrict the values or limit the query.

        -

      Returns Promise<any>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<any>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/API.SearchPropertyType.html b/docs/classes/API.SearchPropertyType.html index fa50b5471c..bcad8d4d69 100644 --- a/docs/classes/API.SearchPropertyType.html +++ b/docs/classes/API.SearchPropertyType.html @@ -1,5 +1,5 @@ SearchPropertyType | OpenNMS.js - v2.5.9-SNAPSHOT

    Class SearchPropertyType

    Represents a search property type.

    -

    Hierarchy

    • OnmsEnum<string>
      • SearchPropertyType

    Constructors

    constructor +

    Hierarchy

    • OnmsEnum<string>
      • SearchPropertyType

    Constructors

    constructor

    Properties

    comparators

    Accessors

    id index @@ -10,13 +10,13 @@ toString forId forLabel -

    Constructors

    constructor

    Properties

    Private Readonly comparators

    comparators: Comparator[]

    supported comparators.

    -

    Accessors

    id

    index

    label

    Methods

    getComparators

    • getComparators(): Comparator[]

    • Returns the comparators supported by this type.

      +

    Constructors

    constructor

    Properties

    Private Readonly comparators

    comparators: Comparator[]

    supported comparators.

    +

    Accessors

    id

    index

    label

    Methods

    getComparators

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      -

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      -

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    Static forLabel

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      +

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      +

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    Static forLabel

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/API.ServerMetadata.html b/docs/classes/API.ServerMetadata.html index cb9ae446a4..c2848c72f6 100644 --- a/docs/classes/API.ServerMetadata.html +++ b/docs/classes/API.ServerMetadata.html @@ -1,5 +1,5 @@ ServerMetadata | OpenNMS.js - v2.5.9-SNAPSHOT

    Class ServerMetadata

    A class that represents the capabilities an OpenNMS server has and other information about it.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    ticketerConfig? type version @@ -24,25 +24,25 @@

    Constructors

    constructor

    Properties

    Optional Readonly ticketerConfig

    ticketerConfig?: TicketerConfig

    The ticketer config. Requires at least version 21.0.0 of OpenNMS.

    -

    Readonly type

    type: ServerType

    The type of server (Horizon, Meridian).

    -

    Readonly version

    version: OnmsVersion

    The version of the server.

    -

    Methods

    ackAlarms

    apiVersion

    capabilities

    • capabilities(): {
          [key: string]: any;
      }

    • Returns a convenient data structure with all capabilities listed.

      -

      Returns {
          [key: string]: any;
      }

      • [key: string]: any

    clone

    enhancedFlows

    equals

    flows

    graphs

    ipInterfaceRest

    • ipInterfaceRest(): boolean

    • Does this version support the api/v2/ipinterfaces ReST endpoint?

      -

      Returns boolean

    outageSummaries

    selectPartialResources

    • selectPartialResources(): boolean

    • Does this version support the rest/resources/select ReST endpoint?

      -

      Returns boolean

    setNodeLocation

    situations

    ticketer

    toString

    tos

    useJson

    withTicketer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional ticketerConfig: TicketerConfig

    • Returns ServerMetadata

    Properties

    Optional Readonly ticketerConfig

    ticketerConfig?: TicketerConfig

    The ticketer config. Requires at least version 21.0.0 of OpenNMS.

    +

    Readonly type

    type: ServerType

    The type of server (Horizon, Meridian).

    +

    Readonly version

    version: OnmsVersion

    The version of the server.

    +

    Methods

    ackAlarms

    apiVersion

    capabilities

    • capabilities(): {
          [key: string]: any;
      }

    • Returns a convenient data structure with all capabilities listed.

      +

      Returns {
          [key: string]: any;
      }

      • [key: string]: any

    clone

    enhancedFlows

    equals

    flows

    graphs

    ipInterfaceRest

    • ipInterfaceRest(): boolean

    • Does this version support the api/v2/ipinterfaces ReST endpoint?

      +

      Returns boolean

    outageSummaries

    selectPartialResources

    • selectPartialResources(): boolean

    • Does this version support the rest/resources/select ReST endpoint?

      +

      Returns boolean

    setNodeLocation

    situations

    ticketer

    toString

    tos

    useJson

    withTicketer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/API.ServerType.html b/docs/classes/API.ServerType.html index 9b90e94fd7..42aaca528c 100644 --- a/docs/classes/API.ServerType.html +++ b/docs/classes/API.ServerType.html @@ -1,5 +1,5 @@ ServerType | OpenNMS.js - v2.5.9-SNAPSHOT

    Class ServerType

    Represents an OpenNMS server type.

    -

    Hierarchy

    • OnmsEnum<number>
      • ServerType

    Constructors

    constructor +

    Hierarchy

    • OnmsEnum<number>
      • ServerType

    Constructors

    constructor

    Accessors

    id index label @@ -7,10 +7,10 @@ toJSON toString

    Constructors

    constructor

    Accessors

    id

    index

    label

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      -

      Returns string

    toJSON

    • toJSON(): {
          id: number;
          label: string;
      }

    • convert to the JSON representation

      -

      Returns {
          id: number;
          label: string;
      }

      • id: number
      • label: string

    toString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • id: number
    • label: string

    Returns ServerType

    Accessors

    id

    index

    label

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      +

      Returns string

    toJSON

    • toJSON(): {
          id: number;
          label: string;
      }

    • convert to the JSON representation

      +

      Returns {
          id: number;
          label: string;
      }

      • id: number
      • label: string

    toString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/API.TicketerConfig.html b/docs/classes/API.TicketerConfig.html index ddb1f32ce5..c9cbf2f08a 100644 --- a/docs/classes/API.TicketerConfig.html +++ b/docs/classes/API.TicketerConfig.html @@ -1,11 +1,11 @@ TicketerConfig | OpenNMS.js - v2.5.9-SNAPSHOT

    Class TicketerConfig

    States the current ticket configuration.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    enabled plugin

    Methods

    clone equals -

    Constructors

    constructor

    Properties

    Readonly enabled

    enabled: boolean

    Defines if the ticketer integration is enabled. True if enabled, False otherwise.

    -

    Readonly plugin

    plugin: string

    The name of the ticketer plugin currently in use.

    -

    Methods

    clone

    equals

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Readonly enabled

    enabled: boolean

    Defines if the ticketer integration is enabled. True if enabled, False otherwise.

    +

    Readonly plugin

    plugin: string

    The name of the ticketer plugin currently in use.

    +

    Methods

    clone

    equals

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Client.html b/docs/classes/Client.html index 5690002a21..15d546f7fd 100644 --- a/docs/classes/Client.html +++ b/docs/classes/Client.html @@ -1,5 +1,5 @@ Client | OpenNMS.js - v2.5.9-SNAPSHOT

    Class Client

    The OpenNMS client. This is the primary interface to OpenNMS servers.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    http defaultHttp

    Methods

    alarms @@ -18,29 +18,29 @@

    If no httpImpl parameter is provided, the class in [[Client.defaultHttp]] will be used by default. Unless overridden, this defaults to [[AxiosHTTP]].

    Parameters

    • Optional httpImpl: IOnmsHTTP

      The IOnmsHTTP implementation to use.

      -

    Returns Client

    Properties

    http

    http: IOnmsHTTP

    the OnmsHTTP implementation that will be used when making requests

    -

    Static Private Readonly defaultHttp

    defaultHttp: typeof AxiosHTTP = AxiosHTTP

    The default OnmsHTTP implementation to be used when making requests

    -

    Methods

    alarms

    connect

    • connect(name, url, username, password, timeout?): Promise<Client>

    • Connect to an OpenNMS server.

      +

    Returns Client

    Properties

    http

    http: IOnmsHTTP

    the OnmsHTTP implementation that will be used when making requests

    +

    Static Private Readonly defaultHttp

    defaultHttp: typeof AxiosHTTP = AxiosHTTP

    The default OnmsHTTP implementation to be used when making requests

    +

    Methods

    alarms

    connect

    • connect(name, url, username, password, timeout?): Promise<Client>

    • Connect to an OpenNMS server.

      NOTE: This method will connect to the server using the provided information, get the server metadata, and then assign that server to the existing [[IOnmsHTTP]] implementation associated with this client (or the default impl, if one has not yet been provided).

      -

      Parameters

      • name: string
      • url: string
      • username: string
      • password: string
      • Optional timeout: number

      Returns Promise<Client>

    events

    flows

    ipInterfaces

    monitoredServices

    nodes

    outages

    situationfeedback

    snmpInterfaces

    Static checkServer

    • checkServer(server, httpImpl?, timeout?): Promise<boolean>

    • Given an OnmsServer object, check that it can be connected to.

      +

      Parameters

      • name: string
      • url: string
      • username: string
      • password: string
      • Optional timeout: number

      Returns Promise<Client>

    events

    flows

    ipInterfaces

    monitoredServices

    nodes

    outages

    situationfeedback

    snmpInterfaces

    Static checkServer

    • checkServer(server, httpImpl?, timeout?): Promise<boolean>

    • Given an OnmsServer object, check that it can be connected to.

      Parameters

      • server: OnmsServer

        the server to check

      • Optional httpImpl: IOnmsHTTP

        the [[IOnmsHTTP]] implementation to use

      • Optional timeout: number

        how long to wait before giving up when making ReST calls

        -

      Returns Promise<boolean>

    Static getMetadata

    • getMetadata(server, httpImpl?, timeout?): Promise<ServerMetadata>

    • Given an OnmsServer object, query what capabilities it has, and return the capabilities +

    Returns Promise<boolean>

    Static getMetadata

    • getMetadata(server, httpImpl?, timeout?): Promise<ServerMetadata>

    • Given an OnmsServer object, query what capabilities it has, and return the capabilities associated with that server.

      Parameters

      • server: OnmsServer

        the server to check

      • Optional httpImpl: IOnmsHTTP

        the [[IOnmsHTTP]] implementation to use

      • Optional timeout: number

        how long to wait before giving up when making ReST calls

        -

      Returns Promise<ServerMetadata>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<ServerMetadata>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DAO.AlarmDAO.html b/docs/classes/DAO.AlarmDAO.html index 6cb09f4024..4bf42aad58 100644 --- a/docs/classes/DAO.AlarmDAO.html +++ b/docs/classes/DAO.AlarmDAO.html @@ -1,5 +1,5 @@ AlarmDAO | OpenNMS.js - v2.5.9-SNAPSHOT

    Class AlarmDAO

    Data access for [[OnmsAlarm]] objects.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Accessors

    http server

    Methods

    acknowledge @@ -35,102 +35,102 @@ useJson visitClause visitFilter -

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    acknowledge

    • acknowledge(alarm, user?): Promise<void>

    • Acknowledge an alarm.

      +

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    acknowledge

    • acknowledge(alarm, user?): Promise<void>

    • Acknowledge an alarm.

      Parameters

      • alarm: number | OnmsAlarm
      • Optional user: string

        The user to ack the alarm as. (Only administrators have the right to do this.)

        -

      Returns Promise<void>

      Version

      ReST v1+

      -

    clear

    • clear(alarm): Promise<void>

    • Clear an alarm.

      +

    Returns Promise<void>

    Version

    ReST v1+

    +

    clear

    • clear(alarm): Promise<void>

    • Clear an alarm.

      Parameters

      • alarm: number | OnmsAlarm

        The [[OnmsAlarm]] or alarm ID.

        -

      Returns Promise<void>

      Version

      ReST v1+

      -

    closeTicket

    • closeTicket(alarm): Promise<void>

    • Close the ticket associated with the given alarm.

      +

    Returns Promise<void>

    Version

    ReST v1+

    +

    closeTicket

    • closeTicket(alarm): Promise<void>

    • Close the ticket associated with the given alarm.

      Parameters

      • alarm: number | OnmsAlarm

        The [[OnmsAlarm]] or alarm ID.

        -

      Returns Promise<void>

      Version

      ReST v2

      -

    createTicket

    • createTicket(alarm): Promise<void>

    • Create a trouble ticket for the specified alarm.

      +

    Returns Promise<void>

    Version

    ReST v2

    +

    createTicket

    • createTicket(alarm): Promise<void>

    • Create a trouble ticket for the specified alarm.

      Parameters

      • alarm: number | OnmsAlarm

        The [[OnmsAlarm]] or alarm ID.

        -

      Returns Promise<void>

      Version

      ReST v2

      -

    deleteJournalMemo

    • deleteJournalMemo(alarm): Promise<void>

    • Delete the journal memo ticket associated with the given alarm.

      +

    Returns Promise<void>

    Version

    ReST v2

    +

    deleteJournalMemo

    • deleteJournalMemo(alarm): Promise<void>

    • Delete the journal memo ticket associated with the given alarm.

      Parameters

      • alarm: number | OnmsAlarm

        The [[OnmsAlarm]] or alarm ID.

        -

      Returns Promise<void>

      Version

      ReST v2

      -

    deleteStickyMemo

    • deleteStickyMemo(alarm): Promise<void>

    • Delete the sticky memo ticket associated with the given alarm.

      +

    Returns Promise<void>

    Version

    ReST v2

    +

    deleteStickyMemo

    • deleteStickyMemo(alarm): Promise<void>

    • Delete the sticky memo ticket associated with the given alarm.

      Parameters

      • alarm: number | OnmsAlarm

        The [[OnmsAlarm]] or alarm ID.

        -

      Returns Promise<void>

      Version

      ReST v2

      -

    escalate

    • escalate(alarm): Promise<void>

    • Escalate an alarm.

      +

    Returns Promise<void>

    Version

    ReST v2

    +

    escalate

    • escalate(alarm): Promise<void>

    • Escalate an alarm.

      Parameters

      • alarm: number | OnmsAlarm

        The [[OnmsAlarm]] or alarm ID.

        -

      Returns Promise<void>

      Version

      ReST v1+

      -

    find

    • find(filter?): Promise<OnmsAlarm[]>

    • Find matching alarms.

      +

    Returns Promise<void>

    Version

    ReST v1+

    +

    find

    • find(filter?): Promise<OnmsAlarm[]>

    • Find matching alarms.

      Parameters

      • Optional filter: Filter

        The filter to use when querying.

        -

      Returns Promise<OnmsAlarm[]>

      An array of [[OnmsAlarm]] objects.

      +

    Returns Promise<OnmsAlarm[]>

    An array of [[OnmsAlarm]] objects.

    Version

    ReST v1+

    -

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      +

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      Parameters

      • propertyId: string

        The propertyId to find the values for

      • Optional options: any

        Some additional options. May be implementer dependent, such as limit, or value restrictions

        -

      Returns Promise<any>

      A promise containing the values.

      -

    get

    Returns Promise<any>

    A promise containing the values.

    +

    get

    • get(id): Promise<OnmsAlarm>

    • Fetch an alarm.

      Parameters

      • id: number

        The alarm's ID.

        -

      Returns Promise<OnmsAlarm>

      An [[OnmsAlarm]].

      +

    Returns Promise<OnmsAlarm>

    An [[OnmsAlarm]].

    Version

    ReST v1+

    -

    Protected getApiVersion

    • getApiVersion(): number

    • Retrieve the API version from the currently configured server.

      -

      Returns number

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count +

    Protected getApiVersion

    • getApiVersion(): number

    • Retrieve the API version from the currently configured server.

      +

      Returns number

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.

      -

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getData

    • getData(result): OnmsAlarm[]

    • Extracts the data from an HTTP Request result.

      +

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getData

    Private getDetailsPage

    • getDetailsPage(alarm): string

    • Retrieves the URL to the details page for the given alarm.

      +

    Private getDetailsPage

    • getDetailsPage(alarm): string

    • Retrieves the URL to the details page for the given alarm.

      Parameters

      • alarm: number | OnmsAlarm

        The [[OnmsAlarm]] or alarm ID.

      Returns string

      URL on the associated OpenNMS server for the alarm details page.

      -

    getFilterProcessor

    getPropertiesCache

    • getPropertiesCache(): Promise<any>

    • Returns or creates a cache of properties for this dao.

      -

      Returns Promise<any>

      the cache for this dao. It is created if it does not exist.

      -

    Private handleError

    • handleError(err): void

    • Handle response errors and automatically log "ticketing not enabled" responses.

      +

    getFilterProcessor

    getPropertiesCache

    • getPropertiesCache(): Promise<any>

    • Returns or creates a cache of properties for this dao.

      +

      Returns Promise<any>

      the cache for this dao. It is created if it does not exist.

      +

    Private handleError

    Protected onSetServer

    Protected parseResultList

    • parseResultList(result, dataFieldName, path, mapCallbackFunction): any[]

    • Fetches the data from the result and verfifes that the dataFieldName exists in the data property. +

    Returns void

    Protected onSetServer

    Protected parseResultList

    • parseResultList(result, dataFieldName, path, mapCallbackFunction): any[]

    • Fetches the data from the result and verfifes that the dataFieldName exists in the data property. If it does not exist, an exception is thrown.

      Parameters

      • result: any

        The result to fetch the data from

      • dataFieldName: string

        The property name (basically result.data[dataFieldName].

      • path: string

        The path where the result was fetched from. This is for error handling

      • mapCallbackFunction: any

        Callback function to convert each entry from result.data[dataFieldName].

        -

      Returns any[]

    saveJournalMemo

    • saveJournalMemo(alarm, body, user?): Promise<void>

    • Create or update the journal memo associated with the alarm.

      +

    Returns any[]

    saveJournalMemo

    • saveJournalMemo(alarm, body, user?): Promise<void>

    • Create or update the journal memo associated with the alarm.

      Parameters

      • alarm: number | OnmsAlarm

        The [[OnmsAlarm]] or alarm ID.

      • body: string

        The memo body

      • Optional user: string

        The user to update the memo as. (Only administrators have the right to do this.)

        -

      Returns Promise<void>

      Version

      ReST v2

      -

    saveStickyMemo

    • saveStickyMemo(alarm, body, user?): Promise<void>

    • Create or update the sticky memo associated with the alarm.

      +

    Returns Promise<void>

    Version

    ReST v2

    +

    saveStickyMemo

    • saveStickyMemo(alarm, body, user?): Promise<void>

    • Create or update the sticky memo associated with the alarm.

      Parameters

      • alarm: number | OnmsAlarm

        The [[OnmsAlarm]] or alarm ID.

      • body: string

        The memo body

      • Optional user: string

        The user to update the memo as. (Only administrators have the right to do this.)

        -

      Returns Promise<void>

      Version

      ReST v2

      -

    searchProperties

    searchProperty

    • searchProperty(id): Promise<SearchProperty>

    • Gets the property identified by the id if it exists.

      +

    Returns Promise<void>

    Version

    ReST v2

    +

    searchProperties

    searchProperty

    Protected searchPropertyPath

    • searchPropertyPath(): string

    • The path to the alarm search properties endpoint.

      -

      Returns string

    setTTicketId

    • setTTicketId(alarm, ticketId): Promise<void>

    • Associate a ticket ID with the alarm.

      +

    Returns Promise<SearchProperty>

    Protected searchPropertyPath

    • searchPropertyPath(): string

    • The path to the alarm search properties endpoint.

      +

      Returns string

    setTTicketId

    • setTTicketId(alarm, ticketId): Promise<void>

    • Associate a ticket ID with the alarm.

      Parameters

      • alarm: number | OnmsAlarm

        The [[OnmsAlarm]] or alarm ID.

      • ticketId: string

        The ticket ID.

        -

      Returns Promise<void>

      Version

      ReST v1+

      -

    setTTicketState

    • setTTicketState(alarm, state): Promise<void>

    • Update the state of the ticket associated with the alarm.

      +

    Returns Promise<void>

    Version

    ReST v1+

    +

    setTTicketState

    • setTTicketState(alarm, state): Promise<void>

    • Update the state of the ticket associated with the alarm.

      Parameters

      Returns Promise<void>

      Version

      ReST v1+

      -

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      -

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      -

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      +

    Returns Promise<void>

    Version

    ReST v1+

    +

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      +

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      +

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      Parameters

      • from: any

      Returns number

      Deprecated

      use Util.toNumber instead.

      -

    triggerTicketUpdate

    • triggerTicketUpdate(alarm): Promise<void>

    • Notify OpenNMS it should fetch updated ticket state for an alarm from the remote ticketing system.

      +

    triggerTicketUpdate

    • triggerTicketUpdate(alarm): Promise<void>

    • Notify OpenNMS it should fetch updated ticket state for an alarm from the remote ticketing system.

      Parameters

      • alarm: number | OnmsAlarm

        The [[OnmsAlarm]] or alarm ID.

        -

      Returns Promise<void>

      Version

      ReST v2

      -

    unacknowledge

    • unacknowledge(alarm, user?): Promise<void>

    • Un-acknowledge an alarm.

      +

    Returns Promise<void>

    Version

    ReST v2

    +

    unacknowledge

    • unacknowledge(alarm, user?): Promise<void>

    • Un-acknowledge an alarm.

      Parameters

      • alarm: number | OnmsAlarm

        The [[OnmsAlarm]] or alarm ID.

        -
      • Optional user: string

      Returns Promise<void>

      Version

      ReST v1+

      -

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      -

      Returns boolean

    Protected visitClause

    • visitClause(clause, visitor): void

    • "visits" a filter clause, applying it to the filter visitor

      +
    • Optional user: string

    Returns Promise<void>

    Version

    ReST v1+

    +

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      +

      Returns boolean

    Protected visitClause

    • visitClause(clause, visitor): void

    • "visits" a filter clause, applying it to the filter visitor

      Parameters

      Returns void

    Protected visitFilter

    • visitFilter(filter, visitor): void

    • Iterate over a Filter object and its children.

      +

    Returns void

    Protected visitFilter

    • visitFilter(filter, visitor): void

    • Iterate over a Filter object and its children.

      Parameters

      • filter: Filter

        the filter to visit

      • visitor: IFilterVisitor

        the class to invoke while visiting the filter

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DAO.EventDAO.html b/docs/classes/DAO.EventDAO.html index 20f7b89f14..21f3d67de6 100644 --- a/docs/classes/DAO.EventDAO.html +++ b/docs/classes/DAO.EventDAO.html @@ -1,5 +1,5 @@ EventDAO | OpenNMS.js - v2.5.9-SNAPSHOT

    Class EventDAO

    Data access for [[OnmsEvent]] objects.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Accessors

    http server

    Methods

    find @@ -20,42 +20,42 @@ useJson visitClause visitFilter -

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    find

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      +

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    find

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      Parameters

      • propertyId: string

        The propertyId to find the values for

      • Optional options: any

        Some additional options. May be implementer dependent, such as limit, or value restrictions

        -

      Returns Promise<any>

      A promise containing the values.

      -

    get

    Protected getApiVersion

    • getApiVersion(): number

    • Retrieve the API version from the currently configured server.

      -

      Returns number

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count +

    Returns Promise<any>

    A promise containing the values.

    +

    get

    Protected getApiVersion

    • getApiVersion(): number

    • Retrieve the API version from the currently configured server.

      +

      Returns number

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.

      -

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getFilterProcessor

    Protected getOptions

    • getOptions(filter?): Promise<OnmsHTTPOptionsBuilder>

    • Create an [[OnmsHTTPOptions]] object for DAO calls given an optional filter.

      +

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getFilterProcessor

    Protected getOptions

    getPropertiesCache

    • getPropertiesCache(): Promise<any>

    • Returns or creates a cache of properties for this dao.

      -

      Returns Promise<any>

      the cache for this dao. It is created if it does not exist.

      -

    Protected onSetServer

    Protected parseResultList

    • parseResultList(result, dataFieldName, path, mapCallbackFunction): any[]

    • Fetches the data from the result and verfifes that the dataFieldName exists in the data property. +

    Returns Promise<OnmsHTTPOptionsBuilder>

    getPropertiesCache

    • getPropertiesCache(): Promise<any>

    • Returns or creates a cache of properties for this dao.

      +

      Returns Promise<any>

      the cache for this dao. It is created if it does not exist.

      +

    Protected onSetServer

    Protected parseResultList

    • parseResultList(result, dataFieldName, path, mapCallbackFunction): any[]

    • Fetches the data from the result and verfifes that the dataFieldName exists in the data property. If it does not exist, an exception is thrown.

      Parameters

      • result: any

        The result to fetch the data from

      • dataFieldName: string

        The property name (basically result.data[dataFieldName].

      • path: string

        The path where the result was fetched from. This is for error handling

      • mapCallbackFunction: any

        Callback function to convert each entry from result.data[dataFieldName].

        -

      Returns any[]

    searchProperties

    searchProperty

    • searchProperty(id): Promise<SearchProperty>

    • Gets the property identified by the id if it exists.

      +

    Returns any[]

    searchProperties

    searchProperty

    Protected searchPropertyPath

    • searchPropertyPath(): string

    • The path to the event search properties endpoint.

      -

      Returns string

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      -

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      -

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      +

    Returns Promise<SearchProperty>

    Protected searchPropertyPath

    • searchPropertyPath(): string

    • The path to the event search properties endpoint.

      +

      Returns string

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      +

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      +

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      Parameters

      • from: any

      Returns number

      Deprecated

      use Util.toNumber instead.

      -

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      -

      Returns boolean

    Protected visitClause

    • visitClause(clause, visitor): void

    • "visits" a filter clause, applying it to the filter visitor

      +

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      +

      Returns boolean

    Protected visitClause

    • visitClause(clause, visitor): void

    • "visits" a filter clause, applying it to the filter visitor

      Parameters

      Returns void

    Protected visitFilter

    • visitFilter(filter, visitor): void

    • Iterate over a Filter object and its children.

      +

    Returns void

    Protected visitFilter

    • visitFilter(filter, visitor): void

    • Iterate over a Filter object and its children.

      Parameters

      • filter: Filter

        the filter to visit

      • visitor: IFilterVisitor

        the class to invoke while visiting the filter

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DAO.FlowDAO.html b/docs/classes/DAO.FlowDAO.html index db4343fdde..4a9876247c 100644 --- a/docs/classes/DAO.FlowDAO.html +++ b/docs/classes/DAO.FlowDAO.html @@ -1,5 +1,5 @@ FlowDAO | OpenNMS.js - v2.5.9-SNAPSHOT

    Class FlowDAO

    DAO for accessing flow (Netflow/IPFIX/sFlow) data.

    -

    Hierarchy

    • BaseDAO
      • FlowDAO

    Constructors

    constructor +

    Hierarchy

    • BaseDAO
      • FlowDAO

    Constructors

    constructor

    Accessors

    http server

    Methods

    checkForEnhancedFlows @@ -32,44 +32,44 @@

    Constructors

    constructor

    • new FlowDAO(impl): FlowDAO

    • Construct a DAO instance.

      Parameters

      • impl: IOnmsHTTP | IHasHTTP

        The HTTP implementation to use. It is also legal to pass any object conforming to the [[IHasHTTP]] interface (like a [[Client]]).

        -

      Returns FlowDAO

    Accessors

    http

    server

    Methods

    Private checkForEnhancedFlows

    • checkForEnhancedFlows(): void

    • Check if this version of OpenNMS supports enhanced flow API and if not throw an error.

      -

      Returns void

    Private checkForToSSupport

    • checkForToSSupport(): void

    • Check if this version of OpenNMS supports ToS filtering API and if not throw an error.

      -

      Returns void

    getApplications

    • getApplications(prefix?, start?, end?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<string[]>

    • Enumerate the applications matching the given prefix and filters.

      +

    Returns FlowDAO

    Accessors

    http

    server

    Methods

    Private checkForEnhancedFlows

    • checkForEnhancedFlows(): void

    • Check if this version of OpenNMS supports enhanced flow API and if not throw an error.

      +

      Returns void

    Private checkForToSSupport

    • checkForToSSupport(): void

    • Check if this version of OpenNMS supports ToS filtering API and if not throw an error.

      +

      Returns void

    getApplications

    • getApplications(prefix?, start?, end?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<string[]>

    • Enumerate the applications matching the given prefix and filters.

      Parameters

      • Optional prefix: string

        the prefix to match

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -

      Returns Promise<string[]>

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count +

    Returns Promise<string[]>

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.

      -

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getDscpValues

    • getDscpValues(exporterNodeCriteria?, ifIndex?, start?, end?): Promise<number[]>

    • Get used Dscp values for a specific interface

      +

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getDscpValues

    • getDscpValues(exporterNodeCriteria?, ifIndex?, start?, end?): Promise<number[]>

    • Get used Dscp values for a specific interface

      Parameters

      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        the SNMP interface

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

        -

      Returns Promise<number[]>

    getExporter

    • getExporter(criteria, limit, start?, end?): Promise<OnmsFlowExporter>

    • Get detailed information about a specific node.

      +

    Returns Promise<number[]>

    getExporter

    • getExporter(criteria, limit, start?, end?): Promise<OnmsFlowExporter>

    • Get detailed information about a specific node.

      Parameters

      • criteria: string

        the node ID or foreignSource:foreignId tuple

      • limit: number

        maximum number of interfaces to return (those with the most flows will be returned if the results are truncated)

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

        -

      Returns Promise<OnmsFlowExporter>

    getExporters

    • getExporters(limit, start?, end?): Promise<OnmsFlowExporterSummary[]>

    • Get a summary of the nodes that have exported flows.

      +

    Returns Promise<OnmsFlowExporter>

    getExporters

    • getExporters(limit, start?, end?): Promise<OnmsFlowExporterSummary[]>

    • Get a summary of the nodes that have exported flows.

      Parameters

      • limit: number

        maximum number of exporters to return (those with the most flows will be returned if the results are truncated)

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

        -

      Returns Promise<OnmsFlowExporterSummary[]>

    getHosts

    • getHosts(pattern?, start?, end?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<string[]>

    • Enumerate all the hosts matching the given pattern and filters.

      +

    Returns Promise<OnmsFlowExporterSummary[]>

    getHosts

    • getHosts(pattern?, start?, end?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<string[]>

    • Enumerate all the hosts matching the given pattern and filters.

      Parameters

      • Optional pattern: string

        the regex pattern to match

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -

      Returns Promise<string[]>

    Protected getOptions

    getSeriesForApplications

    • getSeriesForApplications(applications?, start?, end?, step?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>

    • Get time series data for the top N applications/protocols based on parameters.

      +

    Returns Promise<string[]>

    Protected getOptions

    getSeriesForApplications

    • getSeriesForApplications(applications?, start?, end?, step?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>

    • Get time series data for the top N applications/protocols based on parameters.

      Parameters

      • Optional applications: string[]

        the applications to include

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

        @@ -79,7 +79,7 @@
      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -

      Returns Promise<OnmsFlowSeries>

    getSeriesForConversations

    • getSeriesForConversations(conversations?, start?, end?, step?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?, ecn?): Promise<OnmsFlowSeries>

    • Get time series data for the given conversations based on parameters.

      +

    Returns Promise<OnmsFlowSeries>

    getSeriesForConversations

    • getSeriesForConversations(conversations?, start?, end?, step?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?, ecn?): Promise<OnmsFlowSeries>

    • Get time series data for the given conversations based on parameters.

      Parameters

      • Optional conversations: string[]

        how many conversations' series to return

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

        @@ -89,14 +89,14 @@
      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -
      • Optional ecn: string[]

      Returns Promise<OnmsFlowSeries>

    getSeriesForDscps

    • getSeriesForDscps(start?, end?, step?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>

    • Get time series data for DSCP based on parameters.

      +
    • Optional ecn: string[]

    Returns Promise<OnmsFlowSeries>

    getSeriesForDscps

    • getSeriesForDscps(start?, end?, step?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>

    • Get time series data for DSCP based on parameters.

      Parameters

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

      • Optional step: number

        the requested time interval between rows

      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -

      Returns Promise<OnmsFlowSeries>

    getSeriesForHosts

    • getSeriesForHosts(hosts?, start?, end?, step?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>

    • Get time series data for the given hosts based on parameters.

      +

    Returns Promise<OnmsFlowSeries>

    getSeriesForHosts

    • getSeriesForHosts(hosts?, start?, end?, step?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>

    • Get time series data for the given hosts based on parameters.

      Parameters

      • Optional hosts: string[]

        the hosts to include

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

        @@ -106,7 +106,7 @@
      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -

      Returns Promise<OnmsFlowSeries>

    getSeriesForTopNApplications

    • getSeriesForTopNApplications(N?, start?, end?, step?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>

    • Get time series data for the top N applications/protocols based on parameters.

      +

    Returns Promise<OnmsFlowSeries>

    getSeriesForTopNApplications

    • getSeriesForTopNApplications(N?, start?, end?, step?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>

    • Get time series data for the top N applications/protocols based on parameters.

      Parameters

      • Optional N: number

        how many applications' series to return

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

        @@ -116,7 +116,7 @@
      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -

      Returns Promise<OnmsFlowSeries>

    getSeriesForTopNConversations

    • getSeriesForTopNConversations(NOptions?, start?, end?, step?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>

    • Get time series data for the top N conversations based on parameters.

      +

    Returns Promise<OnmsFlowSeries>

    getSeriesForTopNConversations

    • getSeriesForTopNConversations(NOptions?, start?, end?, step?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>

    • Get time series data for the top N conversations based on parameters.

      Parameters

      • Optional NOptions: number | ITopNOptions

        how many conversations to return or an object that includes all of the parameters to be set on the API call

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

        @@ -125,7 +125,7 @@
      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -

      Returns Promise<OnmsFlowSeries>

    getSeriesForTopNHosts

    • getSeriesForTopNHosts(N?, start?, end?, step?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>

    • Get time series data for the top N hosts based on parameters.

      +

    Returns Promise<OnmsFlowSeries>

    getSeriesForTopNHosts

    • getSeriesForTopNHosts(N?, start?, end?, step?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowSeries>

    • Get time series data for the top N hosts based on parameters.

      Parameters

      • Optional N: number

        how many applications' series to return

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

        @@ -135,7 +135,7 @@
      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -

      Returns Promise<OnmsFlowSeries>

    getSummaryForApplications

    • getSummaryForApplications(applications?, start?, end?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>

    • Summarize the given applications/protocols based on parameters.

      +

    Returns Promise<OnmsFlowSeries>

    getSummaryForApplications

    • getSummaryForApplications(applications?, start?, end?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>

    • Summarize the given applications/protocols based on parameters.

      Parameters

      • Optional applications: string[]

        the applications to include

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

        @@ -144,7 +144,7 @@
      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -

      Returns Promise<OnmsFlowTable>

    getSummaryForConversations

    • getSummaryForConversations(conversations?, start?, end?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>

    • Summarize the given conversations based on parameters.

      +

    Returns Promise<OnmsFlowTable>

    getSummaryForConversations

    • getSummaryForConversations(conversations?, start?, end?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>

    • Summarize the given conversations based on parameters.

      Parameters

      • Optional conversations: string[]

        how many conversations to return

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

        @@ -153,13 +153,13 @@
      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -

      Returns Promise<OnmsFlowTable>

    getSummaryForDscps

    • getSummaryForDscps(start?, end?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>

    • Summarize the the dscp values based on parameters.

      +

    Returns Promise<OnmsFlowTable>

    getSummaryForDscps

    • getSummaryForDscps(start?, end?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>

    • Summarize the the dscp values based on parameters.

      Parameters

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -

      Returns Promise<OnmsFlowTable>

    getSummaryForHosts

    • getSummaryForHosts(hosts?, start?, end?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>

    • Summarize the given hosts based on parameters.

      +

    Returns Promise<OnmsFlowTable>

    getSummaryForHosts

    • getSummaryForHosts(hosts?, start?, end?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>

    • Summarize the given hosts based on parameters.

      Parameters

      • Optional hosts: string[]

        the hosts to include

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

        @@ -168,7 +168,7 @@
      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -

      Returns Promise<OnmsFlowTable>

    getSummaryForTopNApplications

    • getSummaryForTopNApplications(N?, start?, end?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>

    • Summarize the top N applications/protocols based on parameters.

      +

    Returns Promise<OnmsFlowTable>

    getSummaryForTopNApplications

    • getSummaryForTopNApplications(N?, start?, end?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>

    • Summarize the top N applications/protocols based on parameters.

      Parameters

      • Optional N: number

        how many applications to return

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

        @@ -177,7 +177,7 @@
      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -

      Returns Promise<OnmsFlowTable>

    getSummaryForTopNConversations

    • getSummaryForTopNConversations(NOptions?, start?, end?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>

    • Summarize the top N conversations based on parameters.

      +

    Returns Promise<OnmsFlowTable>

    getSummaryForTopNConversations

    • getSummaryForTopNConversations(NOptions?, start?, end?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>

    • Summarize the top N conversations based on parameters.

      Parameters

      • Optional NOptions: number | ITopNOptions

        how many conversations to return or an object that includes all of the parameters to be set on the API call

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

        @@ -185,7 +185,7 @@
      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -

      Returns Promise<OnmsFlowTable>

    getSummaryForTopNHosts

    • getSummaryForTopNHosts(N?, start?, end?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>

    • Summarize the top N hosts based on parameters.

      +

    Returns Promise<OnmsFlowTable>

    getSummaryForTopNHosts

    • getSummaryForTopNHosts(N?, start?, end?, includeOther?, exporterNodeCriteria?, ifIndex?, dscp?): Promise<OnmsFlowTable>

    • Summarize the top N hosts based on parameters.

      Parameters

      • Optional N: number

        how many conversations to return

      • Optional start: number

        the start of the timespan to query (defaults to 4 hours ago)

      • Optional end: number

        the end of the timespan to query (defaults to now)

        @@ -194,11 +194,11 @@
      • Optional exporterNodeCriteria: string

        the node ID or foreignSource:foreignId tuple

      • Optional ifIndex: number

        filter for flows that came through this SNMP interface

      • Optional dscp: string[]

        filter for flows with this Dscp value

        -

      Returns Promise<OnmsFlowTable>

    Protected onSetServer

    • onSetServer(server?): void

    • Called whenever the OpenNMS server has changed.

      +

    Returns Promise<OnmsFlowTable>

    Protected onSetServer

    • onSetServer(server?): void

    • Called whenever the OpenNMS server has changed.

      Parameters

      Returns void

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      -

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      -

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      +

    Returns void

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      +

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      +

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      Parameters

      • from: any

      Returns number

      Deprecated

      use Util.toNumber instead.

      -

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      -

      Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      +

      Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DAO.IpInterfaceDAO.html b/docs/classes/DAO.IpInterfaceDAO.html index 4241033c49..c3207942d6 100644 --- a/docs/classes/DAO.IpInterfaceDAO.html +++ b/docs/classes/DAO.IpInterfaceDAO.html @@ -1,5 +1,5 @@ IpInterfaceDAO | OpenNMS.js - v2.5.9-SNAPSHOT

    Class IpInterfaceDAO

    Data access for [[OnmsIpInterface]] objects.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Accessors

    http server

    Methods

    find @@ -20,43 +20,43 @@ useJson visitClause visitFilter -

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    find

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      +

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    find

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      Parameters

      • propertyId: string

        The propertyId to find the values for

      • Optional options: any

        Some additional options. May be implementer dependent, such as limit, or value restrictions

        -

      Returns Promise<any>

      A promise containing the values.

      -

    get

    • get(id): Promise<OnmsIpInterface>

    • Get an IP interface, given the interface's ID.

      +

    Returns Promise<any>

    A promise containing the values.

    +

    get

    Protected getApiVersion

    • getApiVersion(): number

    • Retrieve the API version from the currently configured server.

      -

      Returns number

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count +

    Returns Promise<OnmsIpInterface>

    Protected getApiVersion

    • getApiVersion(): number

    • Retrieve the API version from the currently configured server.

      +

      Returns number

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.

      -

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getFilterProcessor

    Protected getOptions

    • getOptions(filter?): Promise<OnmsHTTPOptionsBuilder>

    • Create an [[OnmsHTTPOptions]] object for DAO calls given an optional filter.

      +

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getFilterProcessor

    Protected getOptions

    getPropertiesCache

    • getPropertiesCache(): Promise<any>

    • Returns or creates a cache of properties for this dao.

      -

      Returns Promise<any>

      the cache for this dao. It is created if it does not exist.

      -

    Protected onSetServer

    Protected parseResultList

    • parseResultList(result, dataFieldName, path, mapCallbackFunction): any[]

    • Fetches the data from the result and verfifes that the dataFieldName exists in the data property. +

    Returns Promise<OnmsHTTPOptionsBuilder>

    getPropertiesCache

    • getPropertiesCache(): Promise<any>

    • Returns or creates a cache of properties for this dao.

      +

      Returns Promise<any>

      the cache for this dao. It is created if it does not exist.

      +

    Protected onSetServer

    Protected parseResultList

    • parseResultList(result, dataFieldName, path, mapCallbackFunction): any[]

    • Fetches the data from the result and verfifes that the dataFieldName exists in the data property. If it does not exist, an exception is thrown.

      Parameters

      • result: any

        The result to fetch the data from

      • dataFieldName: string

        The property name (basically result.data[dataFieldName].

      • path: string

        The path where the result was fetched from. This is for error handling

      • mapCallbackFunction: any

        Callback function to convert each entry from result.data[dataFieldName].

        -

      Returns any[]

    searchProperties

    searchProperty

    • searchProperty(id): Promise<SearchProperty>

    • Gets the property identified by the id if it exists.

      +

    Returns any[]

    searchProperties

    searchProperty

    Protected searchPropertyPath

    • searchPropertyPath(): string

    • The path to the interface search properties endpoint.

      -

      Returns string

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      -

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      -

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      +

    Returns Promise<SearchProperty>

    Protected searchPropertyPath

    • searchPropertyPath(): string

    • The path to the interface search properties endpoint.

      +

      Returns string

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      +

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      +

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      Parameters

      • from: any

      Returns number

      Deprecated

      use Util.toNumber instead.

      -

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      -

      Returns boolean

    Protected visitClause

    • visitClause(clause, visitor): void

    • "visits" a filter clause, applying it to the filter visitor

      +

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      +

      Returns boolean

    Protected visitClause

    • visitClause(clause, visitor): void

    • "visits" a filter clause, applying it to the filter visitor

      Parameters

      Returns void

    Protected visitFilter

    • visitFilter(filter, visitor): void

    • Iterate over a Filter object and its children.

      +

    Returns void

    Protected visitFilter

    • visitFilter(filter, visitor): void

    • Iterate over a Filter object and its children.

      Parameters

      • filter: Filter

        the filter to visit

      • visitor: IFilterVisitor

        the class to invoke while visiting the filter

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DAO.MonitoredServiceDAO.html b/docs/classes/DAO.MonitoredServiceDAO.html index 1e6bf830c0..e25a7621b9 100644 --- a/docs/classes/DAO.MonitoredServiceDAO.html +++ b/docs/classes/DAO.MonitoredServiceDAO.html @@ -1,5 +1,5 @@ MonitoredServiceDAO | OpenNMS.js - v2.5.9-SNAPSHOT

    Class MonitoredServiceDAO

    Data access for [[OnmsMonitoredService]] objects.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Accessors

    http server

    Methods

    find @@ -20,43 +20,43 @@ useJson visitClause visitFilter -

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    find

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      +

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    find

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      Parameters

      • propertyId: string

        The propertyId to find the values for

      • Optional options: any

        Some additional options. May be implementer dependent, such as limit, or value restrictions

        -

      Returns Promise<any>

      A promise containing the values.

      -

    get

    Returns Promise<any>

    A promise containing the values.

    +

    get

    Protected getApiVersion

    • getApiVersion(): number

    • Retrieve the API version from the currently configured server.

      -

      Returns number

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count +

    Returns Promise<OnmsMonitoredService>

    Protected getApiVersion

    • getApiVersion(): number

    • Retrieve the API version from the currently configured server.

      +

      Returns number

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.

      -

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getFilterProcessor

    Protected getOptions

    • getOptions(filter?): Promise<OnmsHTTPOptionsBuilder>

    • Create an [[OnmsHTTPOptions]] object for DAO calls given an optional filter.

      +

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getFilterProcessor

    Protected getOptions

    getPropertiesCache

    • getPropertiesCache(): Promise<any>

    • Returns or creates a cache of properties for this dao.

      -

      Returns Promise<any>

      the cache for this dao. It is created if it does not exist.

      -

    Protected onSetServer

    Protected parseResultList

    • parseResultList(result, dataFieldName, path, mapCallbackFunction): any[]

    • Fetches the data from the result and verfifes that the dataFieldName exists in the data property. +

    Returns Promise<OnmsHTTPOptionsBuilder>

    getPropertiesCache

    • getPropertiesCache(): Promise<any>

    • Returns or creates a cache of properties for this dao.

      +

      Returns Promise<any>

      the cache for this dao. It is created if it does not exist.

      +

    Protected onSetServer

    Protected parseResultList

    • parseResultList(result, dataFieldName, path, mapCallbackFunction): any[]

    • Fetches the data from the result and verfifes that the dataFieldName exists in the data property. If it does not exist, an exception is thrown.

      Parameters

      • result: any

        The result to fetch the data from

      • dataFieldName: string

        The property name (basically result.data[dataFieldName].

      • path: string

        The path where the result was fetched from. This is for error handling

      • mapCallbackFunction: any

        Callback function to convert each entry from result.data[dataFieldName].

        -

      Returns any[]

    searchProperties

    searchProperty

    • searchProperty(id): Promise<SearchProperty>

    • Gets the property identified by the id if it exists.

      +

    Returns any[]

    searchProperties

    searchProperty

    Protected searchPropertyPath

    • searchPropertyPath(): string

    • The path to the service search properties endpoint.

      -

      Returns string

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      -

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      -

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      +

    Returns Promise<SearchProperty>

    Protected searchPropertyPath

    • searchPropertyPath(): string

    • The path to the service search properties endpoint.

      +

      Returns string

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      +

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      +

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      Parameters

      • from: any

      Returns number

      Deprecated

      use Util.toNumber instead.

      -

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      -

      Returns boolean

    Protected visitClause

    • visitClause(clause, visitor): void

    • "visits" a filter clause, applying it to the filter visitor

      +

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      +

      Returns boolean

    Protected visitClause

    • visitClause(clause, visitor): void

    • "visits" a filter clause, applying it to the filter visitor

      Parameters

      Returns void

    Protected visitFilter

    • visitFilter(filter, visitor): void

    • Iterate over a Filter object and its children.

      +

    Returns void

    Protected visitFilter

    • visitFilter(filter, visitor): void

    • Iterate over a Filter object and its children.

      Parameters

      • filter: Filter

        the filter to visit

      • visitor: IFilterVisitor

        the class to invoke while visiting the filter

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DAO.NodeDAO.html b/docs/classes/DAO.NodeDAO.html index 9148231328..20afc79fbc 100644 --- a/docs/classes/DAO.NodeDAO.html +++ b/docs/classes/DAO.NodeDAO.html @@ -1,5 +1,5 @@ NodeDAO | OpenNMS.js - v2.5.9-SNAPSHOT

    Class NodeDAO

    Data access for [[OnmsNode]] objects.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Accessors

    http server

    Methods

    fetch @@ -25,50 +25,50 @@ useJson visitClause visitFilter -

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    fetch

    find

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      +

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    fetch

    find

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      Parameters

      • propertyId: string

        The propertyId to find the values for

      • Optional options: any

        Some additional options. May be implementer dependent, such as limit, or value restrictions

        -

      Returns Promise<any>

      A promise containing the values.

      -

    get

    • get(id, recurse?): Promise<OnmsNode>

    • Get an node, given the node's ID.

      +

    Returns Promise<any>

    A promise containing the values.

    +

    get

    • get(id, recurse?): Promise<OnmsNode>

    • Get an node, given the node's ID.

      Parameters

      • id: number

        The node's ID.

      • recurse: boolean = false

        Optionally fetch all sub-model objects. (ipInterface, etc.)

        -

      Returns Promise<OnmsNode>

    Protected getApiVersion

    • getApiVersion(): number

    • Retrieve the API version from the currently configured server.

      -

      Returns number

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count +

    Returns Promise<OnmsNode>

    Protected getApiVersion

    • getApiVersion(): number

    • Retrieve the API version from the currently configured server.

      +

      Returns number

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.

      -

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getFilterProcessor

    Private getNodeId

    • getNodeId(node): number

    • Get the node's ID

      +

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getFilterProcessor

    Private getNodeId

    Protected getOptions

    • getOptions(filter?): Promise<OnmsHTTPOptionsBuilder>

    • Create an [[OnmsHTTPOptions]] object for DAO calls given an optional filter.

      +

    Returns number

    Protected getOptions

    getPropertiesCache

    • getPropertiesCache(): Promise<any>

    • Returns or creates a cache of properties for this dao.

      -

      Returns Promise<any>

      the cache for this dao. It is created if it does not exist.

      -

    ipInterfaces

    Protected onSetServer

    Protected parseResultList

    • parseResultList(result, dataFieldName, path, mapCallbackFunction): any[]

    • Fetches the data from the result and verfifes that the dataFieldName exists in the data property. +

    Returns Promise<OnmsHTTPOptionsBuilder>

    getPropertiesCache

    • getPropertiesCache(): Promise<any>

    • Returns or creates a cache of properties for this dao.

      +

      Returns Promise<any>

      the cache for this dao. It is created if it does not exist.

      +

    ipInterfaces

    Protected onSetServer

    Protected parseResultList

    • parseResultList(result, dataFieldName, path, mapCallbackFunction): any[]

    • Fetches the data from the result and verfifes that the dataFieldName exists in the data property. If it does not exist, an exception is thrown.

      Parameters

      • result: any

        The result to fetch the data from

      • dataFieldName: string

        The property name (basically result.data[dataFieldName].

      • path: string

        The path where the result was fetched from. This is for error handling

      • mapCallbackFunction: any

        Callback function to convert each entry from result.data[dataFieldName].

        -

      Returns any[]

    searchProperties

    searchProperty

    • searchProperty(id): Promise<SearchProperty>

    • Gets the property identified by the id if it exists.

      +

    Returns any[]

    searchProperties

    searchProperty

    Protected searchPropertyPath

    • searchPropertyPath(): string

    • The path to the node search properties endpoint.

      -

      Returns string

    services

    snmpInterfaces

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      -

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      -

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      +

    Returns Promise<SearchProperty>

    Protected searchPropertyPath

    • searchPropertyPath(): string

    • The path to the node search properties endpoint.

      +

      Returns string

    services

    snmpInterfaces

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      +

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      +

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      Parameters

      • from: any

      Returns number

      Deprecated

      use Util.toNumber instead.

      -

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      -

      Returns boolean

    Protected visitClause

    • visitClause(clause, visitor): void

    • "visits" a filter clause, applying it to the filter visitor

      +

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      +

      Returns boolean

    Protected visitClause

    • visitClause(clause, visitor): void

    • "visits" a filter clause, applying it to the filter visitor

      Parameters

      Returns void

    Protected visitFilter

    • visitFilter(filter, visitor): void

    • Iterate over a Filter object and its children.

      +

    Returns void

    Protected visitFilter

    • visitFilter(filter, visitor): void

    • Iterate over a Filter object and its children.

      Parameters

      • filter: Filter

        the filter to visit

      • visitor: IFilterVisitor

        the class to invoke while visiting the filter

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DAO.OutageDAO.html b/docs/classes/DAO.OutageDAO.html index 5b73c7c9c0..e836b279d8 100644 --- a/docs/classes/DAO.OutageDAO.html +++ b/docs/classes/DAO.OutageDAO.html @@ -1,5 +1,5 @@ OutageDAO | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OutageDAO

    Data access for [[OnmsOutage]] objects.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Accessors

    http server

    Methods

    find @@ -20,43 +20,43 @@ useJson visitClause visitFilter -

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    find

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      +

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    find

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      Parameters

      • propertyId: string

        The propertyId to find the values for

      • Optional options: any

        Some additional options. May be implementer dependent, such as limit, or value restrictions

        -

      Returns Promise<any>

      A promise containing the values.

      -

    get

    • get(id): Promise<OnmsOutage>

    • Get an outage, given the outage's ID.

      +

    Returns Promise<any>

    A promise containing the values.

    +

    get

    Protected getApiVersion

    • getApiVersion(): number

    • Retrieve the API version from the currently configured server.

      -

      Returns number

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count +

    Returns Promise<OnmsOutage>

    Protected getApiVersion

    • getApiVersion(): number

    • Retrieve the API version from the currently configured server.

      +

      Returns number

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.

      -

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getFilterProcessor

    Protected getOptions

    • getOptions(filter?): Promise<OnmsHTTPOptionsBuilder>

    • Create an [[OnmsHTTPOptions]] object for DAO calls given an optional filter.

      +

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getFilterProcessor

    Protected getOptions

    getPropertiesCache

    • getPropertiesCache(): Promise<any>

    • Returns or creates a cache of properties for this dao.

      -

      Returns Promise<any>

      the cache for this dao. It is created if it does not exist.

      -

    Protected onSetServer

    Protected parseResultList

    • parseResultList(result, dataFieldName, path, mapCallbackFunction): any[]

    • Fetches the data from the result and verfifes that the dataFieldName exists in the data property. +

    Returns Promise<OnmsHTTPOptionsBuilder>

    getPropertiesCache

    • getPropertiesCache(): Promise<any>

    • Returns or creates a cache of properties for this dao.

      +

      Returns Promise<any>

      the cache for this dao. It is created if it does not exist.

      +

    Protected onSetServer

    Protected parseResultList

    • parseResultList(result, dataFieldName, path, mapCallbackFunction): any[]

    • Fetches the data from the result and verfifes that the dataFieldName exists in the data property. If it does not exist, an exception is thrown.

      Parameters

      • result: any

        The result to fetch the data from

      • dataFieldName: string

        The property name (basically result.data[dataFieldName].

      • path: string

        The path where the result was fetched from. This is for error handling

      • mapCallbackFunction: any

        Callback function to convert each entry from result.data[dataFieldName].

        -

      Returns any[]

    searchProperties

    searchProperty

    • searchProperty(id): Promise<SearchProperty>

    • Gets the property identified by the id if it exists.

      +

    Returns any[]

    searchProperties

    searchProperty

    Protected searchPropertyPath

    • searchPropertyPath(): string

    • The path to the interface search properties endpoint.

      -

      Returns string

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      -

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      -

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      +

    Returns Promise<SearchProperty>

    Protected searchPropertyPath

    • searchPropertyPath(): string

    • The path to the interface search properties endpoint.

      +

      Returns string

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      +

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      +

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      Parameters

      • from: any

      Returns number

      Deprecated

      use Util.toNumber instead.

      -

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      -

      Returns boolean

    Protected visitClause

    • visitClause(clause, visitor): void

    • "visits" a filter clause, applying it to the filter visitor

      +

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      +

      Returns boolean

    Protected visitClause

    • visitClause(clause, visitor): void

    • "visits" a filter clause, applying it to the filter visitor

      Parameters

      Returns void

    Protected visitFilter

    • visitFilter(filter, visitor): void

    • Iterate over a Filter object and its children.

      +

    Returns void

    Protected visitFilter

    • visitFilter(filter, visitor): void

    • Iterate over a Filter object and its children.

      Parameters

      • filter: Filter

        the filter to visit

      • visitor: IFilterVisitor

        the class to invoke while visiting the filter

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DAO.SituationFeedbackDAO.html b/docs/classes/DAO.SituationFeedbackDAO.html index c33e57d0b3..e1f873accd 100644 --- a/docs/classes/DAO.SituationFeedbackDAO.html +++ b/docs/classes/DAO.SituationFeedbackDAO.html @@ -1,5 +1,5 @@ SituationFeedbackDAO | OpenNMS.js - v2.5.9-SNAPSHOT

    Class SituationFeedbackDAO

    Data access for [[OnmsSituationFeedback]] objects.

    -

    Hierarchy

    • BaseDAO
      • SituationFeedbackDAO

    Constructors

    constructor +

    Hierarchy

    • BaseDAO
      • SituationFeedbackDAO

    Constructors

    constructor

    Accessors

    http server

    Methods

    getCount @@ -11,28 +11,28 @@ toDate toNumber useJson -

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count +

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.

      -

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getData

    getData

    getFeedback

    getFeedback

    • getFeedback(situationId): Promise<OnmsSituationFeedback[]>

    • Retrieve feedback.

      Parameters

      • situationId: number

        The alarmId of the Situation to use when querying.

        -

      Returns Promise<OnmsSituationFeedback[]>

      An array of [[OnmsSituationFeedback]] objects.

      +

    Returns Promise<OnmsSituationFeedback[]>

    An array of [[OnmsSituationFeedback]] objects.

    Version

    ReST v1

    -

    getTags

    getTags

    • getTags(prefix): Promise<string[]>

    • Retrieve the tags for a given prefix

      Parameters

      • prefix: string

        the prefix associated with the tags

        -

      Returns Promise<string[]>

    Protected onSetServer

    • onSetServer(server?): void

    • Called whenever the OpenNMS server has changed.

      +

    Returns Promise<string[]>

    Protected onSetServer

    • onSetServer(server?): void

    • Called whenever the OpenNMS server has changed.

      Parameters

      Returns void

    saveFeedback

    • saveFeedback(feedback, situationId): Promise<void>

    • Submit Correlation Feedback for a Situation.

      +

    Returns void

    saveFeedback

    • saveFeedback(feedback, situationId): Promise<void>

    • Submit Correlation Feedback for a Situation.

      Parameters

      • feedback: OnmsSituationFeedback[]

        The [[OnmsSituationFeedback]].

      • situationId: number

        The alarmId of the Situation to use when querying.

        -

      Returns Promise<void>

      Version

      ReST v1

      -

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      -

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      -

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      +

    Returns Promise<void>

    Version

    ReST v1

    +

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      +

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      +

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      Parameters

      • from: any

      Returns number

      Deprecated

      use Util.toNumber instead.

      -

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      -

      Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      +

      Returns boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DAO.SnmpInterfaceDAO.html b/docs/classes/DAO.SnmpInterfaceDAO.html index 038bf9c759..0aa3ee64da 100644 --- a/docs/classes/DAO.SnmpInterfaceDAO.html +++ b/docs/classes/DAO.SnmpInterfaceDAO.html @@ -1,5 +1,5 @@ SnmpInterfaceDAO | OpenNMS.js - v2.5.9-SNAPSHOT

    Class SnmpInterfaceDAO

    Data access for [[OnmsSnmpInterface]] objects.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Accessors

    http server

    Methods

    find @@ -20,43 +20,43 @@ useJson visitClause visitFilter -

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    find

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      +

    Constructors

    constructor

    Accessors

    http

    server

    Methods

    find

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      Parameters

      • propertyId: string

        The propertyId to find the values for

      • Optional options: any

        Some additional options. May be implementer dependent, such as limit, or value restrictions

        -

      Returns Promise<any>

      A promise containing the values.

      -

    get

    • get(id): Promise<OnmsSnmpInterface>

    • Get an SNMP interface, given the interface's ID.

      +

    Returns Promise<any>

    A promise containing the values.

    +

    get

    Protected getApiVersion

    • getApiVersion(): number

    • Retrieve the API version from the currently configured server.

      -

      Returns number

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count +

    Returns Promise<OnmsSnmpInterface>

    Protected getApiVersion

    • getApiVersion(): number

    • Retrieve the API version from the currently configured server.

      +

      Returns number

    Protected getCount

    • getCount(data, status?): number

    • A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.

      -

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getFilterProcessor

    Protected getOptions

    • getOptions(filter?): Promise<OnmsHTTPOptionsBuilder>

    • Create an [[OnmsHTTPOptions]] object for DAO calls given an optional filter.

      +

      Parameters

      • data: any
      • Optional status: number

      Returns number

    getFilterProcessor

    Protected getOptions

    getPropertiesCache

    • getPropertiesCache(): Promise<any>

    • Returns or creates a cache of properties for this dao.

      -

      Returns Promise<any>

      the cache for this dao. It is created if it does not exist.

      -

    Protected onSetServer

    Protected parseResultList

    • parseResultList(result, dataFieldName, path, mapCallbackFunction): any[]

    • Fetches the data from the result and verfifes that the dataFieldName exists in the data property. +

    Returns Promise<OnmsHTTPOptionsBuilder>

    getPropertiesCache

    • getPropertiesCache(): Promise<any>

    • Returns or creates a cache of properties for this dao.

      +

      Returns Promise<any>

      the cache for this dao. It is created if it does not exist.

      +

    Protected onSetServer

    Protected parseResultList

    • parseResultList(result, dataFieldName, path, mapCallbackFunction): any[]

    • Fetches the data from the result and verfifes that the dataFieldName exists in the data property. If it does not exist, an exception is thrown.

      Parameters

      • result: any

        The result to fetch the data from

      • dataFieldName: string

        The property name (basically result.data[dataFieldName].

      • path: string

        The path where the result was fetched from. This is for error handling

      • mapCallbackFunction: any

        Callback function to convert each entry from result.data[dataFieldName].

        -

      Returns any[]

    searchProperties

    searchProperty

    • searchProperty(id): Promise<SearchProperty>

    • Gets the property identified by the id if it exists.

      +

    Returns any[]

    searchProperties

    searchProperty

    Protected searchPropertyPath

    • searchPropertyPath(): string

    • The path to the interface search properties endpoint.

      -

      Returns string

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      -

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      -

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      +

    Returns Promise<SearchProperty>

    Protected searchPropertyPath

    • searchPropertyPath(): string

    • The path to the interface search properties endpoint.

      +

      Returns string

    Protected toDate

    • toDate(from): Moment

    • Convert the given value to a date, or undefined if it cannot be converted.

      +

      Parameters

      • from: any

      Returns Moment

      Deprecated

      use Util.toDate instead.

      +

    Protected toNumber

    • toNumber(from): number

    • Convert the given value to a number, or undefined if it cannot be converted.

      Parameters

      • from: any

      Returns number

      Deprecated

      use Util.toNumber instead.

      -

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      -

      Returns boolean

    Protected visitClause

    • visitClause(clause, visitor): void

    • "visits" a filter clause, applying it to the filter visitor

      +

    Protected useJson

    • useJson(): boolean

    • Whether or not to use JSON when making ReST requests.

      +

      Returns boolean

    Protected visitClause

    • visitClause(clause, visitor): void

    • "visits" a filter clause, applying it to the filter visitor

      Parameters

      Returns void

    Protected visitFilter

    • visitFilter(filter, visitor): void

    • Iterate over a Filter object and its children.

      +

    Returns void

    Protected visitFilter

    • visitFilter(filter, visitor): void

    • Iterate over a Filter object and its children.

      Parameters

      • filter: Filter

        the filter to visit

      • visitor: IFilterVisitor

        the class to invoke while visiting the filter

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DAO.V1FilterProcessor.html b/docs/classes/DAO.V1FilterProcessor.html index 76db2d89b3..263f8f678b 100644 --- a/docs/classes/DAO.V1FilterProcessor.html +++ b/docs/classes/DAO.V1FilterProcessor.html @@ -1,5 +1,5 @@ V1FilterProcessor | OpenNMS.js - v2.5.9-SNAPSHOT

    Class V1FilterProcessor

    Converts a [[Filter]] into ReSTv1 parameters.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Methods

    getParameters

    Constructors

    constructor

    Methods

    getParameters

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns IHash<string | string[]>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DAO.V2FilterProcessor.html b/docs/classes/DAO.V2FilterProcessor.html index fdbbe3f983..8fa67b783b 100644 --- a/docs/classes/DAO.V2FilterProcessor.html +++ b/docs/classes/DAO.V2FilterProcessor.html @@ -1,5 +1,5 @@ V2FilterProcessor | OpenNMS.js - v2.5.9-SNAPSHOT

    Class V2FilterProcessor

    Converts a [[Filter]] into ReSTv2 FIQL parameters.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    searchProperties? NULL_DATE NULL_VALUE @@ -10,19 +10,19 @@ toFIQLComparator toFIQLOperator toFIQLValue -

    Constructors

    constructor

    Properties

    Private Optional searchProperties

    searchProperties?: SearchProperty[]

    The accessor for Properties

    -

    Static NULL_DATE

    NULL_DATE: string = '1970-01-01T00:00:00.000+0000'

    Constant used to represent null dates in the V2 API. +

    Constructors

    constructor

    Properties

    Private Optional searchProperties

    searchProperties?: SearchProperty[]

    The accessor for Properties

    +

    Static NULL_DATE

    NULL_DATE: string = '1970-01-01T00:00:00.000+0000'

    Constant used to represent null dates in the V2 API. This must be explicitly set as the restriction value when using either the NULL or NOTNULL comparators on date fields.

    -

    Static NULL_VALUE

    NULL_VALUE: string = '\u0000'

    Constant used to represent null values in the V2 API.

    -

    Methods

    Private applyDateConversion

    • applyDateConversion(value): any

    • If the given value is a date value, it is converted to be properly parsed by the OpenNMS ReST API, +

    Static NULL_VALUE

    NULL_VALUE: string = '\u0000'

    Constant used to represent null values in the V2 API.

    +

    Methods

    Private applyDateConversion

    • applyDateConversion(value): any

    • If the given value is a date value, it is converted to be properly parsed by the OpenNMS ReST API, otherwise it is not modified.

      Parameters

      • value: any

        Any value which may need conversion.

        -

      Returns any

    getParameters

    Private getProperty

    Private toFIQL

    Private toFIQLComparator

    • toFIQLComparator(comparator): "==" | "!=" | "=gt=" | "=lt=" | "=ge=" | "=le="

    • Given a comparator, convert it to a correspond comparator +

    Returns any

    getParameters

    Private getProperty

    Private toFIQL

    Private toFIQLComparator

    • toFIQLComparator(comparator): "==" | "!=" | "=gt=" | "=lt=" | "=ge=" | "=le="

    • Given a comparator, convert it to a correspond comparator that can be used in the FIQL expression.

      -

      Parameters

      Returns "==" | "!=" | "=gt=" | "=lt=" | "=ge=" | "=le="

    Private toFIQLOperator

    Private toFIQLValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns "==" | "!=" | "=gt=" | "=lt=" | "=ge=" | "=le="

    Private toFIQLOperator

    Private toFIQLValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsAlarm.html b/docs/classes/Model.OnmsAlarm.html index 15e2199a24..282b5d2dc6 100644 --- a/docs/classes/Model.OnmsAlarm.html +++ b/docs/classes/Model.OnmsAlarm.html @@ -1,5 +1,5 @@ OnmsAlarm | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsAlarm

    Represents an OpenNMS alarm.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    ackTime? ackUser? affectedNodeCount? @@ -35,39 +35,39 @@ isSituation lastEventTime urlValue -

    Constructors

    constructor

    Properties

    Optional ackTime

    ackTime?: Moment

    the time this alarm was acknowledged

    -

    Optional ackUser

    ackUser?: string

    the user that acknowledged this alarm

    -

    Optional affectedNodeCount

    affectedNodeCount?: number

    If this alarm is a Situation, the number of Nodes affected by its RelatedAlarms, a value of 1 otherwise

    -

    Optional count

    count?: number

    the number of times this alarm has triggered

    -

    Optional description

    description?: string

    the alarm's description

    -

    Optional detailsPage

    detailsPage?: string

    link to the alarm details page on the source instance

    -

    Optional firstEventTime

    firstEventTime?: Moment

    the first time an event has triggered this alarm

    -

    Optional id

    id?: number

    the alarm ID

    -

    Optional journal

    journal?: OnmsMemo

    journal memo - a note associated with the reduction key for this alarm

    -

    Optional lastEvent

    lastEvent?: OnmsEvent

    the most recent event that triggered this alarm

    -

    Optional location

    location?: string

    which location the alarm originated from

    -

    Optional logMessage

    logMessage?: string

    the alarm's log message

    -

    Optional managedObjectInstance

    managedObjectInstance?: string

    managedObjectInstance - the instance associated with this alarm if it is a situation

    -

    Optional managedObjectType

    managedObjectType?: string

    managedObjectType - the type associated with this alarm if it is a situation

    -

    Optional nodeId

    nodeId?: number

    the node's ID associated with this alarm

    -

    Optional nodeLabel

    nodeLabel?: string

    the node's label associated with this alarm

    -

    Optional operatorInstructions

    operatorInstructions?: string

    operator instructions

    -

    Optional parameters

    parameters?: OnmsParm[]

    the parameters emitted with this alarm's event

    -

    Optional reductionKey

    reductionKey?: string

    the alarm's reduction key

    -

    Optional relatedAlarms

    relatedAlarms?: OnmsAlarmSummary[]

    relatedAlarms - A list of alarms related to this alarm/situation

    -

    Optional service

    service?: OnmsServiceType

    the service associated with the event

    -

    Optional severity

    severity?: OnmsSeverity

    the alarm's severity

    -

    Optional sticky

    sticky?: OnmsMemo

    sticky memo - a note associated with this specific alarm instance

    -

    Optional suppressedBy

    suppressedBy?: string

    who the alarm was suppressed by

    -

    Optional suppressedTime

    suppressedTime?: Moment

    when the alarm was suppressed

    -

    Optional suppressedUntil

    suppressedUntil?: Moment

    when the alarm will stop being suppressed

    -

    Optional troubleTicket

    troubleTicket?: string

    the trouble ticket ID associated with this alarm

    -

    Optional troubleTicketLink

    troubleTicketLink?: string

    the link to the trouble ticket system if defined

    -

    Optional troubleTicketState

    troubleTicketState?: OnmsTroubleTicketState

    the state of the trouble ticket associated with this alarm

    -

    Optional type

    type?: OnmsAlarmType

    the alarm's type

    -

    Optional uei

    uei?: string

    the UEI of the event associated with this alarm

    -

    Accessors

    isAcknowledged

    isSituation

    lastEventTime

    • get lastEventTime(): Moment

    • the most recent time the event has triggered this alarm

      -

      Returns Moment

    urlValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional ackTime

    ackTime?: Moment

    the time this alarm was acknowledged

    +

    Optional ackUser

    ackUser?: string

    the user that acknowledged this alarm

    +

    Optional affectedNodeCount

    affectedNodeCount?: number

    If this alarm is a Situation, the number of Nodes affected by its RelatedAlarms, a value of 1 otherwise

    +

    Optional count

    count?: number

    the number of times this alarm has triggered

    +

    Optional description

    description?: string

    the alarm's description

    +

    Optional detailsPage

    detailsPage?: string

    link to the alarm details page on the source instance

    +

    Optional firstEventTime

    firstEventTime?: Moment

    the first time an event has triggered this alarm

    +

    Optional id

    id?: number

    the alarm ID

    +

    Optional journal

    journal?: OnmsMemo

    journal memo - a note associated with the reduction key for this alarm

    +

    Optional lastEvent

    lastEvent?: OnmsEvent

    the most recent event that triggered this alarm

    +

    Optional location

    location?: string

    which location the alarm originated from

    +

    Optional logMessage

    logMessage?: string

    the alarm's log message

    +

    Optional managedObjectInstance

    managedObjectInstance?: string

    managedObjectInstance - the instance associated with this alarm if it is a situation

    +

    Optional managedObjectType

    managedObjectType?: string

    managedObjectType - the type associated with this alarm if it is a situation

    +

    Optional nodeId

    nodeId?: number

    the node's ID associated with this alarm

    +

    Optional nodeLabel

    nodeLabel?: string

    the node's label associated with this alarm

    +

    Optional operatorInstructions

    operatorInstructions?: string

    operator instructions

    +

    Optional parameters

    parameters?: OnmsParm[]

    the parameters emitted with this alarm's event

    +

    Optional reductionKey

    reductionKey?: string

    the alarm's reduction key

    +

    Optional relatedAlarms

    relatedAlarms?: OnmsAlarmSummary[]

    relatedAlarms - A list of alarms related to this alarm/situation

    +

    Optional service

    service?: OnmsServiceType

    the service associated with the event

    +

    Optional severity

    severity?: OnmsSeverity

    the alarm's severity

    +

    Optional sticky

    sticky?: OnmsMemo

    sticky memo - a note associated with this specific alarm instance

    +

    Optional suppressedBy

    suppressedBy?: string

    who the alarm was suppressed by

    +

    Optional suppressedTime

    suppressedTime?: Moment

    when the alarm was suppressed

    +

    Optional suppressedUntil

    suppressedUntil?: Moment

    when the alarm will stop being suppressed

    +

    Optional troubleTicket

    troubleTicket?: string

    the trouble ticket ID associated with this alarm

    +

    Optional troubleTicketLink

    troubleTicketLink?: string

    the link to the trouble ticket system if defined

    +

    Optional troubleTicketState

    troubleTicketState?: OnmsTroubleTicketState

    the state of the trouble ticket associated with this alarm

    +

    Optional type

    type?: OnmsAlarmType

    the alarm's type

    +

    Optional uei

    uei?: string

    the UEI of the event associated with this alarm

    +

    Accessors

    isAcknowledged

    isSituation

    lastEventTime

    • get lastEventTime(): Moment

    • the most recent time the event has triggered this alarm

      +

      Returns Moment

    urlValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsAlarmSummary.html b/docs/classes/Model.OnmsAlarmSummary.html index a71e2f22fb..c090ee5e40 100644 --- a/docs/classes/Model.OnmsAlarmSummary.html +++ b/docs/classes/Model.OnmsAlarmSummary.html @@ -1,5 +1,5 @@ OnmsAlarmSummary | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsAlarmSummary

    Represents an OpenNMS alarm.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    description? id? label? @@ -9,11 +9,11 @@ type?

    Accessors

    urlValue

    Constructors

    constructor

    Properties

    Optional description

    description?: string

    the alarm's description

    -

    Optional id

    id?: number

    the alarm ID

    -

    Optional label

    label?: string

    the label of this alarm as defined in the alarm configuration

    -

    Optional logMessage

    logMessage?: string

    the alarm's log message

    -

    Optional reductionKey

    reductionKey?: string

    the alarm's reduction key

    -

    Optional severity

    severity?: OnmsSeverity

    the alarm's severity

    -

    Optional type

    type?: OnmsAlarmType

    the alarm's type

    -

    Accessors

    urlValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional id

    id?: number

    the alarm ID

    +

    Optional label

    label?: string

    the label of this alarm as defined in the alarm configuration

    +

    Optional logMessage

    logMessage?: string

    the alarm's log message

    +

    Optional reductionKey

    reductionKey?: string

    the alarm's reduction key

    +

    Optional severity

    severity?: OnmsSeverity

    the alarm's severity

    +

    Optional type

    type?: OnmsAlarmType

    the alarm's type

    +

    Accessors

    urlValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsAlarmType.html b/docs/classes/Model.OnmsAlarmType.html index 207f1ee8af..0646bb6965 100644 --- a/docs/classes/Model.OnmsAlarmType.html +++ b/docs/classes/Model.OnmsAlarmType.html @@ -1,5 +1,5 @@ OnmsAlarmType | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsAlarmType

    Represents an OpenNMS alarm type.

    -

    Hierarchy

    • OnmsEnum<number>
      • OnmsAlarmType

    Implements

    Constructors

    constructor +

    Hierarchy

    • OnmsEnum<number>
      • OnmsAlarmType

    Implements

    Constructors

    constructor

    Accessors

    id index label @@ -9,11 +9,11 @@ toString forId

    Constructors

    constructor

    Accessors

    id

    index

    label

    urlValue

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      -

      Returns string

    toJSON

    • toJSON(): {
          id: number;
          label: string;
      }

    • convert to the JSON representation

      -

      Returns {
          id: number;
          label: string;
      }

      • id: number
      • label: string

    toString

    Static forId

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • id: number
    • label: string

    Returns OnmsAlarmType

    Accessors

    id

    index

    label

    urlValue

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      +

      Returns string

    toJSON

    • toJSON(): {
          id: number;
          label: string;
      }

    • convert to the JSON representation

      +

      Returns {
          id: number;
          label: string;
      }

      • id: number
      • label: string

    toString

    Static forId

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsCategory.html b/docs/classes/Model.OnmsCategory.html index 90c6a68e30..c48d1e2cc5 100644 --- a/docs/classes/Model.OnmsCategory.html +++ b/docs/classes/Model.OnmsCategory.html @@ -1,12 +1,12 @@ OnmsCategory | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsCategory

    Represents an OpenNMS category.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    id name

    Accessors

    urlValue

    Methods

    for

    Constructors

    constructor

    Properties

    id

    id: number

    The service ID.

    -

    name

    name: string

    The service name.

    -

    Accessors

    urlValue

    Methods

    Static for

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • id: number
    • name: string

    Returns OnmsCategory

    Properties

    id

    id: number

    The service ID.

    +

    name

    name: string

    The service name.

    +

    Accessors

    urlValue

    Methods

    Static for

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsCollectType.html b/docs/classes/Model.OnmsCollectType.html index e8b275bed3..723209b994 100644 --- a/docs/classes/Model.OnmsCollectType.html +++ b/docs/classes/Model.OnmsCollectType.html @@ -1,5 +1,5 @@ OnmsCollectType | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsCollectType

    Represents an OpenNMS SNMP interface "should collect" type.

    -

    Hierarchy

    • OnmsEnum<string>
      • OnmsCollectType

    Implements

    Constructors

    constructor +

    Hierarchy

    • OnmsEnum<string>
      • OnmsCollectType

    Implements

    Constructors

    constructor

    Accessors

    id index label @@ -11,14 +11,14 @@ forId forLabel

    Constructors

    constructor

    Accessors

    id

    index

    label

    urlValue

    Methods

    isCollectionEnabled

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      -

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      -

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    Static forLabel

    • forLabel(label?): any

    • given a label, return the matching collect type object

      -

      Parameters

      • Optional label: string

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • id: string
    • label: string

    Returns OnmsCollectType

    Accessors

    id

    index

    label

    urlValue

    Methods

    isCollectionEnabled

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      +

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      +

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    Static forLabel

    • forLabel(label?): any

    • given a label, return the matching collect type object

      +

      Parameters

      • Optional label: string

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsEvent.html b/docs/classes/Model.OnmsEvent.html index 7bf5958368..692677eca7 100644 --- a/docs/classes/Model.OnmsEvent.html +++ b/docs/classes/Model.OnmsEvent.html @@ -1,5 +1,5 @@ OnmsEvent | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsEvent

    Represents an OpenNMS event.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    createTime? description? id? @@ -18,22 +18,22 @@

    Accessors

    serviceName urlValue

    Methods

    fromData -

    Constructors

    constructor

    Properties

    Optional createTime

    createTime?: Moment

    when the event was created

    -

    Optional description

    description?: string

    the description of is event

    -

    Optional id

    id?: number

    the event ID

    -

    Optional ipAddress

    ipAddress?: Address6 | Address4

    the interface associated with this event

    -

    Optional label

    label?: string

    the label of this event as defined in the event configuration

    -

    Optional location

    location?: string

    which location the event originated from

    -

    Optional logMessage

    logMessage?: string

    the log message of the event

    -

    Optional nodeId

    nodeId?: number

    the node's ID associated with this event

    -

    Optional nodeLabel

    nodeLabel?: string

    the node's label associated with this event

    -

    Optional parameters

    parameters?: OnmsParm[]

    the parameters emitted with this alarm's event

    -

    Optional service

    service?: OnmsServiceType

    the service associated with the event

    -

    Optional severity

    severity?: OnmsSeverity

    the severity of this event

    -

    Optional source

    source?: string

    which subsystem the event came from

    -

    Optional time

    time?: Moment

    when the event was received by OpenNMS

    -

    Optional uei

    uei?: string

    the UEI of this event

    -

    Accessors

    serviceName

    urlValue

    Methods

    Static fromData

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional createTime

    createTime?: Moment

    when the event was created

    +

    Optional description

    description?: string

    the description of is event

    +

    Optional id

    id?: number

    the event ID

    +

    Optional ipAddress

    ipAddress?: Address6 | Address4

    the interface associated with this event

    +

    Optional label

    label?: string

    the label of this event as defined in the event configuration

    +

    Optional location

    location?: string

    which location the event originated from

    +

    Optional logMessage

    logMessage?: string

    the log message of the event

    +

    Optional nodeId

    nodeId?: number

    the node's ID associated with this event

    +

    Optional nodeLabel

    nodeLabel?: string

    the node's label associated with this event

    +

    Optional parameters

    parameters?: OnmsParm[]

    the parameters emitted with this alarm's event

    +

    Optional service

    service?: OnmsServiceType

    the service associated with the event

    +

    Optional severity

    severity?: OnmsSeverity

    the severity of this event

    +

    Optional source

    source?: string

    which subsystem the event came from

    +

    Optional time

    time?: Moment

    when the event was received by OpenNMS

    +

    Optional uei

    uei?: string

    the UEI of this event

    +

    Accessors

    serviceName

    urlValue

    Methods

    Static fromData

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsFlowExporter.html b/docs/classes/Model.OnmsFlowExporter.html index 4b6e72c85a..3d69daa70a 100644 --- a/docs/classes/Model.OnmsFlowExporter.html +++ b/docs/classes/Model.OnmsFlowExporter.html @@ -1,5 +1,5 @@ OnmsFlowExporter | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsFlowExporter

    Represents OpenNMS flow information about a node and its interfaces.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    categories? foreignId? foreignSource? @@ -7,9 +7,9 @@ interfaces? label?

    Constructors

    constructor

    Properties

    Optional categories

    categories?: string[]

    the categories the node is in

    -

    Optional foreignId

    foreignId?: string

    node foreign ID

    -

    Optional foreignSource

    foreignSource?: string

    node foreign source

    -

    Optional id

    id?: number

    node unique identifier

    -

    Optional interfaces

    interfaces?: OnmsFlowSnmpInterface[]

    a collection of interface information

    -

    Optional label

    label?: string

    node label

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional foreignId

    foreignId?: string

    node foreign ID

    +

    Optional foreignSource

    foreignSource?: string

    node foreign source

    +

    Optional id

    id?: number

    node unique identifier

    +

    Optional interfaces

    interfaces?: OnmsFlowSnmpInterface[]

    a collection of interface information

    +

    Optional label

    label?: string

    node label

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsFlowExporterSummary.html b/docs/classes/Model.OnmsFlowExporterSummary.html index abd0e1c0fd..3e7a985ab6 100644 --- a/docs/classes/Model.OnmsFlowExporterSummary.html +++ b/docs/classes/Model.OnmsFlowExporterSummary.html @@ -1,13 +1,13 @@ OnmsFlowExporterSummary | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsFlowExporterSummary

    Represents basic OpenNMS flow information about node.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    categories? foreignId? foreignSource? id? label?

    Constructors

    constructor

    Properties

    Optional categories

    categories?: string[]

    the categories the node is in

    -

    Optional foreignId

    foreignId?: string

    node foreign ID

    -

    Optional foreignSource

    foreignSource?: string

    node foreign source

    -

    Optional id

    id?: number

    node unique identifier

    -

    Optional label

    label?: string

    node label

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional foreignId

    foreignId?: string

    node foreign ID

    +

    Optional foreignSource

    foreignSource?: string

    node foreign source

    +

    Optional id

    id?: number

    node unique identifier

    +

    Optional label

    label?: string

    node label

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsFlowSeries.html b/docs/classes/Model.OnmsFlowSeries.html index d905ad2547..eb92896415 100644 --- a/docs/classes/Model.OnmsFlowSeries.html +++ b/docs/classes/Model.OnmsFlowSeries.html @@ -1,13 +1,13 @@ OnmsFlowSeries | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsFlowSeries

    Time series metrics derived from flow data.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    columns? end? start? timestamps? values?

    Constructors

    constructor

    Properties

    Optional columns

    columns?: OnmsFlowSeriesColumn[]

    columns

    -

    Optional end

    end?: Moment

    end time

    -

    Optional start

    start?: Moment

    start time

    -

    Optional timestamps

    timestamps?: number[]

    row timestamps

    -

    Optional values

    values?: number[][]

    cell values

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional end

    end?: Moment

    end time

    +

    Optional start

    start?: Moment

    start time

    +

    Optional timestamps

    timestamps?: number[]

    row timestamps

    +

    Optional values

    values?: number[][]

    cell values

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsFlowSeriesColumn.html b/docs/classes/Model.OnmsFlowSeriesColumn.html index 1dcaabee21..5e938e8bc3 100644 --- a/docs/classes/Model.OnmsFlowSeriesColumn.html +++ b/docs/classes/Model.OnmsFlowSeriesColumn.html @@ -1,7 +1,7 @@ OnmsFlowSeriesColumn | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsFlowSeriesColumn

    Time series column.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    ingress label -

    Constructors

    constructor

    Properties

    ingress

    ingress: boolean

    direction

    -

    label

    label: string

    label

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    ingress

    ingress: boolean

    direction

    +

    label

    label: string

    label

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsFlowSnmpInterface.html b/docs/classes/Model.OnmsFlowSnmpInterface.html index 65571372ef..f4bea3e3c2 100644 --- a/docs/classes/Model.OnmsFlowSnmpInterface.html +++ b/docs/classes/Model.OnmsFlowSnmpInterface.html @@ -1,11 +1,11 @@ OnmsFlowSnmpInterface | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsFlowSnmpInterface

    OpenNMS flow node SNMP interface metadata.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    description? index? name? resourceId?

    Constructors

    constructor

    Properties

    Optional description

    description?: string

    the interface's ifDescription

    -

    Optional index

    index?: number

    the interface's ifIndex

    -

    Optional name

    name?: string

    the interface name

    -

    Optional resourceId

    resourceId?: string

    the interface's OpenNMS resource identifier

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional index

    index?: number

    the interface's ifIndex

    +

    Optional name

    name?: string

    the interface name

    +

    Optional resourceId

    resourceId?: string

    the interface's OpenNMS resource identifier

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsFlowTable.html b/docs/classes/Model.OnmsFlowTable.html index cf07ab0ccf..86a49e02ce 100644 --- a/docs/classes/Model.OnmsFlowTable.html +++ b/docs/classes/Model.OnmsFlowTable.html @@ -1,11 +1,11 @@ OnmsFlowTable | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsFlowTable

    A collection of flow time-series data.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    end? headers? rows? start? -

    Constructors

    constructor

    Properties

    Optional end

    end?: Moment

    end time

    -

    Optional headers

    headers?: string[]

    headers

    -

    Optional rows

    rows?: any[][]

    rows

    -

    Optional start

    start?: Moment

    start time

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Optional end

    end?: Moment

    end time

    +

    Optional headers

    headers?: string[]

    headers

    +

    Optional rows

    rows?: any[][]

    rows

    +

    Optional start

    start?: Moment

    start time

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsIpInterface.html b/docs/classes/Model.OnmsIpInterface.html index abbc9eb303..4c0801f6e3 100644 --- a/docs/classes/Model.OnmsIpInterface.html +++ b/docs/classes/Model.OnmsIpInterface.html @@ -1,5 +1,5 @@ OnmsIpInterface | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsIpInterface

    Represents an OpenNMS IP interface.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    _snmpInterface? hostname? id? @@ -17,19 +17,19 @@

    Accessors

    snmpInterface urlValue

    Constructors

    constructor

    Properties

    Private Optional _snmpInterface

    _snmpInterface?: OnmsSnmpInterface

    store the interface's associated SNMP interface, used by get/set .snmpInterface

    -

    Optional hostname

    hostname?: string

    the hostname

    -

    Optional id

    id?: number

    the interface ID

    -

    Optional ipAddress

    ipAddress?: Address6 | Address4

    the IP address

    -

    Optional isDown

    isDown?: boolean

    whether the interface is down

    -

    Optional isManaged

    isManaged?: OnmsManagedType

    whether the interface is managed

    -

    Optional lastCapsdPoll

    lastCapsdPoll?: Moment

    the last time the interface was provisioned

    -

    Optional lastEgressFlow

    lastEgressFlow?: Moment

    the last time egress flows were received

    -

    Optional lastIngressFlow

    lastIngressFlow?: Moment

    the last time ingress flows were received

    -

    Optional monitoredServiceCount

    monitoredServiceCount?: number

    the number of monitored services this interface has

    -

    Optional node

    node?: any

    the node this interface is associated with

    -

    services

    services: OnmsMonitoredService[] = ...

    the services on this interface

    -

    Optional snmpInterfaceId

    snmpInterfaceId?: number

    the SNMP interface ID associated with this interface

    -

    Optional snmpPrimary

    snmpPrimary?: OnmsPrimaryType

    the SNMP primary status of the interface

    -

    Accessors

    snmpInterface

    urlValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional hostname

    hostname?: string

    the hostname

    +

    Optional id

    id?: number

    the interface ID

    +

    Optional ipAddress

    ipAddress?: Address6 | Address4

    the IP address

    +

    Optional isDown

    isDown?: boolean

    whether the interface is down

    +

    Optional isManaged

    isManaged?: OnmsManagedType

    whether the interface is managed

    +

    Optional lastCapsdPoll

    lastCapsdPoll?: Moment

    the last time the interface was provisioned

    +

    Optional lastEgressFlow

    lastEgressFlow?: Moment

    the last time egress flows were received

    +

    Optional lastIngressFlow

    lastIngressFlow?: Moment

    the last time ingress flows were received

    +

    Optional monitoredServiceCount

    monitoredServiceCount?: number

    the number of monitored services this interface has

    +

    Optional node

    node?: any

    the node this interface is associated with

    +

    services

    services: OnmsMonitoredService[] = ...

    the services on this interface

    +

    Optional snmpInterfaceId

    snmpInterfaceId?: number

    the SNMP interface ID associated with this interface

    +

    Optional snmpPrimary

    snmpPrimary?: OnmsPrimaryType

    the SNMP primary status of the interface

    +

    Accessors

    snmpInterface

    urlValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsManagedType.html b/docs/classes/Model.OnmsManagedType.html index 4e01abbfed..417d848db8 100644 --- a/docs/classes/Model.OnmsManagedType.html +++ b/docs/classes/Model.OnmsManagedType.html @@ -1,5 +1,5 @@ OnmsManagedType | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsManagedType

    Represents an OpenNMS node "is managed" type.

    -

    Hierarchy

    • OnmsEnum<string>
      • OnmsManagedType

    Implements

    Constructors

    constructor +

    Hierarchy

    • OnmsEnum<string>
      • OnmsManagedType

    Implements

    Constructors

    constructor

    Accessors

    id index label @@ -11,14 +11,14 @@ forId forLabel

    Constructors

    constructor

    Accessors

    id

    index

    label

    urlValue

    Methods

    isManaged

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      -

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      -

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    Static forLabel

    • forLabel(label?): any

    • Given a label, return the matching managed type object.

      -

      Parameters

      • Optional label: string

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • id: string
    • label: string

    Returns OnmsManagedType

    Accessors

    id

    index

    label

    urlValue

    Methods

    isManaged

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      +

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      +

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    Static forLabel

    • forLabel(label?): any

    • Given a label, return the matching managed type object.

      +

      Parameters

      • Optional label: string

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsMemo.html b/docs/classes/Model.OnmsMemo.html index 19ba996fa8..d814da8ec7 100644 --- a/docs/classes/Model.OnmsMemo.html +++ b/docs/classes/Model.OnmsMemo.html @@ -1,13 +1,13 @@ OnmsMemo | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsMemo

    Represents an OpenNMS memo.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    author? body? created? id? updated?

    Constructors

    constructor

    Properties

    Optional author

    author?: string

    the user who last updated (or created) the memo

    -

    Optional body

    body?: string

    the content of the memo

    -

    Optional created

    created?: Moment

    when the memo was created

    -

    Optional id

    id?: number

    the memo ID

    -

    Optional updated

    updated?: Moment

    when the memo was last updated

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional body

    body?: string

    the content of the memo

    +

    Optional created

    created?: Moment

    when the memo was created

    +

    Optional id

    id?: number

    the memo ID

    +

    Optional updated

    updated?: Moment

    when the memo was last updated

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsMonitoredService.html b/docs/classes/Model.OnmsMonitoredService.html index bc176bb6b2..6ebb51c2fe 100644 --- a/docs/classes/Model.OnmsMonitoredService.html +++ b/docs/classes/Model.OnmsMonitoredService.html @@ -1,5 +1,5 @@ OnmsMonitoredService | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsMonitoredService

    Represents an OpenNMS monitored service.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    down? id? ipAddress? @@ -14,12 +14,12 @@ type?

    Accessors

    urlValue

    Constructors

    constructor

    Properties

    Optional down

    down?: boolean

    true if the service is down

    -

    Optional id

    id?: number

    the service ID

    -

    Optional ipAddress

    ipAddress?: string

    Optional ipInterface

    ipInterface?: any

    the ipInterface associated with this service

    -

    Optional ipInterfaceId

    ipInterfaceId?: number

    Optional lastFail

    lastFail?: Moment

    the last time the service failed

    -

    Optional lastGood

    lastGood?: Moment

    the last time the service passed

    -

    Optional node

    node?: any

    the node associated with this service

    -

    Optional nodeId

    nodeId?: number

    Optional nodeLabel

    nodeLabel?: string

    Optional status

    status?: OnmsServiceStatusType

    the current status

    -

    Optional type

    type?: OnmsServiceType

    the service type associated with this service

    -

    Accessors

    urlValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional id

    id?: number

    the service ID

    +

    Optional ipAddress

    ipAddress?: string

    Optional ipInterface

    ipInterface?: any

    the ipInterface associated with this service

    +

    Optional ipInterfaceId

    ipInterfaceId?: number

    Optional lastFail

    lastFail?: Moment

    the last time the service failed

    +

    Optional lastGood

    lastGood?: Moment

    the last time the service passed

    +

    Optional node

    node?: any

    the node associated with this service

    +

    Optional nodeId

    nodeId?: number

    Optional nodeLabel

    nodeLabel?: string

    Optional status

    status?: OnmsServiceStatusType

    the current status

    +

    Optional type

    type?: OnmsServiceType

    the service type associated with this service

    +

    Accessors

    urlValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsNode.html b/docs/classes/Model.OnmsNode.html index 0def7e656f..bca74b120b 100644 --- a/docs/classes/Model.OnmsNode.html +++ b/docs/classes/Model.OnmsNode.html @@ -1,5 +1,5 @@ OnmsNode | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsNode

    Represents an OpenNMS node.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    assets categories createTime? @@ -24,26 +24,26 @@ type?

    Accessors

    urlValue

    Constructors

    constructor

    Properties

    assets

    assets: any = ...

    the assets of the node

    -

    categories

    categories: OnmsCategory[] = ...

    the categories the node is in

    -

    Optional createTime

    createTime?: Moment

    the time the node was created

    -

    Optional foreignId

    foreignId?: string

    the foreign ID of the node

    -

    Optional foreignSource

    foreignSource?: string

    the foreign source of the node

    -

    Optional id

    id?: number

    the node ID

    -

    ipInterfaces

    ipInterfaces: OnmsIpInterface[] = ...

    the IP interfaces on this node

    -

    Optional label

    label?: string

    the label (name) of the node

    -

    Optional labelSource

    labelSource?: OnmsNodeLabelSource

    how the label was set

    -

    Optional lastCapsdPoll

    lastCapsdPoll?: Moment

    the last time this node was provisioned

    -

    Optional location

    location?: string

    the location of the node

    -

    Optional netBiosDomain

    netBiosDomain?: string

    the NETBIOS/SMB domain for the node

    -

    Optional netBiosName

    netBiosName?: string

    the NETBIOS/SMB name for the node

    -

    Optional operatingSystem

    operatingSystem?: string

    the operating system of the node

    -

    Optional parent

    parent?: OnmsNode

    the parent of this node

    -

    snmpInterfaces

    snmpInterfaces: OnmsSnmpInterface[] = ...

    the SNMP interfaces on this node

    -

    Optional sysContact

    sysContact?: string

    the SNMP sysContact for the node

    -

    Optional sysDescription

    sysDescription?: string

    the SNMP sysDescription of the node

    -

    Optional sysLocation

    sysLocation?: string

    the SNMP sysLocation of the node

    -

    Optional sysName

    sysName?: string

    the SNMP sysName of the node

    -

    Optional sysObjectId

    sysObjectId?: string

    the SNMP sysObjectId of the node

    -

    Optional type

    type?: OnmsNodeType

    the type of node

    -

    Accessors

    urlValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    categories

    categories: OnmsCategory[] = ...

    the categories the node is in

    +

    Optional createTime

    createTime?: Moment

    the time the node was created

    +

    Optional foreignId

    foreignId?: string

    the foreign ID of the node

    +

    Optional foreignSource

    foreignSource?: string

    the foreign source of the node

    +

    Optional id

    id?: number

    the node ID

    +

    ipInterfaces

    ipInterfaces: OnmsIpInterface[] = ...

    the IP interfaces on this node

    +

    Optional label

    label?: string

    the label (name) of the node

    +

    Optional labelSource

    labelSource?: OnmsNodeLabelSource

    how the label was set

    +

    Optional lastCapsdPoll

    lastCapsdPoll?: Moment

    the last time this node was provisioned

    +

    Optional location

    location?: string

    the location of the node

    +

    Optional netBiosDomain

    netBiosDomain?: string

    the NETBIOS/SMB domain for the node

    +

    Optional netBiosName

    netBiosName?: string

    the NETBIOS/SMB name for the node

    +

    Optional operatingSystem

    operatingSystem?: string

    the operating system of the node

    +

    Optional parent

    parent?: OnmsNode

    the parent of this node

    +

    snmpInterfaces

    snmpInterfaces: OnmsSnmpInterface[] = ...

    the SNMP interfaces on this node

    +

    Optional sysContact

    sysContact?: string

    the SNMP sysContact for the node

    +

    Optional sysDescription

    sysDescription?: string

    the SNMP sysDescription of the node

    +

    Optional sysLocation

    sysLocation?: string

    the SNMP sysLocation of the node

    +

    Optional sysName

    sysName?: string

    the SNMP sysName of the node

    +

    Optional sysObjectId

    sysObjectId?: string

    the SNMP sysObjectId of the node

    +

    Optional type

    type?: OnmsNodeType

    the type of node

    +

    Accessors

    urlValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsNodeLabelSource.html b/docs/classes/Model.OnmsNodeLabelSource.html index e836e4777d..c27a25aea3 100644 --- a/docs/classes/Model.OnmsNodeLabelSource.html +++ b/docs/classes/Model.OnmsNodeLabelSource.html @@ -1,5 +1,5 @@ OnmsNodeLabelSource | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsNodeLabelSource

    Represents an OpenNMS node label source.

    -

    Hierarchy

    • OnmsEnum<string>
      • OnmsNodeLabelSource

    Implements

    Constructors

    constructor +

    Hierarchy

    • OnmsEnum<string>
      • OnmsNodeLabelSource

    Implements

    Constructors

    constructor

    Accessors

    id index label @@ -10,13 +10,13 @@ forId forLabel

    Constructors

    constructor

    Accessors

    id

    index

    label

    urlValue

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      -

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      -

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    Static forLabel

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • id: string
    • label: string

    Returns OnmsNodeLabelSource

    Accessors

    id

    index

    label

    urlValue

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      +

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      +

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    Static forLabel

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsNodeType.html b/docs/classes/Model.OnmsNodeType.html index 57d5253ea5..c8162e8ff9 100644 --- a/docs/classes/Model.OnmsNodeType.html +++ b/docs/classes/Model.OnmsNodeType.html @@ -1,5 +1,5 @@ OnmsNodeType | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsNodeType

    Represents an OpenNMS node type.

    -

    Hierarchy

    • OnmsEnum<string>
      • OnmsNodeType

    Implements

    Constructors

    constructor +

    Hierarchy

    • OnmsEnum<string>
      • OnmsNodeType

    Implements

    Constructors

    constructor

    Accessors

    id index label @@ -10,13 +10,13 @@ forId forLabel

    Constructors

    constructor

    Accessors

    id

    index

    label

    urlValue

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      -

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      -

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    • forId(id?): any

    • Given an ID (A, D, etc.), return the corresponding node type object.

      -

      Parameters

      • Optional id: string

      Returns any

    Static forLabel

    • forLabel(label?): any

    • Given a label (ACTIVE, etc.), return the corresponding node type object.

      -

      Parameters

      • Optional label: string

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • id: string
    • label: string

    Returns OnmsNodeType

    Accessors

    id

    index

    label

    urlValue

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      +

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      +

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    • forId(id?): any

    • Given an ID (A, D, etc.), return the corresponding node type object.

      +

      Parameters

      • Optional id: string

      Returns any

    Static forLabel

    • forLabel(label?): any

    • Given a label (ACTIVE, etc.), return the corresponding node type object.

      +

      Parameters

      • Optional label: string

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsOutage.html b/docs/classes/Model.OnmsOutage.html index 03677f2d54..63fbcccd2e 100644 --- a/docs/classes/Model.OnmsOutage.html +++ b/docs/classes/Model.OnmsOutage.html @@ -1,5 +1,5 @@ OnmsOutage | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsOutage

    Represents an OpenNMS outage.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    foreignId? foreignSource? id? @@ -16,18 +16,18 @@ suppressedBy?

    Accessors

    urlValue

    Constructors

    constructor

    Properties

    Optional foreignId

    foreignId?: string

    the foreign ID asociated with the outage

    -

    Optional foreignSource

    foreignSource?: string

    the foreign source associated with the outage

    -

    Optional id

    id?: number

    the node ID

    -

    Optional ifLostService

    ifLostService?: Moment

    when the outage started

    -

    Optional ifRegainedService

    ifRegainedService?: Moment

    when the outage was resolved

    -

    Optional ipAddress

    ipAddress?: Address6 | Address4

    the IP address associated with the outage

    -

    Optional monitoredService

    monitoredService?: OnmsMonitoredService

    the monitored service associated with the outage

    -

    Optional nodeId

    nodeId?: number

    the ID of the node associated with the outage

    -

    Optional nodeLabel

    nodeLabel?: string

    the label of the node associated with the outage

    -

    Optional perspective

    perspective?: string

    the perspective of the outage

    -

    Optional serviceLostEvent

    serviceLostEvent?: OnmsEvent

    the event associated with the start of the outage

    -

    Optional serviceRegainedEvent

    serviceRegainedEvent?: OnmsEvent

    the event associated with the end of the outage

    -

    Optional suppressTime

    suppressTime?: Moment

    when the outage was suppressed

    -

    Optional suppressedBy

    suppressedBy?: string

    who the outage was suppressed by

    -

    Accessors

    urlValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional foreignSource

    foreignSource?: string

    the foreign source associated with the outage

    +

    Optional id

    id?: number

    the node ID

    +

    Optional ifLostService

    ifLostService?: Moment

    when the outage started

    +

    Optional ifRegainedService

    ifRegainedService?: Moment

    when the outage was resolved

    +

    Optional ipAddress

    ipAddress?: Address6 | Address4

    the IP address associated with the outage

    +

    Optional monitoredService

    monitoredService?: OnmsMonitoredService

    the monitored service associated with the outage

    +

    Optional nodeId

    nodeId?: number

    the ID of the node associated with the outage

    +

    Optional nodeLabel

    nodeLabel?: string

    the label of the node associated with the outage

    +

    Optional perspective

    perspective?: string

    the perspective of the outage

    +

    Optional serviceLostEvent

    serviceLostEvent?: OnmsEvent

    the event associated with the start of the outage

    +

    Optional serviceRegainedEvent

    serviceRegainedEvent?: OnmsEvent

    the event associated with the end of the outage

    +

    Optional suppressTime

    suppressTime?: Moment

    when the outage was suppressed

    +

    Optional suppressedBy

    suppressedBy?: string

    who the outage was suppressed by

    +

    Accessors

    urlValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsParm.html b/docs/classes/Model.OnmsParm.html index 4bbc1d0167..3aed296337 100644 --- a/docs/classes/Model.OnmsParm.html +++ b/docs/classes/Model.OnmsParm.html @@ -1,15 +1,15 @@ OnmsParm | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsParm

    Represents an OpenNMS event or alarm parameter.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    name type valueString

    Accessors

    urlValue value

    Methods

    toString -

    Constructors

    constructor

    Properties

    name

    name: string

    the name of the parm

    -

    type

    type: string

    the parm type

    -

    valueString

    valueString: string

    the raw parm value from the server (as a string)

    -

    Accessors

    urlValue

    value

    • get value(): string | number | Address6 | Address4

    • the value coerced to a native type (if possible)

      -

      Returns string | number | Address6 | Address4

    Methods

    toString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    name

    name: string

    the name of the parm

    +

    type

    type: string

    the parm type

    +

    valueString

    valueString: string

    the raw parm value from the server (as a string)

    +

    Accessors

    urlValue

    value

    • get value(): string | number | Address6 | Address4

    • the value coerced to a native type (if possible)

      +

      Returns string | number | Address6 | Address4

    Methods

    toString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsPrimaryType.html b/docs/classes/Model.OnmsPrimaryType.html index 0160b7ffbd..82302b8b0e 100644 --- a/docs/classes/Model.OnmsPrimaryType.html +++ b/docs/classes/Model.OnmsPrimaryType.html @@ -1,5 +1,5 @@ OnmsPrimaryType | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsPrimaryType

    Represents an OpenNMS "SNMP primary" type.

    -

    Hierarchy

    • OnmsEnum<string>
      • OnmsPrimaryType

    Implements

    Constructors

    constructor +

    Hierarchy

    • OnmsEnum<string>
      • OnmsPrimaryType

    Implements

    Constructors

    constructor

    Accessors

    id index label @@ -11,14 +11,14 @@ forId forLabel

    Constructors

    constructor

    Accessors

    id

    index

    label

    urlValue

    Methods

    isPrimary

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      -

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      -

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    Static forLabel

    • forLabel(label?): any

    • Given a label, return the matching primary type object.

      -

      Parameters

      • Optional label: string

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • id: string
    • label: string

    Returns OnmsPrimaryType

    Accessors

    id

    index

    label

    urlValue

    Methods

    isPrimary

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      +

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      +

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    Static forLabel

    • forLabel(label?): any

    • Given a label, return the matching primary type object.

      +

      Parameters

      • Optional label: string

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsServiceStatusType.html b/docs/classes/Model.OnmsServiceStatusType.html index 623e812749..42df3cabed 100644 --- a/docs/classes/Model.OnmsServiceStatusType.html +++ b/docs/classes/Model.OnmsServiceStatusType.html @@ -1,5 +1,5 @@ OnmsServiceStatusType | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsServiceStatusType

    Represents an OpenNMS monitored service status type.

    -

    Hierarchy

    • OnmsEnum<string>
      • OnmsServiceStatusType

    Implements

    Constructors

    constructor +

    Hierarchy

    • OnmsEnum<string>
      • OnmsServiceStatusType

    Implements

    Constructors

    constructor

    Accessors

    id index label @@ -11,14 +11,14 @@ forId forLabel

    Constructors

    constructor

    Accessors

    id

    index

    label

    urlValue

    Methods

    isManaged

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      -

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      -

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    Static forLabel

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • id: string
    • label: string

    Returns OnmsServiceStatusType

    Accessors

    id

    index

    label

    urlValue

    Methods

    isManaged

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      +

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      +

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    Static forLabel

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsServiceType.html b/docs/classes/Model.OnmsServiceType.html index 26d2b73f22..a1c0037e38 100644 --- a/docs/classes/Model.OnmsServiceType.html +++ b/docs/classes/Model.OnmsServiceType.html @@ -1,12 +1,12 @@ OnmsServiceType | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsServiceType

    Represents an OpenNMS service.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    id name

    Accessors

    urlValue

    Methods

    for

    Constructors

    constructor

    Properties

    id

    id: number

    The service ID.

    -

    name

    name: string

    The service name.

    -

    Accessors

    urlValue

    Methods

    Static for

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • id: number
    • name: string

    Returns OnmsServiceType

    Properties

    id

    id: number

    The service ID.

    +

    name

    name: string

    The service name.

    +

    Accessors

    urlValue

    Methods

    Static for

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsSeverity.html b/docs/classes/Model.OnmsSeverity.html index 723905bf48..d80752254a 100644 --- a/docs/classes/Model.OnmsSeverity.html +++ b/docs/classes/Model.OnmsSeverity.html @@ -1,5 +1,5 @@ OnmsSeverity | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsSeverity

    Represents an OpenNMS severity.

    -

    Hierarchy

    • OnmsEnum<number>
      • OnmsSeverity

    Implements

    Constructors

    constructor +

    Hierarchy

    • OnmsEnum<number>
      • OnmsSeverity

    Implements

    Constructors

    constructor

    Accessors

    id index label @@ -10,11 +10,11 @@ forId forLabel

    Constructors

    constructor

    Accessors

    id

    index

    label

    urlValue

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      -

      Returns string

    toJSON

    • toJSON(): {
          id: number;
          label: string;
      }

    • convert to the JSON representation

      -

      Returns {
          id: number;
          label: string;
      }

      • id: number
      • label: string

    toString

    Static forId

    Static forLabel

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • id: number
    • label: string

    Returns OnmsSeverity

    Accessors

    id

    index

    label

    urlValue

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      +

      Returns string

    toJSON

    • toJSON(): {
          id: number;
          label: string;
      }

    • convert to the JSON representation

      +

      Returns {
          id: number;
          label: string;
      }

      • id: number
      • label: string

    toString

    Static forId

    Static forLabel

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsSituationFeedback.html b/docs/classes/Model.OnmsSituationFeedback.html index 5e73314cef..163a2d8ed2 100644 --- a/docs/classes/Model.OnmsSituationFeedback.html +++ b/docs/classes/Model.OnmsSituationFeedback.html @@ -1,5 +1,5 @@ OnmsSituationFeedback | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsSituationFeedback

    Represents an OpenNMS alarm.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    alarmKey? feedbackType? fingerprint? @@ -11,13 +11,13 @@ user?

    Accessors

    urlValue

    Constructors

    constructor

    Properties

    Optional alarmKey

    alarmKey?: string

    the related alarm reduction key

    -

    Optional feedbackType

    feedbackType?: OnmsSituationFeedbackType

    the related alarm reduction key

    -

    Optional fingerprint

    fingerprint?: string

    signature of situation having given set of alarms

    -

    Optional reason

    reason?: string

    the related alarm reduction key

    -

    Optional rootCause

    rootCause?: boolean

    TRUE if Alarm in this Feedback is the Root Cause of the Situation in this Feedback

    -

    Optional situationKey

    situationKey?: string

    the situation reduction key

    -

    Optional tags

    tags?: string[]

    User defined attributes relating to the Situation/Feedback

    -

    Optional timestamp

    timestamp?: number

    the related alarm reduction key

    -

    Optional user

    user?: string

    the related alarm reduction key

    -

    Accessors

    urlValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional feedbackType

    feedbackType?: OnmsSituationFeedbackType

    the related alarm reduction key

    +

    Optional fingerprint

    fingerprint?: string

    signature of situation having given set of alarms

    +

    Optional reason

    reason?: string

    the related alarm reduction key

    +

    Optional rootCause

    rootCause?: boolean

    TRUE if Alarm in this Feedback is the Root Cause of the Situation in this Feedback

    +

    Optional situationKey

    situationKey?: string

    the situation reduction key

    +

    Optional tags

    tags?: string[]

    User defined attributes relating to the Situation/Feedback

    +

    Optional timestamp

    timestamp?: number

    the related alarm reduction key

    +

    Optional user

    user?: string

    the related alarm reduction key

    +

    Accessors

    urlValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsSituationFeedbackType.html b/docs/classes/Model.OnmsSituationFeedbackType.html index ff4272414f..98acb175ea 100644 --- a/docs/classes/Model.OnmsSituationFeedbackType.html +++ b/docs/classes/Model.OnmsSituationFeedbackType.html @@ -1,5 +1,5 @@ OnmsSituationFeedbackType | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsSituationFeedbackType

    Represents an OpenNMS "SituationFeedback" type.

    -

    Hierarchy

    • OnmsEnum<string>
      • OnmsSituationFeedbackType

    Implements

    Constructors

    constructor +

    Hierarchy

    • OnmsEnum<string>
      • OnmsSituationFeedbackType

    Implements

    Constructors

    constructor

    Accessors

    id index label @@ -10,13 +10,13 @@ forId forLabel

    Constructors

    constructor

    Accessors

    id

    index

    label

    urlValue

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      -

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      -

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    Static forLabel

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • id: string
    • label: string

    Returns OnmsSituationFeedbackType

    Accessors

    id

    index

    label

    urlValue

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      +

      Returns string

    toJSON

    • toJSON(): {
          id: string;
          label: string;
      }

    • convert to the JSON representation

      +

      Returns {
          id: string;
          label: string;
      }

      • id: string
      • label: string

    toString

    Static forId

    Static forLabel

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsSnmpInterface.html b/docs/classes/Model.OnmsSnmpInterface.html index d3f9b714e1..83f1450179 100644 --- a/docs/classes/Model.OnmsSnmpInterface.html +++ b/docs/classes/Model.OnmsSnmpInterface.html @@ -1,5 +1,5 @@ OnmsSnmpInterface | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsSnmpInterface

    Represents an OpenNMS SNMP interface.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    collect? id? ifAdminStatus? @@ -19,21 +19,21 @@

    Accessors

    urlValue

    Methods

    toJSON

    Constructors

    constructor

    Properties

    Optional collect

    collect?: OnmsCollectType

    whether the SNMP interface will be collected

    -

    Optional id

    id?: number

    the interface ID

    -

    Optional ifAdminStatus

    ifAdminStatus?: OnmsSnmpStatusType

    the administrative status of the interface

    -

    Optional ifAlias

    ifAlias?: string

    the alias of the interface

    -

    Optional ifDescr

    ifDescr?: string

    the description of the interface

    -

    Optional ifIndex

    ifIndex?: number

    the SNMP interface index

    -

    Optional ifName

    ifName?: string

    the name of the interface

    -

    Optional ifOperStatus

    ifOperStatus?: OnmsSnmpStatusType

    the operator status of the interface

    -

    Optional ifSpeed

    ifSpeed?: number

    the speed of the interface

    -

    Optional ifType

    ifType?: number

    the type of interface

    -

    Optional lastCapsdPoll

    lastCapsdPoll?: Moment

    the last time the SNMP interface was provisioned

    -

    Optional lastSnmpPoll

    lastSnmpPoll?: Moment

    the last time the SNMP interface was polled

    -

    Optional node

    node?: any

    the node associated with this interface

    -

    Optional nodeId

    nodeId?: number

    The node associated to this snmpInterface

    -

    Optional physAddr

    physAddr?: PhysAddr

    the physical (MAC) address of the interface

    -

    Optional poll

    poll?: boolean

    whether the interface is set to poll

    -

    Accessors

    urlValue

    Methods

    toJSON

    • toJSON(): {
          collect: {
              id: string;
              label: string;
          };
          id: number;
          ifAdminStatus: {
              id: number;
              label: string;
          };
          ifAlias: string;
          ifDescr: string;
          ifIndex: number;
          ifName: string;
          ifOperStatus: {
              id: number;
              label: string;
          };
          ifSpeed: number;
          ifType: number;
          lastCapsdPoll: number;
          lastSnmpPoll: string;
          nodeId: number;
          physAddr: string;
          poll: boolean;
      }

    • convert to JSON object

      -

      Returns {
          collect: {
              id: string;
              label: string;
          };
          id: number;
          ifAdminStatus: {
              id: number;
              label: string;
          };
          ifAlias: string;
          ifDescr: string;
          ifIndex: number;
          ifName: string;
          ifOperStatus: {
              id: number;
              label: string;
          };
          ifSpeed: number;
          ifType: number;
          lastCapsdPoll: number;
          lastSnmpPoll: string;
          nodeId: number;
          physAddr: string;
          poll: boolean;
      }

      • collect: {
            id: string;
            label: string;
        }
        • id: string
        • label: string
      • id: number
      • ifAdminStatus: {
            id: number;
            label: string;
        }
        • id: number
        • label: string
      • ifAlias: string
      • ifDescr: string
      • ifIndex: number
      • ifName: string
      • ifOperStatus: {
            id: number;
            label: string;
        }
        • id: number
        • label: string
      • ifSpeed: number
      • ifType: number
      • lastCapsdPoll: number
      • lastSnmpPoll: string
      • nodeId: number
      • physAddr: string
      • poll: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional id

    id?: number

    the interface ID

    +

    Optional ifAdminStatus

    ifAdminStatus?: OnmsSnmpStatusType

    the administrative status of the interface

    +

    Optional ifAlias

    ifAlias?: string

    the alias of the interface

    +

    Optional ifDescr

    ifDescr?: string

    the description of the interface

    +

    Optional ifIndex

    ifIndex?: number

    the SNMP interface index

    +

    Optional ifName

    ifName?: string

    the name of the interface

    +

    Optional ifOperStatus

    ifOperStatus?: OnmsSnmpStatusType

    the operator status of the interface

    +

    Optional ifSpeed

    ifSpeed?: number

    the speed of the interface

    +

    Optional ifType

    ifType?: number

    the type of interface

    +

    Optional lastCapsdPoll

    lastCapsdPoll?: Moment

    the last time the SNMP interface was provisioned

    +

    Optional lastSnmpPoll

    lastSnmpPoll?: Moment

    the last time the SNMP interface was polled

    +

    Optional node

    node?: any

    the node associated with this interface

    +

    Optional nodeId

    nodeId?: number

    The node associated to this snmpInterface

    +

    Optional physAddr

    physAddr?: PhysAddr

    the physical (MAC) address of the interface

    +

    Optional poll

    poll?: boolean

    whether the interface is set to poll

    +

    Accessors

    urlValue

    Methods

    toJSON

    • toJSON(): {
          collect: {
              id: string;
              label: string;
          };
          id: number;
          ifAdminStatus: {
              id: number;
              label: string;
          };
          ifAlias: string;
          ifDescr: string;
          ifIndex: number;
          ifName: string;
          ifOperStatus: {
              id: number;
              label: string;
          };
          ifSpeed: number;
          ifType: number;
          lastCapsdPoll: number;
          lastSnmpPoll: string;
          nodeId: number;
          physAddr: string;
          poll: boolean;
      }

    • convert to JSON object

      +

      Returns {
          collect: {
              id: string;
              label: string;
          };
          id: number;
          ifAdminStatus: {
              id: number;
              label: string;
          };
          ifAlias: string;
          ifDescr: string;
          ifIndex: number;
          ifName: string;
          ifOperStatus: {
              id: number;
              label: string;
          };
          ifSpeed: number;
          ifType: number;
          lastCapsdPoll: number;
          lastSnmpPoll: string;
          nodeId: number;
          physAddr: string;
          poll: boolean;
      }

      • collect: {
            id: string;
            label: string;
        }
        • id: string
        • label: string
      • id: number
      • ifAdminStatus: {
            id: number;
            label: string;
        }
        • id: number
        • label: string
      • ifAlias: string
      • ifDescr: string
      • ifIndex: number
      • ifName: string
      • ifOperStatus: {
            id: number;
            label: string;
        }
        • id: number
        • label: string
      • ifSpeed: number
      • ifType: number
      • lastCapsdPoll: number
      • lastSnmpPoll: string
      • nodeId: number
      • physAddr: string
      • poll: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsSnmpStatusType.html b/docs/classes/Model.OnmsSnmpStatusType.html index 3d76558372..ee4941b6c0 100644 --- a/docs/classes/Model.OnmsSnmpStatusType.html +++ b/docs/classes/Model.OnmsSnmpStatusType.html @@ -1,5 +1,5 @@ OnmsSnmpStatusType | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsSnmpStatusType

    Represents an OpenNMS SNMP admin/oper status type.

    -

    Hierarchy

    • OnmsEnum<number>
      • OnmsSnmpStatusType

    Implements

    Constructors

    constructor +

    Hierarchy

    • OnmsEnum<number>
      • OnmsSnmpStatusType

    Implements

    Constructors

    constructor

    Accessors

    id index label @@ -10,13 +10,13 @@ forId forLabel

    Constructors

    constructor

    Accessors

    id

    index

    label

    urlValue

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      -

      Returns string

    toJSON

    • toJSON(): {
          id: number;
          label: string;
      }

    • convert to the JSON representation

      -

      Returns {
          id: number;
          label: string;
      }

      • id: number
      • label: string

    toString

    Static forId

    Static forLabel

    • forLabel(label?): any

    • Given a label, return the matching snmp status type object.

      -

      Parameters

      • Optional label: string

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • id: number
    • label: string

    Returns OnmsSnmpStatusType

    Accessors

    id

    index

    label

    urlValue

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      +

      Returns string

    toJSON

    • toJSON(): {
          id: number;
          label: string;
      }

    • convert to the JSON representation

      +

      Returns {
          id: number;
          label: string;
      }

      • id: number
      • label: string

    toString

    Static forId

    Static forLabel

    • forLabel(label?): any

    • Given a label, return the matching snmp status type object.

      +

      Parameters

      • Optional label: string

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.OnmsTroubleTicketState.html b/docs/classes/Model.OnmsTroubleTicketState.html index 0ed8f2188b..d26ecbe2c3 100644 --- a/docs/classes/Model.OnmsTroubleTicketState.html +++ b/docs/classes/Model.OnmsTroubleTicketState.html @@ -1,5 +1,5 @@ OnmsTroubleTicketState | OpenNMS.js - v2.5.9-SNAPSHOT

    Class OnmsTroubleTicketState

    Represents an OpenNMS trouble ticket state.

    -

    Hierarchy

    • OnmsEnum<number>
      • OnmsTroubleTicketState

    Implements

    Constructors

    constructor +

    Hierarchy

    • OnmsEnum<number>
      • OnmsTroubleTicketState

    Implements

    Constructors

    constructor

    Accessors

    id index label @@ -10,11 +10,11 @@ forId forLabel

    Constructors

    constructor

    Accessors

    id

    index

    label

    urlValue

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      -

      Returns string

    toJSON

    • toJSON(): {
          id: number;
          label: string;
      }

    • convert to the JSON representation

      -

      Returns {
          id: number;
          label: string;
      }

      • id: number
      • label: string

    toString

    Static forId

    Static forLabel

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • id: number
    • label: string

    Returns OnmsTroubleTicketState

    Accessors

    id

    index

    label

    urlValue

    Methods

    toDisplayString

    • toDisplayString(): string

    • convert this enum to a string suitable for display

      +

      Returns string

    toJSON

    • toJSON(): {
          id: number;
          label: string;
      }

    • convert to the JSON representation

      +

      Returns {
          id: number;
          label: string;
      }

      • id: number
      • label: string

    toString

    Static forId

    Static forLabel

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Model.PhysAddr.html b/docs/classes/Model.PhysAddr.html index d350d698ec..38c37fe1f6 100644 --- a/docs/classes/Model.PhysAddr.html +++ b/docs/classes/Model.PhysAddr.html @@ -1,9 +1,9 @@ PhysAddr | OpenNMS.js - v2.5.9-SNAPSHOT

    Class PhysAddr

    Represents a physical (MAC) address.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Properties

    addr

    Accessors

    urlValue

    Methods

    toString -

    Constructors

    constructor

    Properties

    addr

    addr: string

    The MAC address string.

    -

    Accessors

    urlValue

    Methods

    toString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    addr

    addr: string

    The MAC address string.

    +

    Accessors

    urlValue

    Methods

    toString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Rest.AbstractHTTP.html b/docs/classes/Rest.AbstractHTTP.html index 091d31543d..a9992e9e77 100644 --- a/docs/classes/Rest.AbstractHTTP.html +++ b/docs/classes/Rest.AbstractHTTP.html @@ -1,6 +1,6 @@ AbstractHTTP | OpenNMS.js - v2.5.9-SNAPSHOT

    Class AbstractHTTPAbstract

    Abstract implementation of the OnmsHTTP interface meant to be extended by a concrete class.

    Implements

    IOnmsHTTP

    -

    Hierarchy

    Implements

    Constructors

    constructor +

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Accessors

    options server

    Methods

    get @@ -17,26 +17,26 @@

    Constructors

    constructor

    Accessors

    options

    server

    Methods

    Abstract get

    Protected getData

    • getData(response): any

    • Attempt to extract the data from a response.

      -

      Parameters

      • response: any

      Returns any

    Protected getOptions

    • getOptions(options?): OnmsHTTPOptions

    • Get the union of [[OnmsHTTPOptions]] based on the passed options, defaults, +

    Returns AbstractHTTP

    Accessors

    options

    server

    Methods

    Abstract get

    Protected getData

    • getData(response): any

    • Attempt to extract the data from a response.

      +

      Parameters

      • response: any

      Returns any

    Protected getOptions

    Protected getServer

    Protected getServer

    • getServer(options?): OnmsServer

    • Get the [[OnmsServer]] object that should be used for making requests. Favors the one passed in the [[OnmsHTTPOptions]], otherwise it falls back to the default server associated with the HTTP implementation.

      -

      Parameters

      Returns OnmsServer

    Abstract head

    Abstract httpDelete

    Protected onSetServer

    Abstract head

    Abstract httpDelete

    Protected onSetServer

    • onSetServer(): void

    • Implementers should override this method if they have actions that need to be performed (like clearing a cache) when server settings change.

      -

      Returns void

    Abstract post

    Abstract put

    Protected transformJSON

    • transformJSON(data): any

    • A convenience method for implementers to use to turn JSON into a javascript object. +

      Returns void

    Abstract post

    Abstract put

    Protected transformJSON

    • transformJSON(data): any

    • A convenience method for implementers to use to turn JSON into a javascript object. Use this to process a JSON response before returning it in an [[OnmsResult]] object.

      -

      Parameters

      • data: any

      Returns any

    Protected transformXML

    • transformXML(data): any

    • A convenience method for implementers to use to turn XML into a javascript object. +

      Parameters

      • data: any

      Returns any

    Protected transformXML

    • transformXML(data): any

    • A convenience method for implementers to use to turn XML into a javascript object. Use this to process an XML response before returning it in an [[OnmsResult]] object.

      -

      Parameters

      • data: any

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • data: any

    Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Rest.AxiosHTTP.html b/docs/classes/Rest.AxiosHTTP.html index f0f33c7846..7f58832b62 100644 --- a/docs/classes/Rest.AxiosHTTP.html +++ b/docs/classes/Rest.AxiosHTTP.html @@ -1,6 +1,6 @@ AxiosHTTP | OpenNMS.js - v2.5.9-SNAPSHOT

    Class AxiosHTTP

    Implementation of the [[IOnmsHTTP]] interface using Axios: https://github.com/mzabriskie/axios

    Implements

    IOnmsHTTP

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    axiosObj?

    Accessors

    options server @@ -17,30 +17,30 @@ transformXML

    Constructors

    constructor

    • new AxiosHTTP(server?, axiosImpl?, timeout?): AxiosHTTP

    • Construct an AxiosHTTP instance.

      Parameters

      • Optional server: OnmsServer

        The server to connect to.

        -
      • Optional axiosImpl: AxiosStatic

        The Axios implementation class to use.

        +
      • Optional axiosImpl: AxiosStatic

        The Axios implementation class to use.

      • timeout: number = 10000

        The default timeout for ReST connections.

        -

      Returns AxiosHTTP

    Properties

    Private Optional axiosObj

    axiosObj?: AxiosInstance

    The Axios instance we'll use for making ReST calls. This will be reinitialized whenever +

    Returns AxiosHTTP

    Properties

    Private Optional axiosObj

    axiosObj?: AxiosInstance

    The Axios instance we'll use for making ReST calls. This will be reinitialized whenever the server configuration changes.

    -

    Accessors

    options

    server

    Methods

    get

    Protected getData

    Protected getOptions

    Accessors

    options

    server

    Methods

    get

    Protected getData

    Protected getOptions

    Protected getServer

    Protected getServer

    head

    httpDelete

    Protected onSetServer

    head

    httpDelete

    Protected onSetServer

    post

    put

    Protected transformJSON

    post

    put

    Protected transformJSON

    • transformJSON(data): any

    • A convenience method for implementers to use to turn JSON into a javascript object. Use this to process a JSON response before returning it in an [[OnmsResult]] object.

      -

      Parameters

      • data: any

      Returns any

    Protected transformXML

    Protected transformXML

    • transformXML(data): any

    • A convenience method for implementers to use to turn XML into a javascript object. Use this to process an XML response before returning it in an [[OnmsResult]] object.

      -

      Parameters

      • data: any

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • data: any

    Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Rest.GrafanaError.html b/docs/classes/Rest.GrafanaError.html index 5bbb44cf27..6db7cf235b 100644 --- a/docs/classes/Rest.GrafanaError.html +++ b/docs/classes/Rest.GrafanaError.html @@ -1,5 +1,5 @@ GrafanaError | OpenNMS.js - v2.5.9-SNAPSHOT

    Class GrafanaError

    A Grafana error object.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    message name stack? @@ -13,9 +13,11 @@
  • Optional code: number

    The response code of the response.

  • Optional options: any

    The request options (configuration).

  • Optional data: any

    The payload of the response.

    -

    • Returns GrafanaError

    Properties

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    code

    • get code(): number

    • The error code associated with this error.

      -

      Returns number

    Methods

    toString

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns GrafanaError

    Properties

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Type declaration

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    +

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    code

    • get code(): number

    • The error code associated with this error.

      +

      Returns number

    Methods

    toString

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      +

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Rest.GrafanaHTTP.html b/docs/classes/Rest.GrafanaHTTP.html index f985f353b4..ff2a52647e 100644 --- a/docs/classes/Rest.GrafanaHTTP.html +++ b/docs/classes/Rest.GrafanaHTTP.html @@ -1,6 +1,6 @@ GrafanaHTTP | OpenNMS.js - v2.5.9-SNAPSHOT

    Class GrafanaHTTP

    Implementation of the [[IOnmsHTTP]] interface for Grafana.

    Implements

    IOnmsHTTP

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Accessors

    options server

    Methods

    get @@ -17,26 +17,26 @@

    Constructors

    constructor

    Accessors

    options

    server

    Methods

    get

    Protected getData

    Protected getOptions

    • getOptions(options?): OnmsHTTPOptions

    • Get the union of [[OnmsHTTPOptions]] based on the passed options, defaults, +

    • Optional timeout: number

    Returns GrafanaHTTP

    Accessors

    options

    server

    Methods

    get

    Protected getData

    Protected getOptions

    Protected getServer

    Protected getServer

    head

    httpDelete

    Protected onSetServer

    head

    httpDelete

    Protected onSetServer

    post

    put

    Protected transformJSON

    post

    put

    Protected transformJSON

    • transformJSON(data): any

    • A convenience method for implementers to use to turn JSON into a javascript object. Use this to process a JSON response before returning it in an [[OnmsResult]] object.

      -

      Parameters

      • data: any

      Returns any

    Protected transformXML

    Protected transformXML

    • transformXML(data): any

    • A convenience method for implementers to use to turn XML into a javascript object. Use this to process an XML response before returning it in an [[OnmsResult]] object.

      -

      Parameters

      • data: any

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • data: any

    Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Rest.JsonTransformer.html b/docs/classes/Rest.JsonTransformer.html index 78a8566582..61ec50a643 100644 --- a/docs/classes/Rest.JsonTransformer.html +++ b/docs/classes/Rest.JsonTransformer.html @@ -1,6 +1,6 @@ JsonTransformer | OpenNMS.js - v2.5.9-SNAPSHOT

    Class JsonTransformer

    Helper to transform a json string to an json object.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    transform

    Constructors

    constructor

    Methods

    transform

    • transform(data): any

    • A convenience method for implementers to use to turn JSON into a javascript object. Use this to process a JSON response before returning it in an [[OnmsResult]] object.

      -

      Parameters

      • data: any

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • data: any

    Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Rest.XmlTransformer.html b/docs/classes/Rest.XmlTransformer.html index fca8e13dfe..c0927fefc9 100644 --- a/docs/classes/Rest.XmlTransformer.html +++ b/docs/classes/Rest.XmlTransformer.html @@ -1,6 +1,6 @@ XmlTransformer | OpenNMS.js - v2.5.9-SNAPSHOT

    Class XmlTransformer

    Helper class to transform any xml string to a javascript object.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    transform

    Constructors

    constructor

    Methods

    transform

    • transform(data): any

    • A convenience method for implementers to use to turn XML into a javascript object. Use this to process an XML response before returning it in an [[OnmsResult]] object.

      -

      Parameters

      • data: any

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • data: any

    Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html new file mode 100644 index 0000000000..c42f3c7050 --- /dev/null +++ b/docs/hierarchy.html @@ -0,0 +1 @@ +OpenNMS.js - v2.5.9-SNAPSHOT

    OpenNMS.js - v2.5.9-SNAPSHOT

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 07130f7387..999f6fee98 100644 --- a/docs/index.html +++ b/docs/index.html @@ -63,4 +63,4 @@
  • create, update, and delete alarm sticky memos
  • create, update, and delete alarm journal memos
    • -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/API.IFilterProcessor.html b/docs/interfaces/API.IFilterProcessor.html index c292e59512..70f76bf3c9 100644 --- a/docs/interfaces/API.IFilterProcessor.html +++ b/docs/interfaces/API.IFilterProcessor.html @@ -1,4 +1,4 @@ IFilterProcessor | OpenNMS.js - v2.5.9-SNAPSHOT

    Interface IFilterProcessor

    Interface that represents a processor to convert a [[Filter]] into a set of HTTP parameters.

    -
    interface IFilterProcessor {
        getParameters(filter): IHash<string | string[]>;
    }

    Implemented by

    Methods

    getParameters +
    interface IFilterProcessor {
        getParameters(filter): IHash<string | string[]>;
    }

    Implemented by

    Methods

    getParameters

    Methods

    getParameters

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns IHash<string | string[]>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/API.IFilterVisitor.html b/docs/interfaces/API.IFilterVisitor.html index dfd94c52d1..552786d535 100644 --- a/docs/interfaces/API.IFilterVisitor.html +++ b/docs/interfaces/API.IFilterVisitor.html @@ -1,10 +1,14 @@ IFilterVisitor | OpenNMS.js - v2.5.9-SNAPSHOT

    Interface IFilterVisitor

    A visitor for filters.

    -
    interface IFilterVisitor {
        onClause?: ((clause) => void);
        onFilter?: ((filter) => void);
        onNestedRestriction?: ((restriction) => void);
        onRestriction?: ((restriction) => void);
    }

    Properties

    onClause? +
    interface IFilterVisitor {
        onClause?: ((clause) => void);
        onFilter?: ((filter) => void);
        onNestedRestriction?: ((restriction) => void);
        onRestriction?: ((restriction) => void);
    }

    Properties

    onClause? onFilter? onNestedRestriction? onRestriction? -

    Properties

    Optional onClause

    onClause?: ((clause) => void)

    Type declaration

      • (clause): void

      • Process a [[Clause]]

        -

        Parameters

        Returns void

    Optional onFilter

    onFilter?: ((filter) => void)

    Type declaration

      • (filter): void

      • Process a [[Filter]]

        -

        Parameters

        Returns void

    Optional onNestedRestriction

    onNestedRestriction?: ((restriction) => void)

    Type declaration

      • (restriction): void

      • Process a [[NestedRestriction]]

        -

        Parameters

        Returns void

    Optional onRestriction

    onRestriction?: ((restriction) => void)

    Type declaration

      • (restriction): void

      • Process a [[Restriction]]

        -

        Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional onClause

    onClause?: ((clause) => void)

    Process a [[Clause]]

    +

    Type declaration

      • (clause): void

      • Process a [[Clause]]

        +

        Parameters

        Returns void

    Optional onFilter

    onFilter?: ((filter) => void)

    Process a [[Filter]]

    +

    Type declaration

      • (filter): void

      • Process a [[Filter]]

        +

        Parameters

        Returns void

    Optional onNestedRestriction

    onNestedRestriction?: ((restriction) => void)

    Process a [[NestedRestriction]]

    +

    Type declaration

      • (restriction): void

      • Process a [[NestedRestriction]]

        +

        Parameters

        Returns void

    Optional onRestriction

    onRestriction?: ((restriction) => void)

    Process a [[Restriction]]

    +

    Type declaration

      • (restriction): void

      • Process a [[Restriction]]

        +

        Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/API.IHasHTTP.html b/docs/interfaces/API.IHasHTTP.html index a41c2dbf5f..6a0d6b6fb4 100644 --- a/docs/interfaces/API.IHasHTTP.html +++ b/docs/interfaces/API.IHasHTTP.html @@ -1,6 +1,6 @@ IHasHTTP | OpenNMS.js - v2.5.9-SNAPSHOT

    Interface IHasHTTP

    Interface for a class that has an HTTP object.

    This exists to avoid import loops between the DAOs (that need to easily access [[IOnmsHTTP]]) and the [[Client]] which needs to contain an [[IOnmsHTTP]].

    -
    interface IHasHTTP {
        http: IOnmsHTTP;
    }

    Implemented by

    Properties

    http +
    interface IHasHTTP {
        http: IOnmsHTTP;
    }

    Implemented by

    Properties

    http

    Properties

    http

    http: IOnmsHTTP

    The HTTP implementation this object should contain.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/API.IHasUrlValue.html b/docs/interfaces/API.IHasUrlValue.html index 444cd673c0..b06c38200d 100644 --- a/docs/interfaces/API.IHasUrlValue.html +++ b/docs/interfaces/API.IHasUrlValue.html @@ -2,6 +2,6 @@

    Any module implementing this interface should have a urlValue property (ideally a property getter) which represents how the object should be represented when serialized to an OpenNMS URL parameter.

    -
    interface IHasUrlValue {
        urlValue: string;
    }

    Implemented by

    Properties

    urlValue +
    interface IHasUrlValue {
        urlValue: string;
    }

    Implemented by

    Properties

    urlValue

    Properties

    urlValue

    urlValue: string

    The value of this object when added to an OpenNMS URL parameter.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/API.IHash.html b/docs/interfaces/API.IHash.html index 99f2f4b72c..ae3d932f82 100644 --- a/docs/interfaces/API.IHash.html +++ b/docs/interfaces/API.IHash.html @@ -1,3 +1,3 @@ IHash | OpenNMS.js - v2.5.9-SNAPSHOT

    Interface IHash<T>

    A hash type for use in interfaces.

    -
    interface IHash {
        [key: string]: T;
    }

    Type Parameters

    • T

    Indexable

    [key: string]: T

    Key must be string, value must be of type T.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
    interface IHash<T> {
        [key: string]: T;
    }

    Type Parameters

    • T

    Indexable

    [key: string]: T

    Key must be string, value must be of type T.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/API.IOnmsHTTP.html b/docs/interfaces/API.IOnmsHTTP.html index 0606db4443..b461e3d2fb 100644 --- a/docs/interfaces/API.IOnmsHTTP.html +++ b/docs/interfaces/API.IOnmsHTTP.html @@ -27,7 +27,7 @@

    Note that if you subclass [[AbstractHTTP]], [[AbstractHTTP.getOptions]] will automatically provide you a hydrated [[OnmsHTTPOptions]] that handles most of this precedence for combining the server metadata.

    -
    interface IOnmsHTTP {
        options?: OnmsHTTPOptions;
        server?: OnmsServer;
        get(url, options?): Promise<OnmsResult<any>>;
        head(url, options?): Promise<OnmsResult<any>>;
        httpDelete(url, options?): Promise<OnmsResult<any>>;
        post(url, options?): Promise<OnmsResult<any>>;
        put(url, options?): Promise<OnmsResult<any>>;
    }

    Implemented by

    Properties

    options? +
    interface IOnmsHTTP {
        options?: OnmsHTTPOptions;
        server?: OnmsServer;
        get(url, options?): Promise<OnmsResult<any>>;
        head(url, options?): Promise<OnmsResult<any>>;
        httpDelete(url, options?): Promise<OnmsResult<any>>;
        post(url, options?): Promise<OnmsResult<any>>;
        put(url, options?): Promise<OnmsResult<any>>;
    }

    Implemented by

    Properties

    options? server?

    Methods

    get head @@ -35,25 +35,25 @@ post put

    Properties

    Optional options

    options?: OnmsHTTPOptions

    The default options used when making requests with this instance.

    -

    Optional server

    server?: OnmsServer

    The server associated with this instance.

    -

    Methods

    get

    Optional server

    server?: OnmsServer

    The server associated with this instance.

    +

    Methods

    get

    • get(url, options?): Promise<OnmsResult<any>>

    • Perform an HTTP GET to the provided URL.

      Parameters

      • url: string

        The URL to connect to.

      • Optional options: OnmsHTTPOptions

        The [[OnmsHTTPOptions]] options to use when connecting.

        -

      Returns Promise<OnmsResult<any>>

      An [[OnmsResult]] result object.

      -

    head

    • head(url, options?): Promise<OnmsResult<any>>

    • Perform an HTTP HEAD to the provided URL.

      +

    Returns Promise<OnmsResult<any>>

    An [[OnmsResult]] result object.

    +

    head

    • head(url, options?): Promise<OnmsResult<any>>

    • Perform an HTTP HEAD to the provided URL.

      Parameters

      • url: string

        The URL to connect to.

      • Optional options: OnmsHTTPOptions

        The [[OnmsHTTPOptions]] options to use when connecting.

        -

      Returns Promise<OnmsResult<any>>

      An [[OnmsResult]] result object.

      -

    httpDelete

    • httpDelete(url, options?): Promise<OnmsResult<any>>

    • Perform an HTTP DELETE to the provided URL.

      +

    Returns Promise<OnmsResult<any>>

    An [[OnmsResult]] result object.

    +

    httpDelete

    • httpDelete(url, options?): Promise<OnmsResult<any>>

    • Perform an HTTP DELETE to the provided URL.

      Parameters

      • url: string

        The URL to connect to.

      • Optional options: OnmsHTTPOptions

        The [[OnmsHTTPOptions]] options to use when connecting.

        -

      Returns Promise<OnmsResult<any>>

      An [[OnmsResult]] result object.

      -

    post

    • post(url, options?): Promise<OnmsResult<any>>

    • Perform an HTTP POST to the provided URL.

      +

    Returns Promise<OnmsResult<any>>

    An [[OnmsResult]] result object.

    +

    post

    • post(url, options?): Promise<OnmsResult<any>>

    • Perform an HTTP POST to the provided URL.

      Parameters

      • url: string

        The URL to connect to.

      • Optional options: OnmsHTTPOptions

        The [[OnmsHTTPOptions]] options to use when connecting.

        -

      Returns Promise<OnmsResult<any>>

      An [[OnmsResult]] result object.

      -

    put

    • put(url, options?): Promise<OnmsResult<any>>

    • Perform an HTTP PUT to the provided URL.

      +

    Returns Promise<OnmsResult<any>>

    An [[OnmsResult]] result object.

    +

    put

    • put(url, options?): Promise<OnmsResult<any>>

    • Perform an HTTP PUT to the provided URL.

      Parameters

      • url: string

        The URL to connect to.

      • Optional options: OnmsHTTPOptions

        The [[OnmsHTTPOptions]] options to use when connecting.

        -

      Returns Promise<OnmsResult<any>>

      An [[OnmsResult]] result object.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<OnmsResult<any>>

    An [[OnmsResult]] result object.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/DAO.ITopNOptions.html b/docs/interfaces/DAO.ITopNOptions.html index e8e6fa9ac2..22b84a2c09 100644 --- a/docs/interfaces/DAO.ITopNOptions.html +++ b/docs/interfaces/DAO.ITopNOptions.html @@ -1,5 +1,5 @@ ITopNOptions | OpenNMS.js - v2.5.9-SNAPSHOT

    Interface ITopNOptions

    Preferred object for providing options to TopN queries.

    -
    interface ITopNOptions {
        N: number;
        end?: number;
        exporterNodeCriteria?: string;
        ifIndex?: number;
        includeOther?: boolean;
        start?: number;
        step?: number;
    }

    Properties

    N +
    interface ITopNOptions {
        N: number;
        end?: number;
        exporterNodeCriteria?: string;
        ifIndex?: number;
        includeOther?: boolean;
        start?: number;
        step?: number;
    }

    Properties

    N end? exporterNodeCriteria? ifIndex? @@ -7,10 +7,10 @@ start? step?

    Properties

    N

    N: number

    how many series to return

    -

    Optional end

    end?: number

    the end of the timespan to query

    -

    Optional exporterNodeCriteria

    exporterNodeCriteria?: string

    the node ID or foreignSource:foreignId tuple

    -

    Optional ifIndex

    ifIndex?: number

    filter based on SNMP interface

    -

    Optional includeOther

    includeOther?: boolean

    include an additional "other" result for non-matches

    -

    Optional start

    start?: number

    the start of the timespan to query

    -

    Optional step

    step?: number

    the requested time interval between rows

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional end

    end?: number

    the end of the timespan to query

    +

    Optional exporterNodeCriteria

    exporterNodeCriteria?: string

    the node ID or foreignSource:foreignId tuple

    +

    Optional ifIndex

    ifIndex?: number

    filter based on SNMP interface

    +

    Optional includeOther

    includeOther?: boolean

    include an additional "other" result for non-matches

    +

    Optional start

    start?: number

    the start of the timespan to query

    +

    Optional step

    step?: number

    the requested time interval between rows

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/DAO.IValueProvider.html b/docs/interfaces/DAO.IValueProvider.html index 6f40f630f3..3e4015de0b 100644 --- a/docs/interfaces/DAO.IValueProvider.html +++ b/docs/interfaces/DAO.IValueProvider.html @@ -1,7 +1,7 @@ IValueProvider | OpenNMS.js - v2.5.9-SNAPSHOT

    Interface IValueProvider

    Interface to provide values to a certain property ID.

    -
    interface IValueProvider {
        findValues(propertyId, options?): Promise<any>;
    }

    Methods

    findValues -

    Methods

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      +
    interface IValueProvider {
        findValues(propertyId, options?): Promise<any>;
    }

    Methods

    findValues +

    Methods

    findValues

    • findValues(propertyId, options?): Promise<any>

    • Finds the values for the given propertyId, if it exists.

      Parameters

      • propertyId: string

        The propertyId to find the values for

      • Optional options: any

        Some additional options. May be implementer dependent, such as limit, or value restrictions

        -

      Returns Promise<any>

      A promise containing the values.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<any>

    A promise containing the values.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index ac5cf0061c..7e9faacd2a 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -98,4 +98,4 @@ V2FilterProcessor XmlTransformer log -

    Other

    AbstractHTTP

    Re-exports AbstractHTTP

    AlarmDAO

    Re-exports AlarmDAO

    AlarmTypes

    Re-exports AlarmTypes

    AxiosHTTP

    Re-exports AxiosHTTP

    Clause

    Re-exports Clause

    CollectTypes

    Re-exports CollectTypes

    Comparator

    Re-exports Comparator

    Comparators

    Re-exports Comparators

    EventDAO

    Re-exports EventDAO

    FeedbackTypes

    Re-exports FeedbackTypes

    Filter

    Re-exports Filter

    FlowDAO

    Re-exports FlowDAO

    GrafanaError

    Re-exports GrafanaError

    GrafanaHTTP

    Re-exports GrafanaHTTP

    IFilterProcessor

    Re-exports IFilterProcessor

    IFilterVisitor

    Re-exports IFilterVisitor

    IHasHTTP

    Re-exports IHasHTTP

    IHasUrlValue

    Re-exports IHasUrlValue

    IHash

    Re-exports IHash

    IOnmsHTTP

    Re-exports IOnmsHTTP

    ITopNOptions

    Re-exports ITopNOptions

    IValueProvider

    Re-exports IValueProvider

    IpInterfaceDAO

    Re-exports IpInterfaceDAO

    JsonTransformer

    Re-exports JsonTransformer

    Logger

    Re-exports Logger

    ManagedTypes

    Re-exports ManagedTypes

    MonitoredServiceDAO

    Re-exports MonitoredServiceDAO

    NestedRestriction

    Re-exports NestedRestriction

    NodeDAO

    Re-exports NodeDAO

    NodeLabelSources

    Re-exports NodeLabelSources

    NodeTypes

    Re-exports NodeTypes

    OnmsAlarm

    Re-exports OnmsAlarm

    OnmsAlarmSummary

    Re-exports OnmsAlarmSummary

    OnmsAlarmType

    Re-exports OnmsAlarmType

    OnmsAuthConfig

    Re-exports OnmsAuthConfig

    OnmsCategory

    Re-exports OnmsCategory

    OnmsCollectType

    Re-exports OnmsCollectType

    OnmsError

    Re-exports OnmsError

    OnmsEvent

    Re-exports OnmsEvent

    OnmsFlowExporter

    Re-exports OnmsFlowExporter

    OnmsFlowExporterSummary

    Re-exports OnmsFlowExporterSummary

    OnmsFlowSeries

    Re-exports OnmsFlowSeries

    OnmsFlowSeriesColumn

    Re-exports OnmsFlowSeriesColumn

    OnmsFlowSnmpInterface

    Re-exports OnmsFlowSnmpInterface

    OnmsFlowTable

    Re-exports OnmsFlowTable

    OnmsHTTPOptions

    Re-exports OnmsHTTPOptions

    OnmsHTTPOptionsBuilder

    Re-exports OnmsHTTPOptionsBuilder

    OnmsIpInterface

    Re-exports OnmsIpInterface

    OnmsManagedType

    Re-exports OnmsManagedType

    OnmsMemo

    Re-exports OnmsMemo

    OnmsMonitoredService

    Re-exports OnmsMonitoredService

    OnmsNode

    Re-exports OnmsNode

    OnmsNodeLabelSource

    Re-exports OnmsNodeLabelSource

    OnmsNodeType

    Re-exports OnmsNodeType

    OnmsOutage

    Re-exports OnmsOutage

    OnmsParm

    Re-exports OnmsParm

    OnmsPrimaryType

    Re-exports OnmsPrimaryType

    OnmsResult

    Re-exports OnmsResult

    OnmsServer

    Re-exports OnmsServer

    OnmsServerBuilder

    Re-exports OnmsServerBuilder

    OnmsServiceStatusType

    Re-exports OnmsServiceStatusType

    OnmsServiceType

    Re-exports OnmsServiceType

    OnmsSeverity

    Re-exports OnmsSeverity

    OnmsSituationFeedback

    Re-exports OnmsSituationFeedback

    OnmsSituationFeedbackType

    Re-exports OnmsSituationFeedbackType

    OnmsSnmpInterface

    Re-exports OnmsSnmpInterface

    OnmsSnmpStatusType

    Re-exports OnmsSnmpStatusType

    OnmsTroubleTicketState

    Re-exports OnmsTroubleTicketState

    OnmsVersion

    Re-exports OnmsVersion

    Operator

    Re-exports Operator

    Operators

    Re-exports Operators

    Order

    Re-exports Order

    OrderBy

    Re-exports OrderBy

    Orders

    Re-exports Orders

    OutageDAO

    Re-exports OutageDAO

    PhysAddr

    Re-exports PhysAddr

    PrimaryTypes

    Re-exports PrimaryTypes

    Restriction

    Re-exports Restriction

    SearchProperty

    Re-exports SearchProperty

    SearchPropertyType

    Re-exports SearchPropertyType

    SearchPropertyTypes

    Re-exports SearchPropertyTypes

    ServerMetadata

    Re-exports ServerMetadata

    ServerType

    Re-exports ServerType

    ServerTypes

    Re-exports ServerTypes

    ServiceStatusTypes

    Re-exports ServiceStatusTypes

    Severities

    Re-exports Severities

    SituationFeedbackDAO

    Re-exports SituationFeedbackDAO

    SnmpInterfaceDAO

    Re-exports SnmpInterfaceDAO

    SnmpStatusTypes

    Re-exports SnmpStatusTypes

    TicketerConfig

    Re-exports TicketerConfig

    TroubleTicketStates

    Re-exports TroubleTicketStates

    V1FilterProcessor

    Re-exports V1FilterProcessor

    V2FilterProcessor

    Re-exports V2FilterProcessor

    XmlTransformer

    Re-exports XmlTransformer

    log

    Re-exports log

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Other

    AbstractHTTP

    Re-exports AbstractHTTP

    AlarmDAO

    Re-exports AlarmDAO

    AlarmTypes

    Re-exports AlarmTypes

    AxiosHTTP

    Re-exports AxiosHTTP

    Clause

    Re-exports Clause

    CollectTypes

    Re-exports CollectTypes

    Comparator

    Re-exports Comparator

    Comparators

    Re-exports Comparators

    EventDAO

    Re-exports EventDAO

    FeedbackTypes

    Re-exports FeedbackTypes

    Filter

    Re-exports Filter

    FlowDAO

    Re-exports FlowDAO

    GrafanaError

    Re-exports GrafanaError

    GrafanaHTTP

    Re-exports GrafanaHTTP

    IFilterProcessor

    Re-exports IFilterProcessor

    IFilterVisitor

    Re-exports IFilterVisitor

    IHasHTTP

    Re-exports IHasHTTP

    IHasUrlValue

    Re-exports IHasUrlValue

    IHash

    Re-exports IHash

    IOnmsHTTP

    Re-exports IOnmsHTTP

    ITopNOptions

    Re-exports ITopNOptions

    IValueProvider

    Re-exports IValueProvider

    IpInterfaceDAO

    Re-exports IpInterfaceDAO

    JsonTransformer

    Re-exports JsonTransformer

    Logger

    Re-exports Logger

    ManagedTypes

    Re-exports ManagedTypes

    MonitoredServiceDAO

    Re-exports MonitoredServiceDAO

    NestedRestriction

    Re-exports NestedRestriction

    NodeDAO

    Re-exports NodeDAO

    NodeLabelSources

    Re-exports NodeLabelSources

    NodeTypes

    Re-exports NodeTypes

    OnmsAlarm

    Re-exports OnmsAlarm

    OnmsAlarmSummary

    Re-exports OnmsAlarmSummary

    OnmsAlarmType

    Re-exports OnmsAlarmType

    OnmsAuthConfig

    Re-exports OnmsAuthConfig

    OnmsCategory

    Re-exports OnmsCategory

    OnmsCollectType

    Re-exports OnmsCollectType

    OnmsError

    Re-exports OnmsError

    OnmsEvent

    Re-exports OnmsEvent

    OnmsFlowExporter

    Re-exports OnmsFlowExporter

    OnmsFlowExporterSummary

    Re-exports OnmsFlowExporterSummary

    OnmsFlowSeries

    Re-exports OnmsFlowSeries

    OnmsFlowSeriesColumn

    Re-exports OnmsFlowSeriesColumn

    OnmsFlowSnmpInterface

    Re-exports OnmsFlowSnmpInterface

    OnmsFlowTable

    Re-exports OnmsFlowTable

    OnmsHTTPOptions

    Re-exports OnmsHTTPOptions

    OnmsHTTPOptionsBuilder

    Re-exports OnmsHTTPOptionsBuilder

    OnmsIpInterface

    Re-exports OnmsIpInterface

    OnmsManagedType

    Re-exports OnmsManagedType

    OnmsMemo

    Re-exports OnmsMemo

    OnmsMonitoredService

    Re-exports OnmsMonitoredService

    OnmsNode

    Re-exports OnmsNode

    OnmsNodeLabelSource

    Re-exports OnmsNodeLabelSource

    OnmsNodeType

    Re-exports OnmsNodeType

    OnmsOutage

    Re-exports OnmsOutage

    OnmsParm

    Re-exports OnmsParm

    OnmsPrimaryType

    Re-exports OnmsPrimaryType

    OnmsResult

    Re-exports OnmsResult

    OnmsServer

    Re-exports OnmsServer

    OnmsServerBuilder

    Re-exports OnmsServerBuilder

    OnmsServiceStatusType

    Re-exports OnmsServiceStatusType

    OnmsServiceType

    Re-exports OnmsServiceType

    OnmsSeverity

    Re-exports OnmsSeverity

    OnmsSituationFeedback

    Re-exports OnmsSituationFeedback

    OnmsSituationFeedbackType

    Re-exports OnmsSituationFeedbackType

    OnmsSnmpInterface

    Re-exports OnmsSnmpInterface

    OnmsSnmpStatusType

    Re-exports OnmsSnmpStatusType

    OnmsTroubleTicketState

    Re-exports OnmsTroubleTicketState

    OnmsVersion

    Re-exports OnmsVersion

    Operator

    Re-exports Operator

    Operators

    Re-exports Operators

    Order

    Re-exports Order

    OrderBy

    Re-exports OrderBy

    Orders

    Re-exports Orders

    OutageDAO

    Re-exports OutageDAO

    PhysAddr

    Re-exports PhysAddr

    PrimaryTypes

    Re-exports PrimaryTypes

    Restriction

    Re-exports Restriction

    SearchProperty

    Re-exports SearchProperty

    SearchPropertyType

    Re-exports SearchPropertyType

    SearchPropertyTypes

    Re-exports SearchPropertyTypes

    ServerMetadata

    Re-exports ServerMetadata

    ServerType

    Re-exports ServerType

    ServerTypes

    Re-exports ServerTypes

    ServiceStatusTypes

    Re-exports ServiceStatusTypes

    Severities

    Re-exports Severities

    SituationFeedbackDAO

    Re-exports SituationFeedbackDAO

    SnmpInterfaceDAO

    Re-exports SnmpInterfaceDAO

    SnmpStatusTypes

    Re-exports SnmpStatusTypes

    TicketerConfig

    Re-exports TicketerConfig

    TroubleTicketStates

    Re-exports TroubleTicketStates

    V1FilterProcessor

    Re-exports V1FilterProcessor

    V2FilterProcessor

    Re-exports V2FilterProcessor

    XmlTransformer

    Re-exports XmlTransformer

    log

    Re-exports log

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/API.html b/docs/modules/API.html index 7caaea3739..191fda2809 100644 --- a/docs/modules/API.html +++ b/docs/modules/API.html @@ -1,4 +1,4 @@ -API | OpenNMS.js - v2.5.9-SNAPSHOT

    Namespace API

    Index

    Client

    OnmsAuthConfig +API | OpenNMS.js - v2.5.9-SNAPSHOT

    Namespace API

    Index

    Client

    OnmsAuthConfig TicketerConfig

    Model

    Operators SearchPropertyTypes @@ -32,4 +32,4 @@ OnmsError IHash log -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/DAO.html b/docs/modules/DAO.html index f50be7c112..07110c58eb 100644 --- a/docs/modules/DAO.html +++ b/docs/modules/DAO.html @@ -1,4 +1,4 @@ -DAO | OpenNMS.js - v2.5.9-SNAPSHOT

    Namespace DAO

    Index

    DAO

    AlarmDAO +DAO | OpenNMS.js - v2.5.9-SNAPSHOT

    Namespace DAO

    Index

    DAO

    AlarmDAO EventDAO FlowDAO IpInterfaceDAO @@ -11,4 +11,4 @@

    Filtering

    V1FilterProcessor V2FilterProcessor

    Internal

    IValueProvider -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/Model.html b/docs/modules/Model.html index 5f86235331..b326e20442 100644 --- a/docs/modules/Model.html +++ b/docs/modules/Model.html @@ -1,4 +1,4 @@ -Model | OpenNMS.js - v2.5.9-SNAPSHOT

    Namespace Model

    Index

    Model

    OnmsAlarm +Model | OpenNMS.js - v2.5.9-SNAPSHOT

    Namespace Model

    Index

    Model

    OnmsAlarm OnmsAlarmSummary OnmsAlarmType OnmsCategory @@ -40,4 +40,4 @@ Severities SnmpStatusTypes TroubleTicketStates -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/Rest.html b/docs/modules/Rest.html index 02778a358f..4bd225bd11 100644 --- a/docs/modules/Rest.html +++ b/docs/modules/Rest.html @@ -1,7 +1,7 @@ -Rest | OpenNMS.js - v2.5.9-SNAPSHOT

    Namespace Rest

    Index

    Rest

    AbstractHTTP +Rest | OpenNMS.js - v2.5.9-SNAPSHOT

    Namespace Rest

    Index

    Rest

    AbstractHTTP AxiosHTTP GrafanaError GrafanaHTTP JsonTransformer XmlTransformer -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/API.Comparators.html b/docs/variables/API.Comparators.html index ed6c330840..adea9830a9 100644 --- a/docs/variables/API.Comparators.html +++ b/docs/variables/API.Comparators.html @@ -1,2 +1,2 @@ Comparators | OpenNMS.js - v2.5.9-SNAPSHOT

    Variable ComparatorsConst

    Comparators: {
        [key: string]: Comparator;
    } = ...

    Contains constant instances of all available comparators.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/API.Operators.html b/docs/variables/API.Operators.html index 2167a0c0f1..568c77d460 100644 --- a/docs/variables/API.Operators.html +++ b/docs/variables/API.Operators.html @@ -1,4 +1,4 @@ Operators | OpenNMS.js - v2.5.9-SNAPSHOT

    Variable OperatorsConst

    Operators: {
        AND: Operator;
        OR: Operator;
    } = ...

    Contains constant instances of all operators.

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/API.Orders.html b/docs/variables/API.Orders.html index d6b763f89d..4f524463b9 100644 --- a/docs/variables/API.Orders.html +++ b/docs/variables/API.Orders.html @@ -1,2 +1,2 @@ Orders | OpenNMS.js - v2.5.9-SNAPSHOT

    Variable OrdersConst

    Orders: {
        ASC: Order;
        DESC: Order;
    } = ...

    Constant references to all OrderBy types.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/API.SearchPropertyTypes.html b/docs/variables/API.SearchPropertyTypes.html index f0d819a757..1a6d7f2a49 100644 --- a/docs/variables/API.SearchPropertyTypes.html +++ b/docs/variables/API.SearchPropertyTypes.html @@ -1,2 +1,2 @@ SearchPropertyTypes | OpenNMS.js - v2.5.9-SNAPSHOT

    Variable SearchPropertyTypesConst

    SearchPropertyTypes: {
        FLOAT: SearchPropertyType;
        INTEGER: SearchPropertyType;
        IP_ADDRESS: SearchPropertyType;
        LONG: SearchPropertyType;
        STRING: SearchPropertyType;
        TIMESTAMP: SearchPropertyType;
    } = ...

    Constant references to all search property types.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/API.ServerTypes.html b/docs/variables/API.ServerTypes.html index 15f27229bc..72a80c2d69 100644 --- a/docs/variables/API.ServerTypes.html +++ b/docs/variables/API.ServerTypes.html @@ -1,4 +1,4 @@ ServerTypes | OpenNMS.js - v2.5.9-SNAPSHOT

    Variable ServerTypesConst

    ServerTypes: {
        HORIZON: ServerType;
        MERIDIAN: ServerType;
    } = ...

    Contains constant instances of all server types.

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/API.log.html b/docs/variables/API.log.html index 1b7ac84272..9fa0c65e72 100644 --- a/docs/variables/API.log.html +++ b/docs/variables/API.log.html @@ -2,4 +2,4 @@ Import a logger using:

    import {log} from 'api/Logger';
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/Model.AlarmTypes.html b/docs/variables/Model.AlarmTypes.html index 8c41c5aa35..baadc49e99 100644 --- a/docs/variables/Model.AlarmTypes.html +++ b/docs/variables/Model.AlarmTypes.html @@ -2,4 +2,4 @@

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/Model.CollectTypes.html b/docs/variables/Model.CollectTypes.html index 7182a40ef7..d4847e6433 100644 --- a/docs/variables/Model.CollectTypes.html +++ b/docs/variables/Model.CollectTypes.html @@ -3,4 +3,4 @@
  • DO_NOT_COLLECT: OnmsCollectType

    Collection is disabled

  • FORCE_COLLECT: OnmsCollectType

    User has forced collection

  • FORCE_DO_NOT_COLLECT: OnmsCollectType

    User has forced collection to be disabled

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/Model.FeedbackTypes.html b/docs/variables/Model.FeedbackTypes.html index 0bd8716e82..c1e2cc3781 100644 --- a/docs/variables/Model.FeedbackTypes.html +++ b/docs/variables/Model.FeedbackTypes.html @@ -3,4 +3,4 @@
  • CREATE_SITUATION: OnmsSituationFeedbackType

    Alarm should be correlated in a new Situation

  • FALSE_NEGATIVE: OnmsSituationFeedbackType

    Alarm was incorrectly ommitted

  • FALSE_POSITIVE: OnmsSituationFeedbackType

    Alarm was incorrectly correlated

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/Model.ManagedTypes.html b/docs/variables/Model.ManagedTypes.html index c601c690d7..ea0dfb2e72 100644 --- a/docs/variables/Model.ManagedTypes.html +++ b/docs/variables/Model.ManagedTypes.html @@ -6,4 +6,4 @@
  • NOT_POLLED: OnmsManagedType

    Interface is not polled

  • REMOTE_ONLY: OnmsManagedType

    Interface should only be polled remotely

  • UNMANAGED: OnmsManagedType

    Interface is not managed

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/Model.NodeLabelSources.html b/docs/variables/Model.NodeLabelSources.html index dc336d4d56..1057e833e9 100644 --- a/docs/variables/Model.NodeLabelSources.html +++ b/docs/variables/Model.NodeLabelSources.html @@ -5,4 +5,4 @@
  • SYSNAME: OnmsNodeLabelSource

    Node label is the node's SNMP sysname

  • UNKNOWN: OnmsNodeLabelSource

    Node label source is unknown

  • USER: OnmsNodeLabelSource

    Node label is set by the user.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/Model.NodeTypes.html b/docs/variables/Model.NodeTypes.html index c2fa16a45b..03da8ce609 100644 --- a/docs/variables/Model.NodeTypes.html +++ b/docs/variables/Model.NodeTypes.html @@ -2,4 +2,4 @@

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/Model.PrimaryTypes.html b/docs/variables/Model.PrimaryTypes.html index f709314e6d..a0bac21366 100644 --- a/docs/variables/Model.PrimaryTypes.html +++ b/docs/variables/Model.PrimaryTypes.html @@ -2,4 +2,4 @@

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/Model.ServiceStatusTypes.html b/docs/variables/Model.ServiceStatusTypes.html index 968ea7f06d..84fa90029b 100644 --- a/docs/variables/Model.ServiceStatusTypes.html +++ b/docs/variables/Model.ServiceStatusTypes.html @@ -7,4 +7,4 @@
  • RESCAN_TO_RESUME: OnmsServiceStatusType

    Service is temporarily unmanaged, rescan to resume

  • RESCAN_TO_SUSPEND: OnmsServiceStatusType

    Service is managed, rescan to suspend monitoring

  • UNMANAGED: OnmsServiceStatusType

    Service is unmanaged

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/Model.Severities.html b/docs/variables/Model.Severities.html index 310d5a73e1..0e8ca5f501 100644 --- a/docs/variables/Model.Severities.html +++ b/docs/variables/Model.Severities.html @@ -1,2 +1,2 @@ Severities | OpenNMS.js - v2.5.9-SNAPSHOT

    Variable SeveritiesConst

    Severities: {
        CLEARED: OnmsSeverity;
        CRITICAL: OnmsSeverity;
        INDETERMINATE: OnmsSeverity;
        MAJOR: OnmsSeverity;
        MINOR: OnmsSeverity;
        NORMAL: OnmsSeverity;
        WARNING: OnmsSeverity;
    } = ...

    Contains constant instances of all severities.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/Model.SnmpStatusTypes.html b/docs/variables/Model.SnmpStatusTypes.html index 0ac6143625..dcba63f2b3 100644 --- a/docs/variables/Model.SnmpStatusTypes.html +++ b/docs/variables/Model.SnmpStatusTypes.html @@ -2,4 +2,4 @@

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/Model.TroubleTicketStates.html b/docs/variables/Model.TroubleTicketStates.html index 92ed9e8609..c234c0376e 100644 --- a/docs/variables/Model.TroubleTicketStates.html +++ b/docs/variables/Model.TroubleTicketStates.html @@ -13,4 +13,4 @@
  • RESOLVE_PENDING: OnmsTroubleTicketState

    Trouble ticket is in the process of being marked resolved

  • UPDATE_FAILED: OnmsTroubleTicketState

    Updating ticket state from the remote helpdesk system failed

  • UPDATE_PENDING: OnmsTroubleTicketState

    Trouble ticket is pending an update from the remote helpdesk system

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file