Class PluginBase

命名空间

Another_Mirai_Native.Abstractions

程序集

Another-Mirai-Native.Abstractions.dll

作为插件的抽象基类，为框架内的日志记录、消息收发、好友管理、群组管理和应用程序交互提供核心功能及接口。 插件开发者应从此类派生以实现自定义插件行为。

public abstract class PluginBase

继承

object

PluginBase

继承成员

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

构造函数

PluginBase()

protected PluginBase()

属性

API

框架提供给插件的核心接口，包含了日志记录、消息处理、好友管理、群组管理和应用程序交互等功能的访问点。插件开发者通过实现此接口来与框架进行交互，实现插件的具体功能。

public IPluginApi API { get; }

属性值

IPluginApi

PluginInfo

插件信息。

public virtual PluginInfo PluginInfo { get; }

属性值

PluginInfo

方法

OnDisableAsync(CancellationToken)

在插件禁用时异步执行必要的清理操作。

public virtual Task OnDisableAsync(CancellationToken ct)

参数

ct CancellationToken

可用于发出退出操作取消信号的取消令牌。

返回值

Task

表示异步退出操作的任务。

备注

可在派生类中重写此方法以实现自定义的退出逻辑。默认实现会立即完成。

OnEnableAsync(CancellationToken)

在插件启用时异步处理逻辑。

public virtual Task OnEnableAsync(CancellationToken ct)

参数

ct CancellationToken

可用于取消启用操作的取消令牌。

返回值

Task

表示异步启用操作的任务。

备注

在派生类中重写此方法以实现自定义的启用逻辑。默认实现会立即完成。