API Reference / api/plugin/PluginDescription / PluginDescription

Class: PluginDescription

Defined in: api/plugin/PluginDescription.d.ts:7

插件加载器需要知道的基本信息，该基本信息用于表示插件的简要信息。

Methods

getAPIVersion()

getAPIVersion(): string

Defined in: api/plugin/PluginDescription.d.ts:36

获取插件设计支持的API版本。

Returns

string

该插件设计支持的API版本

---

getAuthors()

getAuthors(): string[]

Defined in: api/plugin/PluginDescription.d.ts:57

获取插件作者列表。

Returns

string[]

一个不可变的插件作者列表

---

getCommands()

getCommands(): Command[]

Defined in: api/plugin/PluginDescription.d.ts:118

返回此插件将运行时注册的命令列表。

Returns

Command[]

此插件将在运行时注册的命令列表

---

getContributors()

getContributors(): string[]

Defined in: api/plugin/PluginDescription.d.ts:64

获取插件贡献者列表。

Returns

string[]

一个不可变的插件贡献者列表

---

getDefaultPermission()

getDefaultPermission(): PermissionDefault

Defined in: api/plugin/PluginDescription.d.ts:111

获取为插件注册权限的默认值。

Returns

PermissionDefault

插件的权限的默认值

---

getDepend()

getDepend(): string[]

Defined in: api/plugin/PluginDescription.d.ts:90

获取需要此插件的其他插件列表。

Returns

string[]

一个不可变的插件依赖列表

---

getDescription()

getDescription(): string

Defined in: api/plugin/PluginDescription.d.ts:43

获取提供给插件的功能描述。如果未指定，则返回空字符串。

Returns

string

插件提供的功能描述，或者如果未指定则为空字符串

---

getFullName()

getFullName(): string

Defined in: api/plugin/PluginDescription.d.ts:29

返回插件的名称，包括版本号。

Returns

string

描述此插件和相应版本的简要名称

---

getLoad()

getLoad(): PluginLoadOrder

Defined in: api/plugin/PluginDescription.d.ts:50

返回插件启动时应该加载的阶段。

Returns

PluginLoadOrder

插件应该在启动时加载的阶段

---

getLoadBefore()

getLoadBefore(): string[]

Defined in: api/plugin/PluginDescription.d.ts:104

获取应该认为是软依赖的插件列表。

Returns

string[]

可以被视为软依赖的插件列表

---

getName()

getName(): string

Defined in: api/plugin/PluginDescription.d.ts:15

返回插件的名称。此名称是一个唯一的标识符，用于标识插件。

Returns

string

插件的名称

---

getPermissions()

getPermissions(): Permission[]

Defined in: api/plugin/PluginDescription.d.ts:125

返回此插件在启用后立即注册的权限列表。

Returns

Permission[]

此插件在启用后立即注册的权限列表

---

getPrefix()

getPrefix(): string

Defined in: api/plugin/PluginDescription.d.ts:76

返回前缀插件特定日志消息的日志前缀。如果未指定，则返回空字符串。

Returns

string

---

getProvides()

getProvides(): string[]

Defined in: api/plugin/PluginDescription.d.ts:83

获取提供给其他插件使用的插件API列表。这些可用于其他插件依赖于。

Returns

string[]

一个不可变的插件API列表，该列表用于提供给其他插件使用的插件API

---

getSoftDepend()

getSoftDepend(): string[]

Defined in: api/plugin/PluginDescription.d.ts:97

获取提供给其他插件的首选插件列表。

Returns

string[]

一个不可变的插件首选依赖列表

---

getVersion()

getVersion(): string

Defined in: api/plugin/PluginDescription.d.ts:22

返回插件的版本号。

Returns

string

插件的版本号

---

getWebsite()

getWebsite(): string

Defined in: api/plugin/PluginDescription.d.ts:71

返回此插件或其作者的网站地址。

Returns

string

插件的网站地址，如果未指定则为空字符串

---

toString()

toString(): string

Defined in: api/plugin/PluginDescription.d.ts:8

Returns

string