Class ProgrammeFilter : isChannelIncluded Event


Boolean isChannelIncluded( ChannelAssignment channelAssignment )

Summary

Called to determine if a channel should be included in the search.


Remarks

Typically this is called twice per channel. Once when finding out how many programmes to search and a second time when searching the programmes.


Parameters

ParameterDescription
ChannelAssignment channelAssignment The channel to test


Returns

True if the channel should be included, false otherwise.


Examples

Code below will mean the search will only search on channels with an ID less than 10;

pFilter.isChannelIncluded = function( channelAssignment )
{
	return channelAssignment.channel.id < 10;
}


See Also

  • ChannelAssignment


    Requirements

    build 1070