OpenNMS.js - v2.6.2-SNAPSHOT
    Preparing search index...

    Class EventDAO

    Data access for [[OnmsEvent]] objects.

    Hierarchy

    Index

    Constructors

    Accessors

    Methods

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

      Parameters

      • propertyId: string

        The propertyId to find the values for

      • Optionaloptions: any

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

      Returns Promise<any>

      A promise containing the values.

    • Retrieve the API version from the currently configured server.

      Returns number

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

      Parameters

      • data: any
      • Optionalstatus: number

      Returns number

    • 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.

    • 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[]

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

      Parameters

      • id: string

        The id to search the property by.

      Returns Promise<SearchProperty>

    • The path to the event search properties endpoint.

      Returns string

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

      Parameters

      • from: any

      Returns Moment

      use [[Util.toDate]] instead.

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

      Parameters

      • from: any

      Returns number

      use [[Util.toNumber]] instead.

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

      Returns boolean