Class Controller

Hierarchy

ObjectWithPrivateValues
- Controller

Implements

IController

Constructors

constructor

new Controller(props): Controller
Parameters
- props: IControllerProps
Returns Controller
Overrides ObjectWithPrivateValues.constructor
- Defined in src/Controller.ts:115

Properties

UnifiWebSockets

UnifiWebSockets: UnifiWebsockets[] = []

store array to close them all if needed, or loop on registered sockets only available on unifiOS

`Private` _logged

_logged: boolean

`Private` `Readonly` _sites

_sites: Sites

auth

auth: UnifiAuth

`Readonly` controllerInstance

controllerInstance: AxiosInstance

globalWS

globalWS: EventEmitter = ...

global event emitter, to listen on all events

strictSSL

strictSSL: boolean = true

superWS

superWS: UnifiWebsockets

listen on super site

unifiOs

unifiOs: boolean

`Optional` version

version?: string = '7.0.0'

Accessors

logged

get logged(): boolean
Returns boolean
- Defined in src/Controller.ts:55
set logged(value): void
Parameters
- value: boolean
Returns void
- Defined in src/Controller.ts:59

`Protected` privateMap

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

`Protected` props

get props(): IControllerProps
Returns IControllerProps
- Defined in src/Controller.ts:98
set props(value): void
Parameters
- value: IControllerProps
Returns void
- Defined in src/Controller.ts:102

sites

get sites(): Sites
Returns Sites
Implementation of IController.sites
- Defined in src/Controller.ts:42

ws

get ws(): UnifiWebsockets
Returns UnifiWebsockets
- Defined in src/Controller.ts:107
set ws(value): void
Parameters
- value: UnifiWebsockets
Returns void
- Defined in src/Controller.ts:111

Methods

`Private` _createInstance

_createInstance(siteName?, config?): AxiosInstance
Parameters
- Optional siteName: string
- Optional config: RawAxiosRequestConfig
Returns AxiosInstance
- Defined in src/Controller.ts:67

`Private` _initWebSockets

_initWebSockets(): this
Returns this
- Defined in src/Controller.ts:347

`Private` addAxiosDebugInterceptors

addAxiosDebugInterceptors(instance): AxiosInstance
Parameters
- instance: AxiosInstance
Returns AxiosInstance
- Defined in src/Controller.ts:158

`Private` addAxiosPlugins

addAxiosPlugins(instance): AxiosInstance
Parameters
- instance: AxiosInstance
Returns AxiosInstance
- Defined in src/Controller.ts:330

`Private` addAxiosProxyInterceptors

addAxiosProxyInterceptors(instance): AxiosInstance
Parameters
- instance: AxiosInstance
Returns AxiosInstance
- Defined in src/Controller.ts:320

buildUrl

buildUrl(pConfig, websockets?): AxiosRequestConfig<any>
Parameters
- pConfig: IBuildUrlParams
- websockets: boolean = false
Returns AxiosRequestConfig<any>
- Defined in src/Controller.ts:246

createInstance

createInstance(siteName, config?): AxiosInstance
Parameters
- siteName: string
- Optional config: RawAxiosRequestConfig
Returns AxiosInstance
Implementation of IController.createInstance
- Defined in src/Controller.ts:63

getDevicesFingerPrints

getDevicesFingerPrints(folder?): Promise<DeviceFingerPrints>
Parameters
- folder: number = 0
  not sure about it, but some number can return different results seems to return https://static.ubnt.com/fingerprint/:folder/devicelist.json tested with 0 1 2
Returns Promise<DeviceFingerPrints>
- Defined in src/Controller.ts:415

getInstance

getInstance(): AxiosInstance
Returns AxiosInstance
- Defined in src/Controller.ts:335

`Protected` getPrivate

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

getSites

getSites(): Promise<Site[]>
Returns Promise<Site[]>
Implementation of IController.getSites
- Defined in src/Controller.ts:132

initWebSockets

initWebSockets(): Promise<void>
Returns Promise<void>
- Defined in src/Controller.ts:404

login

login(token2FA?): Promise<IUser>
Parameters
- Optional token2FA: string
  2FA token, will disable re-login
Returns Promise<IUser>
Implementation of IController.login
- Defined in src/Controller.ts:141

logout

logout(): Promise<void>
Returns Promise<void>
Implementation of IController.logout
- Defined in src/Controller.ts:152

`Private` needLoggedIn

needLoggedIn(): void
Returns void
- Defined in src/Controller.ts:126

on

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

reboot

reboot(): Promise<void>
Returns Promise<void>
- Defined in src/Controller.ts:429

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

Generated using TypeDoc