Class Index

chip

The (pseudo) namespace for the instance specific CHIP API.

chip.actions

The namespace for the CHIP API's actions contract, which allows you to provide a CHIP's actions with all related functionality.

chip.bag

The namespace for the CHIP API's bag contract, which allows you to access property bags attached to a CHIP instance and read or write properties in these bags.

chip.configuration

The namespace for the CHIP API's configuration contract, which allows you to read configuration parameters.

chip.configurationUi

The namespace for the CHIP API's configurationUi contract, which allows you to provide a CHIP-specific configuration UI with all related functionality.

chip.fullscreen

The namespace for the CHIP API's fullscreen contract, which allows you to deal with toggling of fullscreen mode.

chip.navigation

The namespace for the CHIP API's navigation contract, which allows you to navigate to a launchpad URL in a surrounding shell.

chip.preview

The namespace for the CHIP API's preview contract, which allows to display the CHIP in a preview mode.

chip.refresh

The namespace for the CHIP API's refresh contract, which allows you to handle refresh events.

chip.search

The namespace for the CHIP API's search contract with CHIP search-related functionality.

chip.searchProvider

The namespace for the CHIP API's searchProvider contract, which allows you to add a search provider to a surrounding shell.

chip.types

The namespace for the CHIP API's types contract, which allows the CHIP to offer multiple visualizations from which the page builder can choose.

chip.url

The namespace for the CHIP API's url contract, which allows you convert relative URLs into absolute ones.

chip.visible

The namespace for the CHIP API's visible contract regarding the CHIP's current visibility within the page.

chip.writeConfiguration

The namespace for the CHIP API's writeConfiguration contract which allows you to write configuration parameters.

contract

The (pseudo) namespace for contract interfaces (to be used by a page builder).

contract.actions

The namespace for the contract interface (to be used by a page builder) for the actions contract, which allows you to get a CHIP's actions with all related functionality.

contract.configurationUi

The namespace for the contract interface (to be used by a page builder) for the configurationUi contract, which allows you to use a CHIP-specific configuration UI with all related functionality.

The namespace for the contract interface (to be used by a page builder) for the preview contract, which allows you to display a CHIP in preview mode and to retrieve the URL of the CHIP's underlying application.

contract.search

The namespace for the contract interface (to be used by a page builder) for the search contract.

contract.types

The namespace for the contract interface (to be used by a page builder) for the types contract, which allows you to change the CHIP's type of visualization.