Class Client

Hierarchy (view full)

_ObjectSubSite
- Client

Index

Constructors

Constructors

constructor

new Client(config, props): Client
Parameters
- config: IObjectSubSiteConfig
- props: Partial<IClientRaw> & {
  mac: string;
  }
Returns Client
Overrides _ObjectSubSite.constructor
- Defined in src/Clients/Client.ts:31

Properties

_id

_id: string

`Optional` _isGuestByUAP

_isGuestByUAP?: boolean

`Optional` _isGuestByUGW

_isGuestByUGW?: boolean

`Optional` _isGuestByUSW

_isGuestByUSW?: boolean

`Optional` _lastSeenByUAP

_lastSeenByUAP?: Date

`Optional` _lastSeenByUGW

_lastSeenByUGW?: Date

`Optional` _lastSeenByUSW

_lastSeenByUSW?: Date

`Optional` _uptimeByUAP

_uptimeByUAP?: number

`Optional` _uptimeByUGW

_uptimeByUGW?: number

`Optional` _uptimeByUSW

_uptimeByUSW?: number

`Optional` anomalies

anomalies?: number

`Optional` anonClientId

anonClientId?: string

`Optional` apMac

apMac?: string

`Optional` assocTime

assocTime?: Date

`Optional` blocked

blocked?: boolean

`Optional` bssid

bssid?: string

`Optional` bytesR

bytesR?: number

`Optional` ccq

ccq?: number

`Optional` channel

channel?: number

`Optional` confidence

confidence?: number

device

device: DeviceData

`Optional` dhcpendTime

dhcpendTime?: number

`Optional` essid

essid?: string

`Optional` firmwareVersion

firmwareVersion?: string

`Optional` firstSeen

firstSeen?: Date

`Optional` fixedIp

fixedIp?: string

`Optional` groupId

groupId?: string

`Optional` gwMac

gwMac?: string

`Optional` hostname

hostname?: string

`Optional` idletime

idletime?: number

`Optional` ip

ip?: string

`Optional` is11r

is11r?: boolean

`Optional` isGuest

isGuest?: boolean

`Optional` isWired

isWired?: boolean

`Optional` lastDisconnect

lastDisconnect?: Date

`Optional` lastSeen

lastSeen?: Date

`Optional` latestAssocTime

latestAssocTime?: Date

mac

mac: string

`Optional` name

name?: string

`Optional` network

network?: string

`Optional` networkId

networkId?: string

`Optional` noise

noise?: number

`Optional` note

note?: string

`Optional` noted

noted?: boolean

`Optional` oui

oui?: string

`Optional` powersaveEnabled

powersaveEnabled?: boolean

`Optional` qosPolicyApplied

qosPolicyApplied?: boolean

`Optional` radio

radio?: string

`Optional` radioName

radioName?: string

`Optional` radioProto

radioProto?: string

`Optional` rssi

rssi?: number

`Optional` rxBytes

rxBytes?: number

`Optional` rxBytesR

rxBytesR?: number

`Optional` rxPackets

rxPackets?: number

`Optional` rxRate

rxRate?: number

`Optional` satisfaction

satisfaction?: number

`Optional` score

score?: number

`Optional` signal

signal?: number

`Optional` siteId

siteId?: string

`Optional` swDepth

swDepth?: number

`Optional` swMac

swMac?: string

`Optional` swPort

swPort?: number

`Optional` txBytes

txBytes?: number

`Optional` txBytesR

txBytesR?: number

`Optional` txMcs

txMcs?: number

`Optional` txPackets

txPackets?: number

`Optional` txPower

txPower?: number

`Optional` txRate

txRate?: number

`Optional` txRetries

txRetries?: number

`Optional` uptime

uptime?: number

`Optional` useFixedIp

useFixedIp?: boolean

`Optional` userGroupIdComputed

userGroupIdComputed?: string

`Optional` userId

userId?: string

`Optional` vlan

vlan?: number

`Optional` wifiTxAttempts

wifiTxAttempts?: number

`Optional` wiredRateMbps

wiredRateMbps?: number

`Optional` wiredRxBytes

wiredRxBytes?: number

`Optional` wiredRxBytesR

wiredRxBytesR?: number

`Optional` wiredRxPackets

wiredRxPackets?: number

`Optional` wiredTxBytes

wiredTxBytes?: number

`Optional` wiredTxBytesR

wiredTxBytesR?: number

`Optional` wiredTxPackets

wiredTxPackets?: number

`Static` debug

debug: Debugger = ...

Accessors

`Protected` config

get config(): IObjectSubSiteConfigComplete
Returns IObjectSubSiteConfigComplete
Inherited from _ObjectSubSite.config
- Defined in src/commons/_ObjectSubSite.ts:31
set config(value): void
Parameters
- value: IObjectSubSiteConfigComplete
Returns void
Inherited from _ObjectSubSite.config
- Defined in src/commons/_ObjectSubSite.ts:35

`Protected` controller

get controller(): Controller
Returns Controller
Inherited from _ObjectSubSite.controller
- Defined in src/commons/_ObjectSubController.ts:31
set controller(value): void
Parameters
- value: Controller
Returns void
Inherited from _ObjectSubSite.controller
- Defined in src/commons/_ObjectSubController.ts:35

`Protected` controllerInstance

get controllerInstance(): AxiosInstance
Returns AxiosInstance
Inherited from _ObjectSubSite.controllerInstance
- Defined in src/commons/_ObjectSubController.ts:24
set controllerInstance(value): void
Parameters
- value: AxiosInstance
Returns void
Inherited from _ObjectSubSite.controllerInstance
- Defined in src/commons/_ObjectSubController.ts:28

`Protected` debug

get debug(): Debugger
Returns Debugger
Inherited from _ObjectSubSite.debug
- Defined in src/commons/_ObjectSubController.ts:144
set debug(value): void
Parameters
- value: Debugger
Returns void
Inherited from _ObjectSubSite.debug
- Defined in src/commons/_ObjectSubController.ts:148

`Protected` instance

get instance(): AxiosInstance
Returns AxiosInstance
Inherited from _ObjectSubSite.instance
- Defined in src/commons/_ObjectSubSite.ts:14

`Private` old

get old(): Partial<Client>
Returns Partial<Client>
- Defined in src/Clients/Client.ts:16
set old(data): void
Parameters
- data: Partial<Client>
Returns void
- Defined in src/Clients/Client.ts:20

`Protected` privateMap

get privateMap(): WeakMap<any, any>
Returns WeakMap<any, any>
Inherited from _ObjectSubSite.privateMap
- Defined in src/commons/ObjectWithPrivateValues.ts:28

`Protected` site

get site(): Site
Returns Site
Inherited from _ObjectSubSite.site
- Defined in src/commons/_ObjectSubController.ts:38
set site(value): void
Parameters
- value: Site
Returns void
Inherited from _ObjectSubSite.site
- Defined in src/commons/_ObjectSubController.ts:42

Methods

block

block(): Promise<Client>
Returns Promise<Client>
- Defined in src/Clients/Client.ts:402

`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
Inherited from _ObjectSubSite.checkNeedVersion
- Defined in src/commons/_ObjectSubController.ts:104

`Protected` checkNeeds

checkNeeds(minVersion?, unifiOs?): boolean
Parameters
- Optional minVersion: string
- Optional unifiOs: boolean
Returns boolean
Inherited from _ObjectSubSite.checkNeeds
- Defined in src/commons/_ObjectSubController.ts:94

forget

forget(): Promise<boolean>
Forget one or more client devices

NOTE: only supported with controller versions 5.9.X and higher, can be slow (up to 5 minutes) on larger controllers

Returns Promise<boolean>
- Defined in src/Clients/Client.ts:342

getController

getController(): Controller
Returns Controller
Inherited from _ObjectSubSite.getController
- Defined in src/commons/_ObjectSubController.ts:79

getInstance

getInstance(): AxiosInstance
Returns AxiosInstance
Inherited from _ObjectSubSite.getInstance
- Defined in src/commons/_ObjectSubController.ts:75

`Protected` getPrivate

getPrivate<T>(key): T
Type Parameters
- T
  the type retrieve.
Parameters
- key: string
  the key to retrieve
Returns T
Inherited from _ObjectSubSite.getPrivate
- Defined in src/commons/ObjectWithPrivateValues.ts:11

import

import(props): this
Parameters
- props: Partial<IClientRaw>
Returns this
Overrides _ObjectSubSite.import
- Defined in src/Clients/Client.ts:45

`Private` importValue

importValue(k, v): void
Parameters
- k: keyof Client
- v: unknown
Returns void
- Defined in src/Clients/Client.ts:24

`Protected` mapObject

mapObject<U>(constructor, object): U
Type Parameters
- U extends _ObjectSubSite
Parameters
- constructor: (new (config, props) => U)
  the construtor to map the object
  - - new (config, props): U
    - Parameters
      config: IObjectSubSiteConfig
      props: any
      Returns U
- object: any
  the properties passed to the constructor if defined
Returns U
Inherited from _ObjectSubSite.mapObject
- Defined in src/commons/_ObjectSubSite.ts:60

`Protected` needVersion

needVersion<T>(key, value?, minVersion?, unifiOs?, allowUndefined?): boolean
Type Parameters
- T
Parameters
- key: keyof Client
  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
Inherited from _ObjectSubSite.needVersion
- Defined in src/commons/_ObjectSubController.ts:116

save

save(): Promise<Client>
Returns Promise<Client>
- Defined in src/Clients/Client.ts:356

`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
Inherited from _ObjectSubSite.setPrivate
- Defined in src/commons/ObjectWithPrivateValues.ts:21

toJSON

toJSON(): Partial<Client>
Returns Partial<Client>
Inherited from _ObjectSubSite.toJSON
- Defined in src/commons/_ObjectSubController.ts:59

unblock

unblock(): Promise<Client>
Returns Promise<Client>
- Defined in src/Clients/Client.ts:416

Class Client

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Client

Properties

_id

Optional _isGuestByUAP

Optional _isGuestByUGW

Optional _isGuestByUSW

Optional _lastSeenByUAP

Optional _lastSeenByUGW

Optional _lastSeenByUSW

Optional _uptimeByUAP

Optional _uptimeByUGW

Optional _uptimeByUSW

Optional anomalies

Optional anonClientId

Optional apMac

Optional assocTime

Optional blocked

Optional bssid

Optional bytesR

Optional ccq

Optional channel

Optional confidence

device

Optional dhcpendTime

Optional essid

Optional firmwareVersion

Optional firstSeen

Optional fixedIp

Optional groupId

Optional gwMac

Optional hostname

Optional idletime

Optional ip

Optional is11r

Optional isGuest

Optional isWired

Optional lastDisconnect

Optional lastSeen

Optional latestAssocTime

mac

Optional name

Optional network

Optional networkId

Optional noise

Optional note

Optional noted

Optional oui

Optional powersaveEnabled

Optional qosPolicyApplied

Optional radio

Optional radioName

Optional radioProto

Optional rssi

Optional rxBytes

Optional rxBytesR

Optional rxPackets

Optional rxRate

Optional satisfaction

Optional score

Optional signal

Optional siteId

Optional swDepth

Optional swMac

Optional swPort

Optional txBytes

Optional txBytesR

Optional txMcs

Optional txPackets

Optional txPower

Optional txRate

`Optional` _isGuestByUAP

`Optional` _isGuestByUGW

`Optional` _isGuestByUSW

`Optional` _lastSeenByUAP

`Optional` _lastSeenByUGW

`Optional` _lastSeenByUSW

`Optional` _uptimeByUAP

`Optional` _uptimeByUGW

`Optional` _uptimeByUSW

`Optional` anomalies

`Optional` anonClientId

`Optional` apMac

`Optional` assocTime

`Optional` blocked

`Optional` bssid

`Optional` bytesR

`Optional` ccq

`Optional` channel

`Optional` confidence

`Optional` dhcpendTime

`Optional` essid

`Optional` firmwareVersion

`Optional` firstSeen

`Optional` fixedIp

`Optional` groupId

`Optional` gwMac

`Optional` hostname

`Optional` idletime

`Optional` ip

`Optional` is11r

`Optional` isGuest

`Optional` isWired

`Optional` lastDisconnect

`Optional` lastSeen

`Optional` latestAssocTime

`Optional` name

`Optional` network

`Optional` networkId

`Optional` noise

`Optional` note

`Optional` noted

`Optional` oui

`Optional` powersaveEnabled

`Optional` qosPolicyApplied

`Optional` radio

`Optional` radioName

`Optional` radioProto

`Optional` rssi

`Optional` rxBytes

`Optional` rxBytesR

`Optional` rxPackets

`Optional` rxRate

`Optional` satisfaction

`Optional` score

`Optional` signal

`Optional` siteId

`Optional` swDepth

`Optional` swMac

`Optional` swPort

`Optional` txBytes

`Optional` txBytesR

`Optional` txMcs

`Optional` txPackets

`Optional` txPower

`Optional` txRate

`Optional` txRetries

`Optional` uptime

`Optional` useFixedIp

`Optional` userGroupIdComputed

`Optional` userId

`Optional` vlan

`Optional` wifiTxAttempts

`Optional` wiredRateMbps

`Optional` wiredRxBytes

`Optional` wiredRxBytesR

`Optional` wiredRxPackets

`Optional` wiredTxBytes

`Optional` wiredTxBytesR

`Optional` wiredTxPackets

`Static` debug