Files
Umbraco-CMS/src/Umbraco.Web/Trees/ISearchableTree.cs
T
2018-12-19 16:00:29 +01:00

28 lines
993 B
C#

using System.Collections.Generic;
using Umbraco.Core.Composing;
using Umbraco.Web.Models.ContentEditing;
namespace Umbraco.Web.Trees
{
public interface ISearchableTree : IDiscoverable
{
/// <summary>
/// The alias of the tree that the <see cref="ISearchableTree"/> belongs to
/// </summary>
string TreeAlias { get; }
/// <summary>
/// Searches for results based on the entity type
/// </summary>
/// <param name="query"></param>
/// <param name="pageSize"></param>
/// <param name="pageIndex"></param>
/// <param name="totalFound"></param>
/// <param name="searchFrom">
/// A starting point for the search, generally a node id, but for members this is a member type alias
/// </param>
/// <returns></returns>
IEnumerable<SearchResultEntity> Search(string query, int pageSize, long pageIndex, out long totalFound, string searchFrom = null);
}
}