Class Clients

Hierarchy (view full)

_ObjectSubSite
- Clients

Index

Constructors

Accessors

config controller controllerInstance debug instance privateMap site

Methods

checkNeedVersion checkNeeds create getById getByMac getController getInstance getPrivate import list list2 list3 mapObject needVersion setPrivate toJSON

Constructors

constructor

new Clients(config): Clients
Parameters
- config: IObjectSubSiteConfig
Returns Clients
Inherited from _ObjectSubSite.constructor
- Defined in src/commons/_ObjectSubSite.ts:18

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

`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

`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

create

create(client): Promise<undefined | Client>
Parameters
- client: partialClient
Returns Promise<undefined | Client>
- Defined in src/Clients/Clients.ts:24

getById

getById(_id): Promise<undefined | Client>
get a client by _id
Parameters
- _id: string
  unifiId
Returns Promise<undefined | Client>
- Defined in src/Clients/Clients.ts:53

getByMac

getByMac(mac): Promise<undefined | Client>
get a Client by mac call /stat/sta/:mac ( seems to return same as /stat/user/:mac )
Parameters
- mac: string
  the macAddress
Returns Promise<undefined | Client>
- Defined in src/Clients/Clients.ts:72

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

`Protected` import

import(props): this
Parameters
- props: any
Returns this
Inherited from _ObjectSubSite.import
- Defined in src/commons/_ObjectSubSite.ts:40

list

list(params?): Promise<Client[]>
Use this function to list clients

example to get all blocked user in the last 10 hours
```
list({
  type: 'blocked',
  conn: 'all',
  within: 10
});
```
example to get all user from the last 2 hours
```
list({
  type: 'all',
  conn: 'all',
  within: 2
});
```
Parameters
- Optional params: IClientListParams
Returns Promise<Client[]>
- Defined in src/Clients/Clients.ts:129

list2

list2(params?): Promise<Client[]>
Parameters
- Optional params: IClientListParams
Returns Promise<Client[]>
- Defined in src/Clients/Clients.ts:86

list3

list3(params?): Promise<Client[]>
Parameters
- Optional params: IClientListParams
Returns Promise<Client[]>
- Defined in src/Clients/Clients.ts:98

`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 Clients
  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

`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<Clients>
Returns Partial<Clients>
Inherited from _ObjectSubSite.toJSON
- Defined in src/commons/_ObjectSubController.ts:59

Class Clients

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Clients

Accessors

Protected config

Returns IObjectSubSiteConfigComplete

Parameters

Returns void

Protected controller

Returns Controller

Parameters

Returns void

Protected controllerInstance

Returns AxiosInstance

Parameters

Returns void

Protected debug

Returns Debugger

Parameters

Returns void

Protected instance

Returns AxiosInstance

Protected privateMap

Returns WeakMap<any, any>

Protected site

Returns Site

Parameters

Returns void

Methods

Protected checkNeedVersion

Parameters

Returns void

Protected checkNeeds

Parameters

Returns boolean

create

Parameters

Returns Promise<undefined | Client>

getById

Parameters

Returns Promise<undefined | Client>

getByMac

Parameters

Returns Promise<undefined | Client>

getController

Returns Controller

getInstance

Returns AxiosInstance

Protected getPrivate

Type Parameters

Parameters

Returns T

Protected import

Parameters

Returns this

list

Parameters

Returns Promise<Client[]>

list2

Parameters

Returns Promise<Client[]>

list3

Parameters

Returns Promise<Client[]>

Protected mapObject

Type Parameters

Parameters

Parameters

Returns U

Returns U

Protected needVersion

Type Parameters

Parameters

`Protected` config

`Protected` controller

`Protected` controllerInstance

`Protected` debug

`Protected` instance

`Protected` privateMap

`Protected` site

`Protected` checkNeedVersion

`Protected` checkNeeds

`Protected` getPrivate

`Protected` import

`Protected` mapObject

`Protected` needVersion

`Protected` setPrivate