Interface IController

interface IController {
    auth: UnifiAuth;
    controllerInstance: AxiosInstance;
    sites: Sites;
    unifiOs: boolean;
    version?: string;
    createInstance(siteName?): AxiosInstance;
    getSites(): Promise<Site[]>;
    login(): Promise<IUser>;
    logout(): Promise<void>;
}

Implemented by

Controller

Index

Properties

auth controllerInstance sites unifiOs version?

Methods

createInstance getSites login logout

Properties

auth

auth: UnifiAuth

controllerInstance

controllerInstance: AxiosInstance

sites

sites: Sites

unifiOs

unifiOs: boolean

`Optional` version

version?: string

Methods

createInstance

createInstance(siteName?): AxiosInstance
Parameters
- Optional siteName: string
Returns AxiosInstance
- Defined in src/IController.ts:19

getSites

getSites(): Promise<Site[]>
Returns Promise<Site[]>
- Defined in src/IController.ts:13

login

login(): Promise<IUser>
Returns Promise<IUser>
- Defined in src/IController.ts:15

logout

logout(): Promise<void>
Returns Promise<void>
- Defined in src/IController.ts:17

Generated using TypeDoc