Options
All
  • Public
  • Public/Protected
  • All
Menu

Data access for OnmsNode objects.

Hierarchy

Index

Constructors

Accessors

Methods

  • findValues(propertyId: string, options?: any): 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 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<Model.OnmsNode>

  • getApiVersion(): number
  • Retrieve the API version from the currently configured server.

    Returns number

  • getCount(data: any, status?: number): 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

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

  • parseResultList(result: any, dataFieldName: string, path: string, mapCallbackFunction: any): 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[]

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

    Parameters

    • id: string

      The id to search the property by.

    Returns Promise<API.SearchProperty>

  • searchPropertyPath(): string
  • The path to the node search properties endpoint.

    Returns string

  • toDate(from: any): Moment
  • Convert the given value to a date, or undefined if it cannot be converted.

    deprecated

    use {@link Util.toDate} instead.

    Parameters

    • from: any

    Returns Moment

  • toNumber(from: any): number
  • Convert the given value to a number, or undefined if it cannot be converted.

    deprecated

    use {@link Util.toNumber} instead.

    Parameters

    • from: any

    Returns number

  • useJson(): boolean
  • Whether or not to use JSON when making ReST requests.

    Returns boolean

Generated using TypeDoc