Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AlarmDAO

Data access for OnmsAlarm objects.

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

filterProcessor

http

  • The HTTP implementation to use internally when making DAO requests.

    Returns IOnmsHTTP

  • The HTTP implementation to use internally when making DAO requests.

    Parameters

    Returns void

Methods

acknowledge

  • acknowledge(alarm: number | OnmsAlarm, user?: string): Promise<void>

  • Acknowledge an alarm.

    version

    ReST v1+

    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>

clear

  • clear(alarm: number | OnmsAlarm): Promise<void>

  • Clear an alarm.

    version

    ReST v1+

    Parameters

    Returns Promise<void>

escalate

  • escalate(alarm: number | OnmsAlarm): Promise<void>

  • Escalate an alarm.

    version

    ReST v1+

    Parameters

    Returns Promise<void>

find

  • Find matching alarms.

    version

    ReST v1+

    Parameters

    • Optional filter: Filter

      The filter to use when querying.

    Returns Promise<OnmsAlarm[]>

    An array of OnmsAlarm objects.

get

  • Fetch an alarm.

    version

    ReST v1+

    Parameters

    • id: number

      The alarm's ID.

    Returns Promise<OnmsAlarm>

    An OnmsAlarm.

Protected getApiVersion

  • getApiVersion(): number

  • Retrieve the API version from the currently configured server.

    Returns number

Protected getCount

  • getCount(data: any): number

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

    Parameters

    • data: any

    Returns number

setTTicketId

  • setTTicketId(alarm: number | OnmsAlarm, ticketId: string): Promise<void>

  • Associate a ticket ID with the alarm.

    version

    ReST v1+

    Parameters

    Returns Promise<void>

setTTicketState

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

    version

    ReST v1+

    Parameters

    Returns Promise<void>

Protected toDate

  • toDate(from: any): Moment | undefined

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

    Parameters

    • from: any

    Returns Moment | undefined

Protected toNumber

  • toNumber(from: any): number | undefined

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

    Parameters

    • from: any

    Returns number | undefined

unacknowledge

  • unacknowledge(alarm: number | OnmsAlarm): Promise<void>

  • Un-acknowledge an alarm.

    version

    ReST v1+

    Parameters

    Returns Promise<void>

Generated using TypeDoc