Class _ObjectSubController

Hierarchy (view full)

Constructors

constructor

Accessors

config controller controllerInstance debug instance privateMap site

Methods

checkNeedVersion checkNeeds getController getInstance getPrivate needVersion setPrivate toJSON

Constructors

constructor

Accessors

Protected config

Protected controller

Protected controllerInstance

Protected debug

Protected instance

Protected privateMap

Protected site

Methods

Protected checkNeedVersion

  • checkNeedVersion(minVersion?, unifiOs?, parameterName?): void

  • Parameters

    • Optional minVersion: string

      the minimal semver version for this object

    • Optional unifiOs: boolean

      need to be unifiOs ? or Unifi Controller ? if no need, pass undefined

    • parameterName: string = ''

      a name for the parameter

    Returns void

Protected checkNeeds

getController

getInstance

Protected getPrivate

Protected needVersion

  • needVersion<T>(key, value?, minVersion?, unifiOs?, allowUndefined?): boolean

  • Type Parameters

    • T

    Parameters

    • key: keyof _ObjectSubController

      the key object that need to be only supported on some versions

    • Optional value: T

      the value store in this object

    • Optional minVersion: string

      the minimal semver version for this object

    • Optional unifiOs: boolean

      need to be unifiOs ? or Unifi Controller ? if no need, pass undefined

    • allowUndefined: boolean = false

      to undefined check ?

    Returns boolean

Protected setPrivate

  • setPrivate<T>(key, value): void

  • Type Parameters

    • T

      the type to set.

    Parameters

    • key: string

      the key to set

    • value: T

      the value

    Returns void

toJSON

Settings

Member Visibility

Theme

On This Page

constructorconfigcontrollercontrollerInstancedebuginstanceprivateMapsitecheckNeedVersioncheckNeedsgetControllergetInstancegetPrivateneedVersionsetPrivatetoJSON

Generated using TypeDoc