Documentation

Namespace: SSControl

SSControl

Controller for the screen saver

Source:

Members

<private, static, constant> _ERR_SHOW :string

Error showing Screensaver

Type:
  • string
Source:

<private, static, constant> _SS_URL :string

Screensaver URL

Type:
  • string
Source:

Methods

<private, static> _hasFullscreen(display) → {Promise.<boolean>}

Determine if there is a full screen chrome window running on a display

Parameters:
Name Type Description
display Object

a connected display
Source:
Returns:

true if there is a full screen window on the display

Type
Promise.<boolean>

<private, static> _isShowing() → {Promise.<boolean>}

Determine if the screen saver is currently showing

Source:
Returns:

true if showing

Type
Promise.<boolean>

<private, static> _onChromeMessage(request [, sender] [, response]) → {boolean}

Event: Fired when a message is sent from either an extension process
(by runtime.sendMessage) or a content script (by tabs.sendMessage).

Parameters:
Name Type Argument Description
request Chrome.Msg.Message

details for the message
sender Object <optional>

MessageSender object
response function <optional>

function to call once after processing
Source:
See:
Returns:

true if asynchronous

Type
boolean

<private, static> _onIdleStateChanged(state)

Event: Fired when the system changes to an active, idle or locked state. The event fires with "locked" if the screen is locked or the 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.

Parameters:
Name Type Description
state string

current state of computer
Source:
See:

<private, static> _open(display)

Open a screen saver window on the given display

Parameters:
Name Type Description
display Object

a connected display
Source:

<private, static> _openOnAllDisplays()

Open a screensaver on every display

Source:

<static> close()

Close all the screen saver windows

Source:

<static> display(single)

Display the screen saver(s) !Important: Always request screensaver through this call

Parameters:
Name Type Description
single boolean

if true, only show on one display
Source: