The application/oipfSearchManager embedded object
OITFs SHALL implement the “application/oipfSearchManager” embedded object. This object provides a mechanism for applications to create and manage metadata searches.
|readonly Integer guideDaysAvailable|
|The number of days for which guide data is available. A value of -1 means that the amount of guide data available is unknown.|
function onMetadataSearch( MetadataSearch search, Integer state )
This function is the DOM 0 event handler for events relating to metadata searches. The specified function is called with the arguments search and state. These arguments are defined as follows:
· MetadataSearch search – the affected search
· Integer state – the new state of the search
For the intrinsic events listed in the table below, a corresponding DOM event SHALL be generated in the following manner:
|Intrinsic event||Corresponding DOM event||DOM Event properties|
|onMetadataSearch||MetadataSearch||Bubbles: No Cancellable: No Context Info: search, state|
|onMetadataUpdate||MetadataUpdate||Bubbles: No Cancellable: No Context Info: action, info, object|
Note: these DOM events are directly dispatched to the event target, and will not bubble nor capture. Applications SHOULD NOT rely on receiving these events during the bubbling or the capturing phase. Applications that use DOM event handlers SHALL call the addEventListener() method on the application/oipfSearchManager object itself. The third parameter of addEventListener, i.e. “useCapture”, will be ignored.
MetadataSearch createSearch( Integer searchTarget )
Create a MetadataSearch object that can be used to search the metadata.
The metadata that should be searched.
Valid values of the searchTarget parameter are:
These values are treated as a bitfield, allowing searches to be carried out across multiple search targets.
Returns the channel line-up of the tuner in the form of a ChannelConfig object as defined in section 7.13.9. This includes the favourite lists.
The ChannelConfig object returned from this function SHALL be identical to the ChannelConfig object returned from the getChannelConfig() method on the video/broadcast object as defined in section 126.96.36.199.