Child Events
This section provides details of all child events sent by the app to the Engine.
exitToDock
exitToFullscreenVideo
setFavAction
setScreensaver
Exit To Dock
the screensaver or dialog exits to the dock
Handler Name
exitToDock
Description
The exitToDock event is sent from the app to the Engine to
configure the screensaver or a dialog so that it exits to the dock when user activity occurs. Passing the null parameter
is required. The app should do nothing after this call, as control has passed to the Engine.
Sent To
Engine
Example
Exit To Fullscreen Video
the screensaver exits to fullscreen video
Handler Name
exitToFullscreenVideo
Description
The exitToFullscreenVideo event is sent from the app to the Engine to configure the screensaver so that it
exits to fullscreen video when user activity occurs. Passing the null parameter is required. The app should do nothing after this call, as control has passed to the Engine.
Sent To
Engine
Example
Set Favorite Action
controls the add/delete bookmark function in the global navigation bar
Handler Name
setFavAction
Description
The setFavAction event is sent to change the add/delete bookmark button on the global navigation bar. When
a new bookmark from this sidebar is added, the button should be changed to delete. When the bookmark from
this sidebar is deleted, the button should be changed to add. The data property of the HostEvent is an object with two properties: viewID and action.
The viewID property is the view associated with the button (or sidebar). The action property has
three possible values: add, delete, or disable. To receive an event when the user activates this button, listen to the onActivateAppButton and
switch on the event data type.
Sent To
Engine
Example
Set Screensaver
enables the screensaver in fullscreen mode
Handler Name
setScreensaver
Description
The setScreensaver event takes a Boolean that enables (true) or disables (false) the screensaver.This event
only works in fullscreen mode. The dock is hidden in screensaver mode. The following parameters for the screensaver are supported
in the device partner configuration file config.xml:
screensaver-timeout— the number of minutes of inactivity before the screensaver is activated. The default value is 15 minutes.screensaver-sidebar-opacity— the opacity of the sidebar when in screensaver mode. The default value is 112.screensaver-fullscreen-opacity— the opacity of the black overlay that is on top of the fullscreen UI when in screensaver mode. The default value is 204.
Sent To
Engine
Example