app/docs/dev/api/plugin/model.md

61 lines
937 B
Markdown
Raw Normal View History

2024-08-19 09:43:46 +08:00
---
title: liteyuki.plugin.model
order: 1
icon: laptop-code
category: API
---
### ***class*** `PluginType(Enum)`
插件类型枚举值
####   ***attr*** `APPLICATION`
Type: 'application'
####   ***attr*** `SERVICE`
Type: 'service'
####   ***attr*** `IMPLEMENTATION`
Type: 'implementation'
####   ***attr*** `MODULE`
Type: 'module'
####   ***attr*** `UNCLASSIFIED`
Type: 'unclassified'
### ***class*** `PluginMetadata(BaseModel)`
轻雪插件元数据由插件编写者提供name为必填项
Attributes:
----------
name: str
插件名称
description: str
插件描述
usage: str
插件使用方法
type: str
插件类型
author: str
插件作者
homepage: str
插件主页
extra: dict[str, Any]
额外信息
### ***class*** `Plugin(BaseModel)`
存储插件信息
####   ***attr*** `model_config`
Type: {'arbitrary_types_allowed': True}