AsyncDataProvider Interface Reference

import"AsyncDataProvider.idl";

Classes
interface	channelListReady

Public Member Functions
void	addEventListener ([in] String event_name, [in] EventListener listener)
Boolean	getChannelList ([in] Boolean minifiedVersion)
void	removeEventListener ([in] String event_name, [in] EventListener listener)
void	removeEventListener ([in] String event_name)

Public Attributes
const Integer	COMPLETED_WITH_INCOMPLETE_DATA_SET = 2
const Integer	COMPLETED_WITH_SUCCESS = 0
const Integer	FAILED = 1

Detailed Description

This is a class which implements global AsyncDataProvider.

Member Function Documentation

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

Adds DOM2 event listener for specified event.

Possible values are: event_name: "channelListReady", listener: function that has arguments similar to the channelListReady 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 AsyncDataProvider.getChannelList

(

[in] Boolean

minifiedVersion

)

Triggers a channel list creation request. channelListReady event must be listened for response. If this method is called during an on going channel list creation process, current process is canceled and a new process is started.

            isCreated = AsyncDataProvider.getChannelList(true);

Parameters

minifiedVersion

true if minified version is requested, false otherwise.

Returns

true if channel list creation request successfuly handled

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

Removes single DOM2 event listener for specified event

Possible values are: event_name: "channelListReady", listener: function that has arguments similar to the channelListReady 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 AsyncDataProvider.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);

Member Data Documentation

const Integer AsyncDataProvider.COMPLETED_WITH_INCOMPLETE_DATA_SET = 2

Indicates that channel list retrival process is completed but there may be missing items in channel list.

const Integer AsyncDataProvider.COMPLETED_WITH_SUCCESS = 0

Indicates that channel list retrival process is completed successfuly.

const Integer AsyncDataProvider.FAILED = 1

Indicates that channel list retrival process is failed.

---

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

• AsyncDataProvider.idl