External module scripts/bg/ss_controller

Controller for the screensaver

Index

Events

Variables

Functions

Events

onChromeMessage

onChromeMessage(request: IMsgType, sender: MessageSender, response: ChromeMsg.ResponseCB): boolean

- Defined in scripts/background/ss_controller.ts:238
Fired when a message is sent from either an extension process
(by runtime.sendMessage) or a content script (by tabs.sendMessage).

link

https://developer.chrome.com/extensions/runtime#event-onMessage

Parameters
- request: IMsgType
  
  details for the message
- sender: MessageSender
  
  MessageSender object
- response: ChromeMsg.ResponseCB
  
  function to call once after processing
Returns boolean

true if asynchronous

onIdleStateChanged

onIdleStateChanged(state: string): Promise<void>

- Defined in scripts/background/ss_controller.ts:201
Fired when the system changes to an active, idle or locked state. The event fires with "locked" if the screen is locked or the [built in] screensaver activates, "idle" if the system is unlocked and the user has not generated any input for a specified number of seconds, and "active" when the user generates input on an idle system.

link

https://developer.chrome.com/extensions/idle#event-onStateChanged

Parameters
- state: string
  
  current state of computer
Returns Promise<void>

Variables

Const ERR_SHOW

ERR_SHOW: string = ChromeLocale.localize('err_show_ss')

Error showing Screensaver

Const SS_URL

SS_URL: "/html/screensaver.html" = "/html/screensaver.html"

Screensaver URL

Const chromep

chromep: ChromePromise = new ChromePromise()

Functions

close

close(): void

- Defined in scripts/background/ss_controller.ts:80
Close all the screen saver windows

Returns void

display

display(single: boolean): Promise<void>

- Defined in scripts/background/ss_controller.ts:65
Display the screensaver(s)

remarks

Important: Always request screensaver through this call

Parameters
- single: boolean
  
  if true, only show on main display
Returns Promise<void>

hasFullscreen

hasFullscreen(disp?: chrome.system.display.DisplayInfo): Promise<boolean>

- Defined in scripts/background/ss_controller.ts:91
Determine if there is a full screen chrome window running on a display

Parameters
- Optional disp: chrome.system.display.DisplayInfo
  
  an optional connected display, otherwise the main display
Returns Promise<boolean>

true if there is a full screen window on the display

isActive

isActive(): boolean

- Defined in scripts/background/ss_controller.ts:44
Determine if the screensaver can be displayed

Returns boolean

true if we should display the screensaver

isShowing

isShowing(): Promise<boolean>

- Defined in scripts/background/ss_controller.ts:120
Determine if a screensaver is currently showing

Returns Promise<boolean>

true if showing

open

open(disp?: chrome.system.display.DisplayInfo): Promise<void>

- Defined in scripts/background/ss_controller.ts:136
Open a screensaver window on the given display

Parameters
- Optional disp: chrome.system.display.DisplayInfo
  
  an optional connected display, otherwise the main display
Returns Promise<void>

openOnAllDisplays

openOnAllDisplays(): Promise<void>

- Defined in scripts/background/ss_controller.ts:173
Open a screensaver on every connected display

Returns Promise<void>

Generated using TypeDoc