jellyfin-server/MediaBrowser.Controller/Library/ILibrarySearchEngine.cs

30 lines
1.1 KiB
C#
Raw Normal View History

2013-03-28 22:00:58 +00:00
using MediaBrowser.Controller.Entities;
using System.Collections.Generic;
2013-04-26 19:20:53 +00:00
using System.Threading.Tasks;
2013-03-28 22:00:58 +00:00
namespace MediaBrowser.Controller.Library
{
/// <summary>
/// Interface ILibrarySearchEngine
/// </summary>
public interface ILibrarySearchEngine
{
/// <summary>
2013-03-28 22:08:04 +00:00
/// Searches items and returns them in order of relevance.
2013-03-28 22:00:58 +00:00
/// </summary>
/// <param name="items">The items.</param>
/// <param name="searchTerm">The search term.</param>
/// <returns>IEnumerable{BaseItem}.</returns>
2013-03-28 22:08:04 +00:00
/// <exception cref="System.ArgumentNullException">searchTerm</exception>
2013-03-28 22:00:58 +00:00
IEnumerable<BaseItem> Search(IEnumerable<BaseItem> items, string searchTerm);
2013-04-26 19:20:53 +00:00
/// <summary>
/// Gets the search hints.
/// </summary>
/// <param name="inputItems">The input items.</param>
/// <param name="searchTerm">The search term.</param>
2013-04-27 13:05:33 +00:00
/// <returns>Task{IEnumerable{SearchHintInfo}}.</returns>
Task<IEnumerable<SearchHintInfo>> GetSearchHints(IEnumerable<BaseItem> inputItems, string searchTerm);
2013-03-28 22:00:58 +00:00
}
}