Class AccessControlManagement

Hierarchy

EventEmitter
- AccessControlManagement

Index

Constructors

Methods

destroy emit getAccessLevel getPassword getService on

Constructors

constructor

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

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:120

emit

emit(event: "update-control-level", accessLevel: AccessLevel): boolean
Parameters
- event: "update-control-level"
- accessLevel: AccessLevel
Returns boolean
- Defined in lib/tv/AccessControlManagement.ts:54
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:55

getAccessLevel

getAccessLevel(): AccessLevel
Returns AccessLevel
the current AccessLevel configured for the Home
- Defined in lib/tv/AccessControlManagement.ts:104

getPassword

getPassword(): undefined | string
Returns undefined | string
the current password configured for the Home or undefined if no password is required.
- Defined in lib/tv/AccessControlManagement.ts:111

getService

getService(): AccessControl
Returns AccessControl
the AccessControl service
- Defined in lib/tv/AccessControlManagement.ts:97

on

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