FlyonDeckMarketplace
API v1
Documentation/清单参考

字段索引

从字段路径查找它所属的清单对象和属性定义。

Plugin API v1

Documentation content is currently available in Simplified Chinese.

知道字段名时，可以在这里找到它所属的对象。清单字段的路径从 manifest 开始，[] 表示数组项，<key> 表示由开发者命名的字段。每个链接都跳转到该属性的定义。

Schema 可以出现在动作、状态或数据提供者中。它的属性统一在 Schema 定义，索引使用 Schema 作为路径前缀。

#manifest.json

字段路径 类型 定义
manifest.apiVersion integer Manifest.apiVersion
manifest.id string Manifest.id
manifest.name string Manifest.name
manifest.version string Manifest.version
manifest.main string Manifest.main
manifest.hostPlatforms string[] Manifest.hostPlatforms
manifest.permissions string[] Manifest.permissions
manifest.contributes Contributions Manifest.contributes
manifest.description string Manifest.description
manifest.author string Manifest.author
manifest.icon string Manifest.icon
manifest.category string Manifest.category
manifest.tags string[] Manifest.tags
manifest.dependencies Record<string, string> Manifest.dependencies
manifest.networkOrigins string[] Manifest.networkOrigins
manifest.widgetConnectOrigins string[] Manifest.widgetConnectOrigins
manifest.uses ServiceUse[] Manifest.uses
manifest.eventSubscriptions EventSubscription[] Manifest.eventSubscriptions
manifest.eventSubscriptions[].pluginId string EventSubscription.pluginId
manifest.eventSubscriptions[].eventId string EventSubscription.eventId
manifest.eventSubscriptions[].version integer EventSubscription.version
manifest.contributes.categories Category[] Contributions.categories
manifest.contributes.actions Action[] Contributions.actions
manifest.contributes.buttonPresets ButtonPreset[] Contributions.buttonPresets
manifest.contributes.stateSources StateSource[] Contributions.stateSources
manifest.contributes.widgets Widget[] Contributions.widgets
manifest.contributes.dataProviders DataProvider[] Contributions.dataProviders
manifest.contributes.events PluginEvent[] Contributions.events
manifest.contributes.services Service[] Contributions.services
manifest.hostCapabilities HostCapabilityRequirements Manifest.hostCapabilities
manifest.hostCapabilities.required Record<string, integer> Manifest.hostCapabilities.required
manifest.hostCapabilities.optional Record<string, integer> Manifest.hostCapabilities.optional
manifest.target object Manifest.target
manifest.target.platform string Manifest.target.platform
manifest.target.arch string Manifest.target.arch
manifest.target.libc string Manifest.target.libc
manifest.runtime object Manifest.runtime
manifest.runtime.node string Manifest.runtime.node
manifest.runtime.electron string Manifest.runtime.electron
manifest.runtime.modules string Manifest.runtime.modules
manifest.runtime.napi integer Manifest.runtime.napi
manifest.nativeModules string[] Manifest.nativeModules
manifest.settingsSchema WidgetSettings Manifest.settingsSchema
manifest.configPage string Manifest.configPage
manifest.configurationVersion integer Manifest.configurationVersion
manifest.configurationMigrations integer[] Manifest.configurationMigrations

#actions

字段路径 类型 定义
manifest.contributes.actions[].id string Action.id
manifest.contributes.actions[].title string Action.title
manifest.contributes.actions[].hostPlatforms string[] Action.hostPlatforms
manifest.contributes.actions[].description string Action.description
manifest.contributes.actions[].icon string Action.icon
manifest.contributes.actions[].category string Action.category
manifest.contributes.actions[].argsSchema Schema Action.argsSchema
manifest.contributes.actions[].outputSchema Schema Action.outputSchema
manifest.contributes.actions[].execution ActionExecution Action.execution
manifest.contributes.actions[].execution.timeoutMs integer ActionExecution.timeoutMs
manifest.contributes.actions[].execution.concurrency "serial" | "parallel" ActionExecution.concurrency
manifest.contributes.actions[].execution.resource string ActionExecution.resource
manifest.contributes.actions[].execution.hostResource "desktop" | "audio" ActionExecution.hostResource
manifest.contributes.categories[].id string Category.id
manifest.contributes.categories[].title string Category.title
manifest.contributes.categories[].icon string Category.icon
manifest.contributes.widgets[].instanceActions[].execution.timeoutMs integer ActionExecution.timeoutMs
manifest.contributes.widgets[].instanceActions[].execution.concurrency "serial" | "parallel" ActionExecution.concurrency
manifest.contributes.widgets[].instanceActions[].execution.resource string ActionExecution.resource
manifest.contributes.widgets[].instanceActions[].execution.hostResource "desktop" | "audio" ActionExecution.hostResource
manifest.contributes.actions[].valueControl object Action.valueControl
manifest.contributes.actions[].valueControl.parameter string Action.valueControl
manifest.contributes.actions[].valueControl.state object Action.valueControl
manifest.contributes.actions[].valueControl.state.sourceId string Action.valueControl
manifest.contributes.actions[].valueControl.state.path string[] Action.valueControl
manifest.contributes.actions[].valueControl.state.availabilityPath string[] Action.valueControl
manifest.contributes.categories[].group string Category.group

#Schema

字段路径 类型 定义
Schema.type string Schema.type
Schema.title string Schema.title
Schema.description string Schema.description
Schema.properties Record<string, Schema> Schema.properties
Schema.required string[] Schema.required
Schema.additionalProperties boolean Schema.additionalProperties
Schema.items Schema Schema.items
Schema.enum JSON[] Schema.enum
Schema.enumLabels string[] Schema.enumLabels
Schema.minimum number Schema.minimum
Schema.maximum number Schema.maximum
Schema.maxLength integer Schema.maxLength
Schema.maxItems integer Schema.maxItems
Schema.default JSON Schema.default
Schema.options SchemaOption[] Schema.options
Schema.format string Schema.format
Schema.allowedSchemes string[] Schema.allowedSchemes
Schema.filePicker FilePicker Schema.filePicker
Schema.options[].label string SchemaOption.label
Schema.options[].value string SchemaOption.value
manifest.contributes.actions[].argsSchema.type "object" Schema.type
manifest.contributes.widgets[].instanceActions[].argsSchema.type "object" Schema.type
manifest.contributes.dataProviders[].requestSchema.type "object" Schema.type
manifest.contributes.events[].payloadSchema.type "object" Schema.type
Schema.dynamicOptions true Schema.dynamicOptions

#参数编辑器

字段路径 类型 定义
Schema.filePicker.filters FileFilter[] FilePicker.filters
Schema.filePicker.filters[].name string FileFilter.name
Schema.filePicker.filters[].extensions string[] FileFilter.extensions

#stateSources

字段路径 类型 定义
manifest.contributes.stateSources[].id string StateSource.id
manifest.contributes.stateSources[].title string StateSource.title
manifest.contributes.stateSources[].description string StateSource.description
manifest.contributes.stateSources[].scope string StateSource.scope
manifest.contributes.stateSources[].visibility string StateSource.visibility
manifest.contributes.stateSources[].widgetId string StateSource.widgetId
manifest.contributes.stateSources[].schema Schema StateSource.schema
manifest.contributes.stateSources[].readAccess StateReadAccess StateSource.readAccess
manifest.contributes.stateSources[].writeAccess "owner-plugin" StateSource.writeAccess
manifest.contributes.stateSources[].lifetime "plugin" | "layout" | "placement" StateSource.lifetime
manifest.contributes.stateSources[].maxBytes integer StateSource.maxBytes
manifest.contributes.stateSources[].readAccess.workflows boolean StateReadAccess.workflows
manifest.contributes.stateSources[].readAccess.widgets boolean StateReadAccess.widgets

#widgets

字段路径 类型 定义
manifest.contributes.widgets[].id string Widget.id
manifest.contributes.widgets[].title string Widget.title
manifest.contributes.widgets[].description string Widget.description
manifest.contributes.widgets[].category string Widget.category
manifest.contributes.widgets[].page string Widget.page
manifest.contributes.widgets[].configPage string Widget.configPage
manifest.contributes.widgets[].defaultSize WidgetSize Widget.defaultSize
manifest.contributes.widgets[].allowedSizes WidgetSize[] Widget.allowedSizes
manifest.contributes.widgets[].stateSource string Widget.stateSource
manifest.contributes.widgets[].customizableGestures string[] Widget.customizableGestures
manifest.contributes.widgets[].instanceActions WidgetInstanceAction[] Widget.instanceActions
manifest.contributes.widgets[].settingsSchema WidgetSettings Widget.settingsSchema
manifest.contributes.widgets[].defaultSize.cols integer WidgetSize.cols
manifest.contributes.widgets[].defaultSize.rows integer WidgetSize.rows
manifest.contributes.widgets[].instanceActions[].id string WidgetInstanceAction.id
manifest.contributes.widgets[].instanceActions[].title string WidgetInstanceAction.title
manifest.contributes.widgets[].instanceActions[].argsSchema Schema WidgetInstanceAction.argsSchema
manifest.contributes.widgets[].allowedSizes[].cols integer WidgetSize.cols
manifest.contributes.widgets[].allowedSizes[].rows integer WidgetSize.rows
manifest.contributes.widgets[].instanceActions[].execution ActionExecution WidgetInstanceAction.execution
manifest.contributes.widgets[].valueControl true Widget.valueControl

#WidgetSettings

字段路径 类型 定义
manifest.contributes.widgets[].settingsSchema.properties Record<string, WidgetSetting> WidgetSettings.properties
manifest.contributes.widgets[].settingsSchema.properties.<key>.type "string" | "integer" | "boolean" WidgetSetting.type
manifest.contributes.widgets[].settingsSchema.properties.<key>.title string WidgetSetting.title
manifest.contributes.widgets[].settingsSchema.properties.<key>.description string WidgetSetting.description
manifest.contributes.widgets[].settingsSchema.properties.<key>.default string | number | boolean WidgetSetting.default
manifest.contributes.widgets[].settingsSchema.properties.<key>.minimum integer WidgetSetting.minimum
manifest.contributes.widgets[].settingsSchema.properties.<key>.maximum integer WidgetSetting.maximum
manifest.contributes.widgets[].settingsSchema.properties.<key>.control "search-select" | "password" WidgetSetting.control
manifest.contributes.widgets[].settingsSchema.properties.<key>.visibility "public" | "private" WidgetSetting.visibility
manifest.contributes.widgets[].settingsSchema.properties.<key>.options SettingOption[] WidgetSetting.options
manifest.contributes.widgets[].settingsSchema.properties.<key>.dynamicOptions true WidgetSetting.dynamicOptions
manifest.contributes.widgets[].settingsSchema.properties.<key>.options[].label string SettingOption.label
manifest.contributes.widgets[].settingsSchema.properties.<key>.options[].value string SettingOption.value

#buttonPresets

字段路径 类型 定义
manifest.contributes.buttonPresets[].id string ButtonPreset.id
manifest.contributes.buttonPresets[].title string ButtonPreset.title
manifest.contributes.buttonPresets[].description string ButtonPreset.description
manifest.contributes.buttonPresets[].category string ButtonPreset.category
manifest.contributes.buttonPresets[].icon string ButtonPreset.icon
manifest.contributes.buttonPresets[].actionId string ButtonPreset.actionId
manifest.contributes.buttonPresets[].button ButtonAppearance ButtonPreset.button
manifest.contributes.buttonPresets[].multiState MultiState ButtonPreset.multiState
manifest.contributes.buttonPresets[].button.title string ButtonAppearance.title
manifest.contributes.buttonPresets[].button.titleFrom ButtonTitleFrom ButtonAppearance.titleFrom
manifest.contributes.buttonPresets[].button.icon ButtonIcon ButtonAppearance.icon
manifest.contributes.buttonPresets[].button.backgroundColor string ButtonAppearance.backgroundColor
manifest.contributes.buttonPresets[].button.foregroundColor string ButtonAppearance.foregroundColor
manifest.contributes.buttonPresets[].button.showTitle boolean ButtonAppearance.showTitle
manifest.contributes.buttonPresets[].button.size string ButtonAppearance.size
manifest.contributes.buttonPresets[].button.titleFrom.arg string ButtonTitleFrom.arg
manifest.contributes.buttonPresets[].button.titleFrom.transform string ButtonTitleFrom.transform
manifest.contributes.buttonPresets[].button.icon.kind string ButtonIcon.kind
manifest.contributes.buttonPresets[].button.icon.text string ButtonIcon.text
manifest.contributes.buttonPresets[].button.icon.arg string ButtonIcon.arg
manifest.contributes.buttonPresets[].button.icon.id string ButtonIcon.id
manifest.contributes.buttonPresets[].multiState.sourceId string MultiState.sourceId
manifest.contributes.buttonPresets[].multiState.sourceKind "local" MultiState.sourceKind
manifest.contributes.buttonPresets[].multiState.initialState string MultiState.initialState
manifest.contributes.buttonPresets[].multiState.persistent boolean MultiState.persistent
manifest.contributes.buttonPresets[].multiState.states ButtonState[] MultiState.states
manifest.contributes.buttonPresets[].multiState.states[].id string ButtonState.id
manifest.contributes.buttonPresets[].multiState.states[].actionId string ButtonState.actionId
manifest.contributes.buttonPresets[].multiState.states[].nextState string ButtonState.nextState
manifest.contributes.buttonPresets[].multiState.states[].button ButtonAppearance ButtonState.button
manifest.contributes.buttonPresets[].multiState.states[].button.title string ButtonAppearance.title
manifest.contributes.buttonPresets[].multiState.states[].button.titleFrom ButtonTitleFrom ButtonAppearance.titleFrom
manifest.contributes.buttonPresets[].multiState.states[].button.icon ButtonIcon ButtonAppearance.icon
manifest.contributes.buttonPresets[].multiState.states[].button.backgroundColor string ButtonAppearance.backgroundColor
manifest.contributes.buttonPresets[].multiState.states[].button.foregroundColor string ButtonAppearance.foregroundColor
manifest.contributes.buttonPresets[].multiState.states[].button.showTitle boolean ButtonAppearance.showTitle
manifest.contributes.buttonPresets[].multiState.states[].button.size string ButtonAppearance.size
manifest.contributes.buttonPresets[].multiState.states[].button.titleFrom.arg string ButtonTitleFrom.arg
manifest.contributes.buttonPresets[].multiState.states[].button.titleFrom.transform string ButtonTitleFrom.transform
manifest.contributes.buttonPresets[].multiState.states[].button.icon.kind string ButtonIcon.kind
manifest.contributes.buttonPresets[].multiState.states[].button.icon.text string ButtonIcon.text
manifest.contributes.buttonPresets[].multiState.states[].button.icon.arg string ButtonIcon.arg
manifest.contributes.buttonPresets[].multiState.states[].button.icon.id string ButtonIcon.id

#dataProviders

字段路径 类型 定义
manifest.contributes.dataProviders[].id string DataProvider.id
manifest.contributes.dataProviders[].widget string DataProvider.widget
manifest.contributes.dataProviders[].lifetime "request" DataProvider.lifetime
manifest.contributes.dataProviders[].visibility "instance" DataProvider.visibility
manifest.contributes.dataProviders[].requestSchema Schema DataProvider.requestSchema
manifest.contributes.dataProviders[].responseSchema Schema DataProvider.responseSchema
manifest.contributes.dataProviders[].timeoutMs integer DataProvider.timeoutMs
manifest.contributes.dataProviders[].maxBytes integer DataProvider.maxBytes

#events

字段路径 类型 定义
manifest.contributes.events[].id string PluginEvent.id
manifest.contributes.events[].title string PluginEvent.title
manifest.contributes.events[].delivery "ephemeral" PluginEvent.delivery
manifest.contributes.events[].version integer PluginEvent.version
manifest.contributes.events[].consumers ("host" | "plugins")[] PluginEvent.consumers
manifest.contributes.events[].payloadSchema Schema PluginEvent.payloadSchema
manifest.contributes.events[].maxBytes integer PluginEvent.maxBytes

#services 与 uses

字段路径 类型 定义
manifest.contributes.services[].id string Service.id
manifest.contributes.services[].title string Service.title
manifest.contributes.services[].version integer Service.version
manifest.contributes.services[].methods string[] Service.methods
manifest.uses[].pluginId string ServiceUse.pluginId
manifest.uses[].serviceId string ServiceUse.serviceId
manifest.uses[].version integer ServiceUse.version
manifest.contributes.services[].methodSchemas object Service.methodSchemas
manifest.contributes.services[].maxBytes integer Service.maxBytes
manifest.contributes.services[].methodSchemas.<key>.argsSchema Schema Service.methodSchemas
manifest.contributes.services[].methodSchemas.<key>.argsSchema.type object Service.methodSchemas
manifest.contributes.services[].methodSchemas.<key>.outputSchema Schema Service.methodSchemas

#国际化

字段路径 类型 定义
manifest.i18n object 资源归属
manifest.i18n.messages object 资源归属
manifest.i18n.defaultLocale string 资源归属
manifest.i18n.resources Record<string, string> 资源归属
manifest.nameKey string 清单展示字段
manifest.descriptionKey string 清单展示字段
manifest.contributes.actions[].titleKey string 清单展示字段
manifest.contributes.actions[].descriptionKey string 清单展示字段
manifest.contributes.buttonPresets[].button.titleKey string 清单展示字段
manifest.contributes.buttonPresets[].multiState.states[].button.titleKey string 清单展示字段
manifest.contributes.buttonPresets[].titleKey string 清单展示字段
manifest.contributes.buttonPresets[].descriptionKey string 清单展示字段
manifest.contributes.stateSources[].titleKey string 清单展示字段
manifest.contributes.stateSources[].descriptionKey string 清单展示字段
manifest.contributes.widgets[].instanceActions[].titleKey string 清单展示字段
manifest.contributes.widgets[].settingsSchema.properties.<key>.options[].labelKey string 清单展示字段
manifest.contributes.widgets[].settingsSchema.properties.<key>.titleKey string 清单展示字段
manifest.contributes.widgets[].settingsSchema.properties.<key>.descriptionKey string 清单展示字段
manifest.contributes.widgets[].titleKey string 清单展示字段
manifest.contributes.widgets[].descriptionKey string 清单展示字段
manifest.contributes.widgets[].categoryKey string 清单展示字段
manifest.contributes.events[].titleKey string 清单展示字段
manifest.contributes.services[].titleKey string 清单展示字段
manifest.contributes.categories[].titleKey string 清单展示字段
Schema.options[].labelKey string 清单展示字段
Schema.filePicker.filters[].nameKey string 清单展示字段
Schema.titleKey string 清单展示字段
Schema.descriptionKey string 清单展示字段
manifest.settingsSchema.properties.<key>.options[].labelKey string 清单展示字段
manifest.settingsSchema.properties.<key>.titleKey string 清单展示字段
manifest.settingsSchema.properties.<key>.descriptionKey string 清单展示字段

#插件图标与资源

字段路径 类型 定义
manifest.contributes.iconPacks array IconPack
manifest.contributes.iconPacks[].id string IconPack
manifest.contributes.iconPacks[].title string IconPack
manifest.contributes.iconPacks[].titleKey string IconPack
manifest.contributes.iconPacks[].description string IconPack
manifest.contributes.iconPacks[].descriptionKey string IconPack
manifest.contributes.iconPacks[].paint string IconPack
manifest.contributes.iconPacks[].index string IconPack
manifest.contributes.iconPacks[].license string IconPack

#插件全局设置

字段路径 类型 定义
manifest.settingsSchema.properties Record<string, WidgetSetting> PluginSettings.properties
manifest.settingsSchema.properties.<key>.type "string" | "integer" | "boolean" PluginSetting.type
manifest.settingsSchema.properties.<key>.title string PluginSetting.title
manifest.settingsSchema.properties.<key>.description string PluginSetting.description
manifest.settingsSchema.properties.<key>.default string | number | boolean PluginSetting.default
manifest.settingsSchema.properties.<key>.minimum integer PluginSetting.minimum
manifest.settingsSchema.properties.<key>.maximum integer PluginSetting.maximum
manifest.settingsSchema.properties.<key>.control "search-select" | "password" PluginSetting.control
manifest.settingsSchema.properties.<key>.visibility "public" | "private" PluginSetting.visibility
manifest.settingsSchema.properties.<key>.options SettingOption[] PluginSetting.options
manifest.settingsSchema.properties.<key>.options[].label string PluginSettingOption.label
manifest.settingsSchema.properties.<key>.options[].value string PluginSettingOption.value
manifest.settingsSchema.properties.<key>.maxLength integer PluginSetting.maxLength
Updated 2026-11-04
View implementation sources