Class Site

Hierarchy (View Summary)

_ObjectSubController
- Site

Implements

ISite

Constructors

constructor

new Site(controller: Controller, props: ISite): Site
Parameters
- controller: Controller
- props: ISite
Returns Site
Overrides _ObjectSubController.constructor
- Defined in src/Sites/Site.ts:55

Properties

_id

_id: string

internal id

anonymous_id

anonymous_id: string

an uuid of the site

attr_hidden_id

attr_hidden_id: string

attr_no_delete

attr_no_delete: boolean

clients

clients: Clients

clientsGroups

clientsGroups: ClientsGroups

desc

desc: string

the name you setup for this site

devices

devices: Devices

firewall

firewall: Firewall

hotspots

hotspots: Hotspots

name

name: string

the technical name of the site (seems autogenerated)

networks

networks: Networks

role

role: string

role_hotspot

role_hotspot: boolean

UNIFIOS only

stats

stats: Stats

ws

ws: UnifiWebsockets

`Static`debug

debug: Debugger = ...

Accessors

`Protected`config

get config(): IObjectSubController
Returns IObjectSubController
Inherited from _ObjectSubController.config
- Defined in src/commons/_ObjectSubController.ts:17
set config(value: IObjectSubController): void
Parameters
- value: IObjectSubController
Returns void
Inherited from _ObjectSubController.config
- Defined in src/commons/_ObjectSubController.ts:21

`Protected`controller

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

`Protected`controllerInstance

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

`Protected`debug

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

`Protected`instance

get instance(): AxiosInstance
Returns AxiosInstance
Inherited from _ObjectSubController.instance
- Defined in src/commons/_ObjectSubController.ts:67
set instance(value: AxiosInstance): void
Parameters
- value: AxiosInstance
Returns void
Inherited from _ObjectSubController.instance
- Defined in src/commons/_ObjectSubController.ts:71

`Protected`privateMap

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

`Protected`site

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

Methods

adoptDevice

adoptDevice(device: string | BaseDevice): Promise<unknown>
Parameters
- device: string | BaseDevice
Returns Promise<unknown>
- Defined in src/Sites/Site.ts:110

`Protected`checkNeeds

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

`Protected`checkNeedVersion

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

devManager

devManager<T>(
payload: Record<string, unknown> & { cmd: string },
): Promise<IUnifiResponseEnveloppe<T>>
Type Parameters
- T
Parameters
- payload: Record<string, unknown> & { cmd: string }
Returns Promise<IUnifiResponseEnveloppe<T>>
- Defined in src/Sites/Site.ts:140

enableLEDs

enableLEDs(enable?: boolean): Promise<ISiteSettingsManagement>
Parameters
- enable: boolean = true
  true switches LEDs of all the access points ON, false switches them OFF
Returns Promise<ISiteSettingsManagement>
- Defined in src/Sites/Site.ts:128

getController

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

getInstance

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

getNetworkStatus

getNetworkStatus(): Promise<INetworkStatus>
Returns Promise<INetworkStatus>
- Defined in src/Sites/Site.ts:182

`Protected`getPrivate

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

getSettings

getSettings(): Promise<tSiteSettings[]>
Returns Promise<tSiteSettings[]>
- Defined in src/Sites/Site.ts:132

initWebSockets

initWebSockets(): Promise<void>
Returns Promise<void>
- Defined in src/Sites/Site.ts:145

`Protected`needVersion

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

on

on(eventName: string, cb: (...args: unknown[]) => unknown): this
Parameters
- eventName: string
- cb: (...args: unknown[]) => unknown
Returns this
- Defined in src/Sites/Site.ts:170

`Protected`setPrivate

setPrivate<T>(key: string, value: T): void
Type Parameters
- T
  the type to set.
Parameters
- key: string
  the key to set
- value: T
  the value
Returns void
Inherited from _ObjectSubController.setPrivate
- Defined in src/commons/ObjectWithPrivateValues.ts:21

settingsManager

settingsManager<T>(
settings: Record<string, unknown>,
): Promise<IUnifiResponseEnveloppe<T>>
Type Parameters
- T
Parameters
- settings: Record<string, unknown>
Returns Promise<IUnifiResponseEnveloppe<T>>
- Defined in src/Sites/Site.ts:136

toJSON

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