Class Clients

Hierarchy (View Summary)

Constructors

constructor

Accessors

config controller controllerInstance debug instance privateMap site

Methods

checkNeeds checkNeedVersion create getById getByMac getController getInstance getPrivate import list list2 list3 mapObject needVersion setPrivate toJSON

Constructors

constructor

Accessors

Protectedconfig

Protectedcontroller

ProtectedcontrollerInstance

Protecteddebug

Protectedinstance

ProtectedprivateMap

Protectedsite

Methods

ProtectedcheckNeeds

ProtectedcheckNeedVersion

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

  • Parameters

    • OptionalminVersion: string

      the minimal semver version for this object

    • OptionalunifiOs: boolean

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

    • parameterName: string = ''

      a name for the parameter

    Returns void

create

getById

getByMac

  • getByMac(mac: string): Promise<undefined | Client>

  • get a Client by mac call /stat/sta/:mac ( seems to return same as /stat/user/:mac )

    Parameters

    • mac: string

      the macAddress

    Returns Promise<undefined | Client>

getController

getInstance

ProtectedgetPrivate

Protectedimport

list

  • list(params?: IClientListParams): Promise<Client[]>

  • Use this function to list clients

    example to get all blocked user in the last 10 hours

    list({
      type: 'blocked',
      conn: 'all',
      within: 10
    });

    example to get all user from the last 2 hours

    list({
      type: 'all',
      conn: 'all',
      within: 2
    });

    Parameters

    Returns Promise<Client[]>

list2

list3

ProtectedmapObject

ProtectedneedVersion

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

  • Type Parameters

    • T

    Parameters

    • key: keyof Clients

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

    • Optionalvalue: T

      the value store in this object

    • OptionalminVersion: string

      the minimal semver version for this object

    • OptionalunifiOs: boolean

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

    • allowUndefined: boolean = false

      to undefined check ?

    Returns boolean

ProtectedsetPrivate

toJSON

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods