• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

The Secondary Browser

The secondary browser is a Technical Preview. Its behavior may change.

The secondary browser is a secondary application in KreaTV. It serves as a generic browser that can be used to display arbitrary web pages. It runs as its own process separated from the portal, and does not provide TOI access to the pages that it loads.

Configuration

To enable support for the secondary browser, add the following lines to your boot image configuration:


kreatv-app-webkit-browser
kreatv-license-multiapp

Loading a webpage

The secondary browser interprets the second argument to ToiSecondaryApplication.start() as the URL to load. The secondary browser will start loading the page and switch to STATE_HIDDEN.

The secondary browser does not wait for the page to finish loading before entering STATE_HIDDEN. It makes the state transition as soon as it has something to render to the screen.

Special behaviors

Exiting

Besides calling ToiSecondaryApplication.stop(), the secondary browser will be closed if window.close() is called in the page it has loaded.

Transition URLs

Showing

When the browser transitions from STATE_HIDDEN to STATE_VISIBLE.

The browser will read the TransitionToVisibleArgs, and substitute the special string #START_ARGS with the appropriate property.

Then the browser read StartUrl, and substitute #TRANSITION_ARGS with TransitionToVisibleArgs as the final url.

Hiding

When the browser transitions from STATE_VISIBLE to STATE_HIDDEN.

The browser will read the TransitionToHiddenArgs.

And then browser read StartUrl, and substitute #TRANSITION_ARGS with TransitionToHiddenArgs as the final url.

Example

If we have configuration in browser-properties.xml:


  <Property name="StartUrl">https://www.myvideoservice.com/#TRANSITION_ARGS</Property>
  <Property name="TransitionToVisibleArgs">#start?#START_ARGS</Property>
  <Property name="TransitionToHiddenArgs">#suspend</Property>

When browser is started by primary portal with ToiSecondaryApplication.start(callbacks, parameters), its showing url will be constructed as https://www.myvideoservice.com/#start?parameters.

When browser go to STATE_VISIBLE with ToiSecondaryApplication.show(callbacks), it will load its showing url constructed above.

When browser go to STATE_HIDDEN, it will load https://www.myvideoservice.com/#suspend.

5.1.p5

Copyright (c) 2017 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.