Skip to end of metadata
Go to start of metadata

This component is deprecated and will be removed from Roku OS on January 1st, 2019.

Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

Beginning January 1st, 2018, any updates to existing channels using this component will be rejected during certification.

The Search Screen provides a standard way to allow users to enter text for searching.

Supported Interfaces

Note: some firmware versions may implement ifSearchScreen as ifRoSearchScreen.

Events

Description

This screen features a simplified keyboard (a-z, 0-9) designed to provide just the keys necessary to perform case-insensitive searches without punctuation.
Ideally, the user would enter a search string and the backend service would perform that query in a case-insensitive manner ignoring special characters like punctuation. The script is notified as each key is pressed so that a progress disclosure search can be performed if supported by the back-end service. In addition, the script can control the text displayed on the screen and will receive events when the text entry is complete.
In addition to entering search strings, this screen features a list that can be used to display search results or show the most recent searches. It's desirable for the screen to maintain a list of recent searches for the user to allow them to easily repeat a recent query without typing. In some implementations, it may be desirable to use this list to show a progressive set of results after each character while the user is typing.
This object is created with no parameters:


CreateObject("roSearchScreen")

Example

 

Image: roSearchScreen example results (search suggestions)

Image: roSearchScreen example results (search history)

 

  • No labels