mirror of
https://github.com/zoriya/Kyoo.git
synced 2025-05-24 02:02:36 -04:00
71 lines
2.6 KiB
C#
71 lines
2.6 KiB
C#
// Kyoo - A portable and vast media library solution.
|
|
// Copyright (c) Kyoo.
|
|
//
|
|
// See AUTHORS.md and LICENSE file in the project root for full license information.
|
|
//
|
|
// Kyoo is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// any later version.
|
|
//
|
|
// Kyoo is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using Kyoo.Abstractions.Models.Exceptions;
|
|
|
|
namespace Kyoo.Abstractions.Controllers
|
|
{
|
|
/// <summary>
|
|
/// A manager to load plugins and retrieve information from them.
|
|
/// </summary>
|
|
public interface IPluginManager
|
|
{
|
|
/// <summary>
|
|
/// Get a single plugin that match the type and name given.
|
|
/// </summary>
|
|
/// <param name="name">The name of the plugin</param>
|
|
/// <typeparam name="T">The type of the plugin</typeparam>
|
|
/// <exception cref="ItemNotFoundException">If no plugins match the query</exception>
|
|
/// <returns>A plugin that match the queries</returns>
|
|
public T GetPlugin<T>(string name);
|
|
|
|
/// <summary>
|
|
/// Get all plugins of the given type.
|
|
/// </summary>
|
|
/// <typeparam name="T">The type of plugins to get</typeparam>
|
|
/// <returns>A list of plugins matching the given type or an empty list of none match.</returns>
|
|
public ICollection<T> GetPlugins<T>();
|
|
|
|
/// <summary>
|
|
/// Get all plugins currently running on Kyoo. This also includes deleted plugins if the app as not been restarted.
|
|
/// </summary>
|
|
/// <returns>All plugins currently loaded.</returns>
|
|
public ICollection<IPlugin> GetAllPlugins();
|
|
|
|
/// <summary>
|
|
/// Load plugins and their dependencies from the plugin directory.
|
|
/// </summary>
|
|
/// <param name="plugins">
|
|
/// An initial plugin list to use.
|
|
/// You should not try to put plugins from the plugins directory here as they will get automatically loaded.
|
|
/// </param>
|
|
public void LoadPlugins(ICollection<IPlugin> plugins);
|
|
|
|
/// <summary>
|
|
/// Load plugins and their dependencies from the plugin directory.
|
|
/// </summary>
|
|
/// <param name="plugins">
|
|
/// An initial plugin list to use.
|
|
/// You should not try to put plugins from the plugins directory here as they will get automatically loaded.
|
|
/// </param>
|
|
public void LoadPlugins(params Type[] plugins);
|
|
}
|
|
}
|