Class AccessControlManagement

Hierarchy

EventEmitter
- AccessControlManagement

Index

Constructors

constructor

Methods

destroy emit getAccessLevel getPassword getService on

Constructors

constructor

new AccessControlManagement(password?: boolean): AccessControlManagement
Instantiates a new AccessControlManagement.
Parameters
- Optional password: boolean
  
  if set to true the service will listen for password settings
Returns AccessControlManagement
- Defined in lib/tv/AccessControlManagement.ts:77
new AccessControlManagement(password?: boolean, service?: AccessControl): AccessControlManagement
Instantiates a new AccessControlManagement.
Parameters
- Optional password: boolean
  
  if set to true the service will listen for password settings
- Optional service: AccessControl
  
  supply your own instance to sideload the AccessControl service
Returns AccessControlManagement
- Defined in lib/tv/AccessControlManagement.ts:84

Methods

destroy

destroy(): void
This destroys the AccessControlManagement. It unregisters all GET or SET handler it has associated with the given AccessControl service. It removes all event handlers which were registered to this object.

Returns void
- Defined in lib/tv/AccessControlManagement.ts:118

emit

emit(event: "update-control-level", accessLevel: AccessLevel): boolean
Parameters
- event: "update-control-level"
- accessLevel: AccessLevel
Returns boolean
- Defined in lib/tv/AccessControlManagement.ts:53
emit(event: "update-password", password: undefined | string, passwordRequired: boolean): boolean
Parameters
- event: "update-password"
- password: undefined | string
- passwordRequired: boolean
Returns boolean
- Defined in lib/tv/AccessControlManagement.ts:54

getAccessLevel

getAccessLevel(): AccessLevel
Returns
the current AccessLevel configured for the Home

Returns AccessLevel
- Defined in lib/tv/AccessControlManagement.ts:102

getPassword

getPassword(): undefined | string
Returns
the current password configured for the Home or undefined if no password is required.

Returns undefined | string
- Defined in lib/tv/AccessControlManagement.ts:109

getService

getService(): AccessControl
Returns
the AccessControl service

Returns AccessControl
- Defined in lib/tv/AccessControlManagement.ts:95

on

on(event: "update-control-level", listener: ((accessLevel: AccessLevel) => void)): AccessControlManagement
Parameters
- event: "update-control-level"
- listener: ((accessLevel: AccessLevel) => void)
  - - (accessLevel: AccessLevel): void
    - Parameters
      
      accessLevel: AccessLevel
      
      Returns void
Returns AccessControlManagement
- Defined in lib/tv/AccessControlManagement.ts:50
on(event: "update-password", listener: ((password: undefined | string, passwordRequired: boolean) => void)): AccessControlManagement
Parameters
- event: "update-password"
- listener: ((password: undefined | string, passwordRequired: boolean) => void)
  - - (password: undefined | string, passwordRequired: boolean): void
    - Parameters
      
      password: undefined | string
      
      passwordRequired: boolean
      
      Returns void
Returns AccessControlManagement
- Defined in lib/tv/AccessControlManagement.ts:51

Class AccessControlManagement

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Optional password: boolean

Returns AccessControlManagement

Parameters

Optional password: boolean

Optional service: AccessControl

Returns AccessControlManagement

Methods

destroy

Returns void

emit

Parameters

event: "update-control-level"

accessLevel: AccessLevel

Returns boolean

Parameters

event: "update-password"

password: undefined | string

passwordRequired: boolean

Returns boolean

getAccessLevel

Returns

Returns AccessLevel

getPassword

Returns

Returns undefined | string

getService

Returns

Returns AccessControl

on

Parameters

event: "update-control-level"

listener: ((accessLevel: AccessLevel) => void)

Parameters

accessLevel: AccessLevel

Returns void

Returns AccessControlManagement

Parameters

event: "update-password"

listener: ((password: undefined | string, passwordRequired: boolean) => void)

Parameters

password: undefined | string

passwordRequired: boolean

Returns void

Returns AccessControlManagement

Settings

Member Visibility

Theme

`Optional` password: boolean

`Optional` password: boolean

`Optional` service: AccessControl