UNIVPLMDataIntegration/Admin.NET/Plugins/PluginCore/PluginCore.IPlugins/IPlugin.cs

58 lines
1.9 KiB
C#
Raw Normal View History

//===================================================
// License: GNU LGPLv3
// Contributors: yiyungent@gmail.com
// Project: https://yiyungent.github.io/PluginCore
// GitHub: https://github.com/yiyungent/PluginCore
//===================================================
using System;
using System.Collections.Generic;
using System.Text;
namespace PluginCore.IPlugins
{
public interface IPlugin
{
/// <summary>
/// 在启用插件之后: 这时插件Assemblies已被加载(插件上下文已load)
/// </summary>
/// <returns>
/// <para>当 IsSuccess 为 False, 主程序之后会回滚插件状态: (1)unload插件上下文 (2)更新plugin.config.json,标记为禁用状态</para>
/// </returns>
(bool IsSuccess, string Message) AfterEnable();
/// <summary>
/// 在禁用插件之前: 这时插件Assemblies还未被释放(插件上下文未Unload)
/// </summary>
/// <returns>
/// <para>只有当 IsSuccess 为 True, 主程序之后才会释放插件上下文, 并标记为已禁用</para>
/// <para>当 IsSuccess 为 False, 主程序不会释放插件上下文,也不会标记为禁用, 插件维持原状态</para>
/// </returns>
(bool IsSuccess, string Message) BeforeDisable();
/// <summary>
/// TODO: 更新未做
/// </summary>
/// <param name="currentVersion"></param>
/// <param name="targetVersion"></param>
/// <returns></returns>
(bool IsSuccess, string Message) Update(string currentVersion, string targetVersion);
/// <summary>
/// 主应用程序启动时
/// </summary>
void AppStart();
/// <summary>
/// 启动顺序: 此插件 所依赖的前置插件
/// </summary>
/// <value></value>
List<string> AppStartOrderDependPlugins { get; }
}
}