SearchableContainer
Object Hierarchy:
Description:
public interface SearchableContainer :
MediaContainer
The base class for searchable containers.
Classes that implement this interface can, for instance:
- Allow backends to implement a UPnP Search call using native searching (such as SQL or SPARQL queries).
- Provide the naïve default implementation of search, from this base class, which does a recursive tree walk.
The search_classes property lists what information this container may be searched for. It is mapped to upnp:searchClass (with
includeDerived assumed to be false),
All known implementing classes:
Content:
Properties:
Methods:
- public abstract async MediaObjects? search (SearchExpression? expression,
uint
offset, uint
max_count, out uint
total_matches, string
sort_criteria, Cancellable
? cancellable) throws Error
Recursively searches for all media objects that satisfy the given
search expression in this container.
- public async MediaObjects? simple_search (SearchExpression? expression,
uint
offset, uint
max_count, out uint
total_matches, string
sort_criteria, Cancellable
? cancellable) throws Error
Utility method that retrieves all children and recursively searches
for all media objects that satisfy the given search expression in this container.
- public async MediaObject? find_object (
string
id, Cancellable
? cancellable) throws Error
Recursively searches for media object with the given id in this
container.