Class AlarmDAO

Hierarchy

AbstractDAO<number, OnmsAlarm>
- AlarmDAO

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AlarmDAO(impl: IHasHTTP | IOnmsHTTP): AlarmDAO

Overrides AbstractDAO.constructor
- Defined in dao/AlarmDAO.ts:32
Parameters
- impl: IHasHTTP | IOnmsHTTP
Returns AlarmDAO

Properties

Private eventDao

eventDao: EventDAO

an event DAO to be used for creating events attached to alarms from API/JSON data

Protected http

http: IOnmsHTTP

the HTTP implementation to use

Methods

acknowledge

acknowledge(id: number, user?: string): Promise<void>

- Defined in dao/AlarmDAO.ts:161
Acknowledge an alarm.

Parameters
- id: number
  
  the alarm ID
- Optional user: string
  
  the user to ack the alarm as (only administrators have the right to do this)
Returns Promise<void>

clear

clear(id: number): Promise<void>

- Defined in dao/AlarmDAO.ts:197
Clear an alarm.

Parameters
- id: number
  
  the alarm ID
Returns Promise<void>

escalate

escalate(id: number): Promise<void>

- Defined in dao/AlarmDAO.ts:186
Escalate an alarm.

Parameters
- id: number
  
  the alarm ID
Returns Promise<void>

find

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

Overrides AbstractDAO.find
- Defined in dao/AlarmDAO.ts:135
Find matching alarms.

Parameters
- Optional filter: Filter
  
  the filter to use when querying
Returns Promise<OnmsAlarm[]>

an array of OnmsAlarms

get

get(id: number): Promise<OnmsAlarm>

Overrides AbstractDAO.get
- Defined in dao/AlarmDAO.ts:122
Fetch an alarm.

Parameters
- id: number
  
  the alarm's ID
Returns Promise<OnmsAlarm>

an OnmsAlarm

Protected getApiVersion

getApiVersion(): 1 | 2

Inherited from AbstractDAO.getApiVersion
- Defined in dao/AbstractDAO.ts:86
retrieve the API version from the underlying server

Returns 1 | 2

Protected getCount

getCount(data: any): number

Inherited from AbstractDAO.getCount
- Defined in dao/AbstractDAO.ts:48
extract the count or totalCount values from response data

Parameters
- data: any
Returns number

Protected getFilterProcessor

getFilterProcessor(): any

Inherited from AbstractDAO.getFilterProcessor
- Defined in dao/AbstractDAO.ts:94
retrieve filter processor for the current API version

Returns any

Protected getOptions

getOptions(filter?: Filter): OnmsHTTPOptions

Overrides AbstractDAO.getOptions
- Defined in dao/AlarmDAO.ts:204
given an optional filter, generate an OnmsHTTPOptions object for DAO calls

Parameters
- Optional filter: Filter
Returns OnmsHTTPOptions

Private pathToAlarmsEndpoint

pathToAlarmsEndpoint(): "api/v2/alarms" | "rest/alarms"

- Defined in dao/AlarmDAO.ts:228
get the path to the alarms endpoint for the appropriate API version

Returns "api/v2/alarms" | "rest/alarms"

Private put

put(url: string, parameters?: IHash<string>): Promise<void>

- Defined in dao/AlarmDAO.ts:214
call a PUT request in the format the alarm ack API expects

Parameters
- url: string
- Default value parameters: IHash<string> = {} as IHash<string>
Returns Promise<void>

Protected toDate

toDate(from: any): any

Inherited from AbstractDAO.toDate
- Defined in dao/AbstractDAO.ts:72
convert the given value to a date, or undefined if it cannot be converted

Parameters
- from: any
Returns any

Private toMemo

toMemo(data: any): OnmsMemo

- Defined in dao/AlarmDAO.ts:233
generate a memo from the given dictionary

Parameters
- data: any
Returns OnmsMemo

Protected toNumber

toNumber(from: any): number

Inherited from AbstractDAO.toNumber
- Defined in dao/AbstractDAO.ts:80
convert the given value to a number, or undefined if it cannot be converted

Parameters
- from: any
Returns number

unacknowledge

unacknowledge(id: number): Promise<void>

- Defined in dao/AlarmDAO.ts:175
Un-acknowledge an alarm.

Parameters
- id: number
  
  the alarm ID
Returns Promise<void>

Generated using TypeDoc