SoftwareUpdateController Interface Reference

import"SoftwareUpdateControllerPlugin.idl";

Classes
interface	softwareUpdateEvent

Public Member Functions
void	addEventListener ([in] String event_name, [in] EventListener listener)
Boolean	cancelRFSoftwareUpdate ()
Boolean	cancelWebSoftwareUpdate ()
void	removeEventListener ([in] String event_name, [in] EventListener listener)
void	removeEventListener ([in] String event_name)
Boolean	startRFSoftwareUpdateSearch ([in] Integer tsid, [in] Integer onid)
Boolean	startWebSoftwareUpdateSearch ()

Public Attributes
const Integer	SOFTWARE_NO_NEW_SOFTWARE_FOUND = 1
const Integer	SOFTWARE_RF_UPDATE_COMPLETE = 4
const Integer	SOFTWARE_RF_UPDATE_ERROR = 5
const Integer	SOFTWARE_RF_UPDATE_FINDING = 2
const Integer	SOFTWARE_RF_UPDATE_LOADING = 3
const Integer	SOFTWARE_WEB_UPDATE_ACTIVATION = 10
const Integer	SOFTWARE_WEB_UPDATE_COMPLETE = 8
const Integer	SOFTWARE_WEB_UPDATE_ERROR = 9
const Integer	SOFTWARE_WEB_UPDATE_FINDING = 6
const Integer	SOFTWARE_WEB_UPDATE_LOADING = 7

Detailed Description

This is a class which implements global SoftwareUpdateController object.

Member Function Documentation

void SoftwareUpdateController.addEventListener	(	[in] String	event_name,
		[in] EventListener	listener
	)

Adds DOM2 event listener for specified event.

Possible values are: event_name: "softwareUpdateEvent", listener: function that has arguments similar to the softwareUpdateEvent interface properties.

Parameters

event_name	Name of the event.
listener	javascript function that has arguments like the properties listed in the listener's interface.

Boolean SoftwareUpdateController.cancelRFSoftwareUpdate

(

)

This function cancels ongoing RF software update process at anytime when it is called. When activating TV source, this function should be called in order to watch TV channels properly.

                        isCancelled = SoftwareUpdateController.cancelRFSoftwareUpdate();

Returns

true if function call is successful, false otherwise

Boolean SoftwareUpdateController.cancelWebSoftwareUpdate

(

)

This function cancels ongoing FTP software update process at anytime when it is called

                isCancelled = SoftwareUpdateController.cancelWebSoftwareUpdate();

Returns

true if function call is successful, false otherwise

void SoftwareUpdateController.removeEventListener	(	[in] String	event_name,
		[in] EventListener	listener
	)

Removes single DOM2 event listener for specified event

Possible values are: event_name: "softwareUpdateEvent", listener: function that has arguments similar to the softwareUpdateEvent interface properties.

Parameters

event_name	Name of the event
listener	named javascript function that has arguments like the properties listed in the listener's interface.

void SoftwareUpdateController.removeEventListener

(

[in] String

event_name

)

Removes all DOM2 event listeners for specified event

Parameters

event_name

Name of the event

See also

removeEventListener([in] String event_name, [in] EventListener listener);

Boolean SoftwareUpdateController.startRFSoftwareUpdateSearch	(	[in] Integer	tsid,
		[in] Integer	onid
	)

This function starts RF software update search and after oad is started js is notified with events. If you do not cancel update, platform downloads and activates new software/applications. This function should not be used while TV source is active.

                        if (SoftwareUpdateController.startRFSoftwareUpdateSearch(correctTsid, correctOnid) == false) {
                            done.fail("Could not start RF software update search");
                        }

Parameters

tsid	the transport stream id of the channel
onid	the original network id of the channel

Returns

true if function call is successful, false otherwise

Boolean SoftwareUpdateController.startWebSoftwareUpdateSearch

(

)

Starts web update search, informs js caller with an event, if you do not cancel web update, platform downloads and activates new software

                if (SoftwareUpdateController.startWebSoftwareUpdateSearch() == false) {
                    done.fail("Could not start web software update search");
                }

Returns

true if function call is successful, false otherwise

Member Data Documentation

const Integer SoftwareUpdateController.SOFTWARE_NO_NEW_SOFTWARE_FOUND = 1

No new RF software version is found.

const Integer SoftwareUpdateController.SOFTWARE_RF_UPDATE_COMPLETE = 4

The new RF software version is downloaded.

const Integer SoftwareUpdateController.SOFTWARE_RF_UPDATE_ERROR = 5

An Error is occured during the RF software update process.

const Integer SoftwareUpdateController.SOFTWARE_RF_UPDATE_FINDING = 2

Searching for the new RF software version.

const Integer SoftwareUpdateController.SOFTWARE_RF_UPDATE_LOADING = 3

Downloading for the new RF software version.

const Integer SoftwareUpdateController.SOFTWARE_WEB_UPDATE_ACTIVATION = 10

The new software version will be activated.

const Integer SoftwareUpdateController.SOFTWARE_WEB_UPDATE_COMPLETE = 8

The new software version is downloaded via FTP.

const Integer SoftwareUpdateController.SOFTWARE_WEB_UPDATE_ERROR = 9

An Error is occured during the software update process.

const Integer SoftwareUpdateController.SOFTWARE_WEB_UPDATE_FINDING = 6

Searching for the new software version via FTP.

const Integer SoftwareUpdateController.SOFTWARE_WEB_UPDATE_LOADING = 7

Downloading for the new software version via FTP.

---

The documentation for this interface was generated from the following file:

• SoftwareUpdateControllerPlugin.idl