sbIMediaListMatch Interface Reference

This interface is used to provide a generic test on medialists. Note that instead of providing an object with this interface to a method that requires it, you may instead give a raw javascript function. eg: More...

import"sbIMediaPageManager.idl";

Inheritance diagram for sbIMediaListMatch:
[legend]
Collaboration diagram for sbIMediaListMatch:
[legend]

Public Member Functions

PRBool match (in sbIMediaList aList, [optional] in sbILibraryConstraint aConstraint)
 Callback method used to perform the test on the medialist. More...
 

Detailed Description

This interface is used to provide a generic test on medialists. Note that instead of providing an object with this interface to a method that requires it, you may instead give a raw javascript function. eg:

var page = pageMgr.registerPage("MyPage",
MYURL,
function(aList) { return (aList.type == "simple"); } );

Definition at line 146 of file sbIMediaPageManager.idl.

Member Function Documentation

PRBool sbIMediaListMatch::match ( in sbIMediaList  aList,
[optional] in sbILibraryConstraint  aConstraint 
)

Callback method used to perform the test on the medialist.

Parameters
aListthe media list to attempt to match
aConstraint(optional) A library constrain used as an additional matching criteria

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