Class Controller

constructor

• new Controller(props: IControllerProps): Controller

• Parameters

  • props: IControllerProps

  Returns Controller

auth

ReadonlycontrollerInstance

globalWS

strictSSL

superWS

unifiOs

UnifiWebSockets

Optionalversion

logged

• get logged(): boolean

• Returns boolean

• set logged(value: boolean): void

• Parameters

  • value: boolean

  Returns void

sites

• get sites(): Sites

• Returns Sites

ws

• get ws(): UnifiWebsockets

• Returns UnifiWebsockets

• set ws(value: UnifiWebsockets): void

• Parameters

  • value: UnifiWebsockets

  Returns void

buildUrl

• buildUrl(pConfig: IBuildUrlParams, websockets?: boolean): AxiosRequestConfig

• Parameters

  • pConfig: IBuildUrlParams
  • websockets: boolean = false

  Returns AxiosRequestConfig

createInstance

• createInstance(siteName: string, config?: RawAxiosRequestConfig): AxiosInstance

• Parameters

  • siteName: string
  • Optionalconfig: RawAxiosRequestConfig

  Returns AxiosInstance

getDevicesFingerPrints

• getDevicesFingerPrints(folder?: number): 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>

getInstance

• getInstance(): AxiosInstance

• Returns AxiosInstance

getSites

• getSites(): Promise<Site[]>

• Returns Promise<Site[]>

initWebSockets

• initWebSockets(): Promise<void>

• Returns Promise<void>

login

• login(token2FA?: string): Promise<IUser>

• Parameters

  • Optionaltoken2FA: string

    2FA token, will disable re-login

  Returns Promise<IUser>

logout

• logout(): Promise<void>

• Returns Promise<void>

on

• on(eventName: string, cb: (...args: unknown[]) => unknown): this

• Parameters

  • eventName: string
  • cb: (...args: unknown[]) => unknown

  Returns this

reboot

• reboot(): Promise<void>

• Returns Promise<void>