Class GuestAuthorization

Hierarchy (View Summary)

_ObjectSubSite
- GuestAuthorization

Implements

IGuestAuthorization

Index

Constructors

constructor

new GuestAuthorization(
config: IObjectSubSiteConfig,
props: IGuestAuthorization,
): GuestAuthorization
Parameters
- config: IObjectSubSiteConfig
- props: IGuestAuthorization
Returns GuestAuthorization
Overrides _ObjectSubSite.constructor
- Defined in src/Hotspot/GuestAuthorization.ts:17

Properties

_id

_id: string

authorized_by

authorized_by: string

end

end: number

mac

mac: string

qos_overwrite

qos_overwrite: boolean

qos_rate_max_down

qos_rate_max_down: number

qos_rate_max_up

qos_rate_max_up: number

qos_usage_quota

qos_usage_quota: number

site_id

site_id: string

start

start: number

Accessors

`Protected`config

get config(): IObjectSubSiteConfigComplete
Returns IObjectSubSiteConfigComplete
Inherited from _ObjectSubSite.config
- Defined in src/commons/_ObjectSubSite.ts:31
set config(value: IObjectSubSiteConfigComplete): 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: Controller): 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: AxiosInstance): 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: Debugger): 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: Site): void
Parameters
- value: Site
Returns void
Inherited from _ObjectSubSite.site
- Defined in src/commons/_ObjectSubController.ts:42

Methods

`Protected`checkNeeds

checkNeeds(minVersion?: string, unifiOs?: boolean): boolean
Parameters
- OptionalminVersion: string
- OptionalunifiOs: boolean
Returns boolean
Inherited from _ObjectSubSite.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 _ObjectSubSite.checkNeedVersion
- Defined in src/commons/_ObjectSubController.ts:104

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: string): 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: any): this
Parameters
- props: any
Returns this
Inherited from _ObjectSubSite.import
- Defined in src/commons/_ObjectSubSite.ts:40

`Protected`mapObject

mapObject<U extends _ObjectSubSite>(
constructor: new (config: IObjectSubSiteConfig, props: any) => U,
object: any,
): U
Type Parameters
- U extends _ObjectSubSite
Parameters
- constructor: new (config: IObjectSubSiteConfig, props: any) => U
  the construtor to map the object
- 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: keyof GuestAuthorization,
    value?: T,
    minVersion?: string,
    unifiOs?: boolean,
    allowUndefined?: boolean,
): boolean
Type Parameters
- T
Parameters
- key: keyof GuestAuthorization
  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 _ObjectSubSite.needVersion
- Defined in src/commons/_ObjectSubController.ts:116

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

toJSON

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

Class GuestAuthorization

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GuestAuthorization

Properties

_id

authorized_by

end

mac

qos_overwrite

qos_rate_max_down

qos_rate_max_up

qos_usage_quota

site_id

start

Accessors

Protectedconfig

Returns IObjectSubSiteConfigComplete

Parameters

Returns void

Protectedcontroller

Returns Controller

Parameters

Returns void

ProtectedcontrollerInstance

Returns AxiosInstance

Parameters

Returns void

Protecteddebug

Returns Debugger

Parameters

Returns void

Protectedinstance

Returns AxiosInstance

ProtectedprivateMap

Returns WeakMap<any, any>

Protectedsite

Returns Site

Parameters

Returns void

Methods

ProtectedcheckNeeds

Parameters

Returns boolean

ProtectedcheckNeedVersion

Parameters

Returns void

getController

Returns Controller

getInstance

Returns AxiosInstance

ProtectedgetPrivate

Type Parameters

Parameters

Returns T

Protectedimport

Parameters

Returns this

ProtectedmapObject

Type Parameters

Parameters

Returns U

ProtectedneedVersion

Type Parameters

Parameters

Returns boolean

ProtectedsetPrivate

Type Parameters

Parameters

Returns void

toJSON

Returns Partial<GuestAuthorization>

`Protected`config

`Protected`controller

`Protected`controllerInstance

`Protected`debug

`Protected`instance

`Protected`privateMap

`Protected`site

`Protected`checkNeeds

`Protected`checkNeedVersion

`Protected`getPrivate

`Protected`import

`Protected`mapObject

`Protected`needVersion

`Protected`setPrivate