Class AlarmDAO

Hierarchy

AbstractDAO<number, OnmsAlarm>
- AlarmDAO

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AlarmDAO(httpImpl: IOnmsHTTP): AlarmDAO

Overrides AbstractDAO.constructor
- Defined in dao/AlarmDAO.ts:31
Parameters
- httpImpl: 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

find

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

Overrides AbstractDAO.find
- Defined in dao/AlarmDAO.ts:130
get an alarm, given a filter

Parameters
- Optional filter: Filter<OnmsAlarm>
Returns Promise<OnmsAlarm[]>

fromData

fromData(data: any): OnmsAlarm

Overrides AbstractDAO.fromData
- Defined in dao/AlarmDAO.ts:39
create an alarm object from a JSON object

Parameters
- data: any
Returns OnmsAlarm

get

get(id: number): Promise<OnmsAlarm>

Overrides AbstractDAO.get
- Defined in dao/AlarmDAO.ts:110
get an alarm, given the alarm's ID

Parameters
- id: number
Returns Promise<OnmsAlarm>

Generated using TypeDoc