github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-25 02:09:32 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/ui_actions_enhanced.devdocs.json
Kibana Machine e82e0a150f
[api-docs] Daily api_docs build (#144203)
2022-10-29 00:46:56 -04:00

4388 lines
No EOL
159 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"id": "uiActionsEnhanced",
"client": {
"classes": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AbstractActionStorage",
"type": "Class",
"tags": [],
"label": "AbstractActionStorage",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.AbstractActionStorage",
"text": "AbstractActionStorage"
},
" implements ",
"ActionStorage"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AbstractActionStorage.reload$",
"type": "CompoundType",
"tags": [],
"label": "reload$",
"description": [],
"signature": [
"Observable",
"<void> & Pick<",
"Subject",
"<void>, \"next\">"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AbstractActionStorage.count",
"type": "Function",
"tags": [],
"label": "count",
"description": [],
"signature": [
"() => Promise<number>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AbstractActionStorage.read",
"type": "Function",
"tags": [],
"label": "read",
"description": [],
"signature": [
"(eventId: string) => Promise<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
">"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AbstractActionStorage.read.$1",
"type": "string",
"tags": [],
"label": "eventId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AbstractActionStorage.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [],
"signature": [
"(event: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
") => Promise<void>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AbstractActionStorage.create.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
}
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AbstractActionStorage.update",
"type": "Function",
"tags": [],
"label": "update",
"description": [],
"signature": [
"(event: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
") => Promise<void>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AbstractActionStorage.update.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
}
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AbstractActionStorage.remove",
"type": "Function",
"tags": [],
"label": "remove",
"description": [],
"signature": [
"(eventId: string) => Promise<void>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AbstractActionStorage.remove.$1",
"type": "string",
"tags": [],
"label": "eventId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AbstractActionStorage.list",
"type": "Function",
"tags": [],
"label": "list",
"description": [],
"signature": [
"() => Promise<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
"[]>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory",
"type": "Class",
"tags": [],
"label": "ActionFactory",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.ActionFactory",
"text": "ActionFactory"
},
"<Config, ExecutionContext, FactoryContext> implements Omit<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Presentable",
"text": "Presentable"
},
"<FactoryContext>, \"getHref\">,",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Configurable",
"text": "Configurable"
},
"<Config, FactoryContext>,",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.PersistableState",
"text": "PersistableState"
},
"<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
">"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.isBeta",
"type": "boolean",
"tags": [],
"label": "isBeta",
"description": [],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.minimalLicense",
"type": "CompoundType",
"tags": [],
"label": "minimalLicense",
"description": [],
"signature": [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.licenseFeatureName",
"type": "string",
"tags": [],
"label": "licenseFeatureName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.order",
"type": "number",
"tags": [],
"label": "order",
"description": [],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.MenuItem",
"type": "Function",
"tags": [],
"label": "MenuItem",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UiComponent",
"text": "UiComponent"
},
"<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionMenuItemProps",
"text": "ActionMenuItemProps"
},
"<FactoryContext>> | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.ReactMenuItem",
"type": "Function",
"tags": [],
"label": "ReactMenuItem",
"description": [],
"signature": [
"React.FC<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionMenuItemProps",
"text": "ActionMenuItemProps"
},
"<FactoryContext>> | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.CollectConfig",
"type": "Function",
"tags": [],
"label": "CollectConfig",
"description": [],
"signature": [
"() => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UiComponentInstance",
"text": "UiComponentInstance"
},
"<",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.CollectConfigProps",
"text": "CollectConfigProps"
},
"<Config, FactoryContext>>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.ReactCollectConfig",
"type": "Function",
"tags": [],
"label": "ReactCollectConfig",
"description": [],
"signature": [
"React.FunctionComponent<",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.CollectConfigProps",
"text": "CollectConfigProps"
},
"<Config, FactoryContext>>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.ReactCollectConfig.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P & { children?: React.ReactNode; }"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.ReactCollectConfig.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.createConfig",
"type": "Function",
"tags": [],
"label": "createConfig",
"description": [],
"signature": [
"(context: FactoryContext) => Config"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.createConfig.$1",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"FactoryContext"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.isConfigValid",
"type": "Function",
"tags": [],
"label": "isConfigValid",
"description": [],
"signature": [
"(config: Config, context: FactoryContext) => boolean"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.isConfigValid.$1",
"type": "Uncategorized",
"tags": [],
"label": "config",
"description": [],
"signature": [
"Config"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.isConfigValid.$2",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"FactoryContext"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.migrations",
"type": "CompoundType",
"tags": [],
"label": "migrations",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.MigrateFunctionsObject",
"text": "MigrateFunctionsObject"
},
" | ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.GetMigrationFunctionObjectFn",
"text": "GetMigrationFunctionObjectFn"
}
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "def",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.ActionFactoryDefinition",
"text": "ActionFactoryDefinition"
},
"<Config, ExecutionContext, FactoryContext>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"signature": [
"ActionFactoryDeps"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.getIconType",
"type": "Function",
"tags": [],
"label": "getIconType",
"description": [],
"signature": [
"(context: FactoryContext) => string | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.getIconType.$1",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"FactoryContext"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.getDisplayName",
"type": "Function",
"tags": [],
"label": "getDisplayName",
"description": [],
"signature": [
"(context: FactoryContext) => string"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.getDisplayName.$1",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"FactoryContext"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.getDisplayNameTooltip",
"type": "Function",
"tags": [],
"label": "getDisplayNameTooltip",
"description": [],
"signature": [
"(context: FactoryContext) => string"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.getDisplayNameTooltip.$1",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"FactoryContext"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.isCompatible",
"type": "Function",
"tags": [],
"label": "isCompatible",
"description": [],
"signature": [
"(context: FactoryContext) => Promise<boolean>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.isCompatible.$1",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"FactoryContext"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.isCompatibleLicense",
"type": "Function",
"tags": [],
"label": "isCompatibleLicense",
"description": [
"\nDoes this action factory license requirements\ncompatible with current license?"
],
"signature": [
"() => boolean"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [],
"signature": [
"(serializedAction: Omit<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedAction",
"text": "SerializedAction"
},
"<Config>, \"factoryId\">) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<ExecutionContext>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.create.$1",
"type": "Object",
"tags": [],
"label": "serializedAction",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedAction",
"text": "SerializedAction"
},
"<Config>, \"factoryId\">"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.supportedTriggers",
"type": "Function",
"tags": [],
"label": "supportedTriggers",
"description": [],
"signature": [
"() => string[]"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.telemetry",
"type": "Function",
"tags": [],
"label": "telemetry",
"description": [],
"signature": [
"(state: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
", telemetryData: Record<string, string | number | boolean>) => Record<string, any>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.telemetry.$1",
"type": "Object",
"tags": [],
"label": "state",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
}
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.telemetry.$2",
"type": "Object",
"tags": [],
"label": "telemetryData",
"description": [],
"signature": [
"Record<string, string | number | boolean>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.extract",
"type": "Function",
"tags": [],
"label": "extract",
"description": [],
"signature": [
"(state: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
") => { state: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
"; references: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]; }"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.extract.$1",
"type": "Object",
"tags": [],
"label": "state",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
}
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.inject",
"type": "Function",
"tags": [],
"label": "inject",
"description": [],
"signature": [
"(state: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
", references: ",
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]) => ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
}
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.inject.$1",
"type": "Object",
"tags": [],
"label": "state",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
}
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactory.inject.$2",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AdvancedUiActionsPublicPlugin",
"type": "Class",
"tags": [],
"label": "AdvancedUiActionsPublicPlugin",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.AdvancedUiActionsPublicPlugin",
"text": "AdvancedUiActionsPublicPlugin"
},
" implements ",
{
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.Plugin",
"text": "Plugin"
},
"<",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.SetupContract",
"text": "SetupContract"
},
", ",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.StartContract",
"text": "StartContract"
},
", SetupDependencies, ",
"StartDependencies",
">"
],
"path": "src/plugins/ui_actions_enhanced/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AdvancedUiActionsPublicPlugin.licenseInfo",
"type": "Object",
"tags": [],
"label": "licenseInfo",
"description": [],
"signature": [
"BehaviorSubject",
"<",
"ILicense",
" | undefined>"
],
"path": "src/plugins/ui_actions_enhanced/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AdvancedUiActionsPublicPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/ui_actions_enhanced/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AdvancedUiActionsPublicPlugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "initializerContext",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<object>"
],
"path": "src/plugins/ui_actions_enhanced/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AdvancedUiActionsPublicPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<",
"StartDependencies",
", unknown>, { embeddable, uiActions, licensing }: SetupDependencies) => ",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.SetupContract",
"text": "SetupContract"
}
],
"path": "src/plugins/ui_actions_enhanced/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AdvancedUiActionsPublicPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<",
"StartDependencies",
", unknown>"
],
"path": "src/plugins/ui_actions_enhanced/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AdvancedUiActionsPublicPlugin.setup.$2",
"type": "Object",
"tags": [],
"label": "{ embeddable, uiActions, licensing }",
"description": [],
"signature": [
"SetupDependencies"
],
"path": "src/plugins/ui_actions_enhanced/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AdvancedUiActionsPublicPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
},
", { uiActions, licensing }: ",
"StartDependencies",
") => ",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.StartContract",
"text": "StartContract"
}
],
"path": "src/plugins/ui_actions_enhanced/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AdvancedUiActionsPublicPlugin.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
}
],
"path": "src/plugins/ui_actions_enhanced/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AdvancedUiActionsPublicPlugin.start.$2",
"type": "Object",
"tags": [],
"label": "{ uiActions, licensing }",
"description": [],
"signature": [
"StartDependencies"
],
"path": "src/plugins/ui_actions_enhanced/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.AdvancedUiActionsPublicPlugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/ui_actions_enhanced/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager",
"type": "Class",
"tags": [],
"label": "DynamicActionManager",
"description": [],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.idPrefixCounter",
"type": "number",
"tags": [],
"label": "idPrefixCounter",
"description": [],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.ui",
"type": "Object",
"tags": [],
"label": "ui",
"description": [
"\nUI State of the dynamic action manager."
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.ReduxLikeStateContainer",
"text": "ReduxLikeStateContainer"
},
"<",
"State",
", ",
"Transitions",
", ",
"Selectors",
">"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.DynamicActionManagerParams",
"text": "DynamicActionManagerParams"
}
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.getEvent",
"type": "Function",
"tags": [],
"label": "getEvent",
"description": [],
"signature": [
"(eventId: string) => ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
}
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.getEvent.$1",
"type": "string",
"tags": [],
"label": "eventId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.generateActionId",
"type": "Function",
"tags": [],
"label": "generateActionId",
"description": [
"\nWe prefix action IDs with a unique `.idPrefix`, so we can render the\nsame dashboard twice on the screen."
],
"signature": [
"(eventId: string) => string"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.generateActionId.$1",
"type": "string",
"tags": [],
"label": "eventId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.reviveAction",
"type": "Function",
"tags": [],
"label": "reviveAction",
"description": [],
"signature": [
"(event: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
") => void"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.reviveAction.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
}
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.killAction",
"type": "Function",
"tags": [],
"label": "killAction",
"description": [],
"signature": [
"({ eventId, triggers }: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
") => void"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.killAction.$1",
"type": "Object",
"tags": [],
"label": "{ eventId, triggers }",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
}
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.state",
"type": "Object",
"tags": [],
"label": "state",
"description": [
"\nRead-only state container of dynamic action manager. Use it to perform all\n*read* operations."
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.StateContainer",
"text": "StateContainer"
},
"<",
"State",
", object, {}>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [
"\n1. Loads all events from @type {DynamicActionStorage} storage.\n2. Creates actions for each event in `ui_actions` registry.\n3. Adds events to UI state.\n4. Does nothing if dynamic action manager was stopped or if event fetching\n is already taking place."
],
"signature": [
"() => Promise<void>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [
"\n1. Removes all events from `ui_actions` registry.\n2. Puts dynamic action manager is stopped state."
],
"signature": [
"() => Promise<void>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.createEvent",
"type": "Function",
"tags": [],
"label": "createEvent",
"description": [
"\nCreates a new event.\n\n1. Stores event in @type {DynamicActionStorage} storage.\n2. Optimistically adds it to UI state, and rolls back on failure.\n3. Adds action to `ui_actions` registry.\n"
],
"signature": [
"(action: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedAction",
"text": "SerializedAction"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">, triggers: string[]) => Promise<void>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.createEvent.$1",
"type": "Object",
"tags": [],
"label": "action",
"description": [
"Dynamic action for which to create an event."
],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedAction",
"text": "SerializedAction"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.createEvent.$2",
"type": "Array",
"tags": [],
"label": "triggers",
"description": [
"List of triggers to which action should react."
],
"signature": [
"string[]"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.updateEvent",
"type": "Function",
"tags": [],
"label": "updateEvent",
"description": [
"\nUpdates an existing event. Fails if event with given `eventId` does not\nexit.\n\n1. Updates the event in @type {DynamicActionStorage} storage.\n2. Optimistically replaces the old event by the new one in UI state, and\n rolls back on failure.\n3. Replaces action in `ui_actions` registry with the new event.\n\n"
],
"signature": [
"(eventId: string, action: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedAction",
"text": "SerializedAction"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">, triggers: string[]) => Promise<void>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.updateEvent.$1",
"type": "string",
"tags": [],
"label": "eventId",
"description": [
"ID of the event to replace."
],
"signature": [
"string"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.updateEvent.$2",
"type": "Object",
"tags": [],
"label": "action",
"description": [
"New action for which to create the event."
],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedAction",
"text": "SerializedAction"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.updateEvent.$3",
"type": "Array",
"tags": [],
"label": "triggers",
"description": [
"List of triggers to which action should react."
],
"signature": [
"string[]"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.deleteEvent",
"type": "Function",
"tags": [],
"label": "deleteEvent",
"description": [
"\nRemoves existing event. Throws if event does not exist.\n\n1. Removes the event from @type {DynamicActionStorage} storage.\n2. Optimistically removes event from UI state, and puts it back on failure.\n3. Removes associated action from `ui_actions` registry.\n"
],
"signature": [
"(eventId: string) => Promise<void>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.deleteEvent.$1",
"type": "string",
"tags": [],
"label": "eventId",
"description": [
"ID of the event to remove."
],
"signature": [
"string"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.deleteEvents",
"type": "Function",
"tags": [],
"label": "deleteEvents",
"description": [
"\nDeletes multiple events at once.\n"
],
"signature": [
"(eventIds: string[]) => Promise<void>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManager.deleteEvents.$1",
"type": "Array",
"tags": [],
"label": "eventIds",
"description": [
"List of event IDs."
],
"signature": [
"string[]"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.MemoryActionStorage",
"type": "Class",
"tags": [],
"label": "MemoryActionStorage",
"description": [
"\nThis is an in-memory implementation of ActionStorage. It is used in testing,\nbut can also be used production code to store events in memory."
],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.MemoryActionStorage",
"text": "MemoryActionStorage"
},
" extends ",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.AbstractActionStorage",
"text": "AbstractActionStorage"
}
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.MemoryActionStorage.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.MemoryActionStorage.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "events",
"description": [],
"signature": [
"readonly ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
"[]"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.MemoryActionStorage.list",
"type": "Function",
"tags": [],
"label": "list",
"description": [],
"signature": [
"() => Promise<{ eventId: string; triggers: string[]; action: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedAction",
"text": "SerializedAction"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">; }[]>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.MemoryActionStorage.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [],
"signature": [
"(event: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
") => Promise<void>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.MemoryActionStorage.create.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
}
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.MemoryActionStorage.update",
"type": "Function",
"tags": [],
"label": "update",
"description": [],
"signature": [
"(event: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
") => Promise<void>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.MemoryActionStorage.update.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
}
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.MemoryActionStorage.remove",
"type": "Function",
"tags": [],
"label": "remove",
"description": [],
"signature": [
"(eventId: string) => Promise<void>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.MemoryActionStorage.remove.$1",
"type": "string",
"tags": [],
"label": "eventId",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.compile",
"type": "Function",
"tags": [],
"label": "compile",
"description": [],
"signature": [
"(urlTemplate: string, context: object, doEncode: boolean) => Promise<string>"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_template.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.compile.$1",
"type": "string",
"tags": [],
"label": "urlTemplate",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_template.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.compile.$2",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"object"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_template.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.compile.$3",
"type": "boolean",
"tags": [],
"label": "doEncode",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_template.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.globalScopeProvider",
"type": "Function",
"tags": [],
"label": "globalScopeProvider",
"description": [],
"signature": [
"({\n core,\n}: UrlDrilldownGlobalScopeDeps) => () => ",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.UrlDrilldownGlobalScope",
"text": "UrlDrilldownGlobalScope"
}
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_drilldown_global_scope.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.globalScopeProvider.$1",
"type": "Object",
"tags": [],
"label": "{\n core,\n}",
"description": [],
"signature": [
"UrlDrilldownGlobalScopeDeps"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_drilldown_global_scope.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.UrlDrilldownCollectConfig",
"type": "Function",
"tags": [],
"label": "UrlDrilldownCollectConfig",
"description": [],
"signature": [
"(props: React.PropsWithChildren<",
"UrlDrilldownCollectConfigProps",
">) => JSX.Element"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/components/url_drilldown_collect_config/lazy.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.UrlDrilldownCollectConfig.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"React.PropsWithChildren<",
"UrlDrilldownCollectConfigProps",
">"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/components/url_drilldown_collect_config/lazy.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.validateUrl",
"type": "Function",
"tags": [],
"label": "validateUrl",
"description": [],
"signature": [
"(url: string) => { isValid: boolean; error?: string | undefined; }"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_validation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.validateUrl.$1",
"type": "string",
"tags": [],
"label": "url",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_validation.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.validateUrlTemplate",
"type": "Function",
"tags": [],
"label": "validateUrlTemplate",
"description": [],
"signature": [
"(urlTemplate: { format?: \"handlebars_v1\" | undefined; template: string; }, scope: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.UrlDrilldownScope",
"text": "UrlDrilldownScope"
},
"<object, object>) => Promise<{ isValid: boolean; error?: string | undefined; }>"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_validation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.validateUrlTemplate.$1",
"type": "Object",
"tags": [],
"label": "urlTemplate",
"description": [],
"signature": [
"{ format?: \"handlebars_v1\" | undefined; template: string; }"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_validation.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.validateUrlTemplate.$2",
"type": "Object",
"tags": [],
"label": "scope",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.UrlDrilldownScope",
"text": "UrlDrilldownScope"
},
"<object, object>"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_validation.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactoryDefinition",
"type": "Interface",
"tags": [],
"label": "ActionFactoryDefinition",
"description": [
"\nThis is a convenience interface for registering new action factories."
],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.ActionFactoryDefinition",
"text": "ActionFactoryDefinition"
},
"<Config, ExecutionContext, FactoryContext> extends Partial<Omit<",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Presentable",
"text": "Presentable"
},
"<FactoryContext>, \"getHref\">>,",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.Configurable",
"text": "Configurable"
},
"<Config, FactoryContext>,Partial<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.PersistableState",
"text": "PersistableState"
},
"<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
">>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactoryDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nUnique ID of the action factory. This ID is used to identify this action\nfactory in the registry as well as to construct actions of this type and\nidentify this action factory when presenting it to the user in UI."
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactoryDefinition.minimalLicense",
"type": "CompoundType",
"tags": [],
"label": "minimalLicense",
"description": [
"\nMinimal license level\nEmpty means no license restrictions"
],
"signature": [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactoryDefinition.licenseFeatureName",
"type": "string",
"tags": [],
"label": "licenseFeatureName",
"description": [
"\nRequired when `minimalLicense` is used.\nIs a user-facing string. Has to be unique. Doesn't need i18n.\nThe feature's name will be displayed to Cloud end-users when they're billed based on their feature usage."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactoryDefinition.isBeta",
"type": "CompoundType",
"tags": [],
"label": "isBeta",
"description": [
"\nIs this action factory not GA?\nAdds a beta badge on a list item representing this ActionFactory"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactoryDefinition.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [
"\nThis method should return a definition of a new action, normally used to\nregister it in `ui_actions` registry."
],
"signature": [
"(serializedAction: Omit<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedAction",
"text": "SerializedAction"
},
"<Config>, \"factoryId\">) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<ExecutionContext>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactoryDefinition.create.$1",
"type": "Object",
"tags": [],
"label": "serializedAction",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedAction",
"text": "SerializedAction"
},
"<Config>, \"factoryId\">"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.ActionFactoryDefinition.supportedTriggers",
"type": "Function",
"tags": [],
"label": "supportedTriggers",
"description": [],
"signature": [
"() => string[]"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.BaseActionFactoryContext",
"type": "Interface",
"tags": [],
"label": "BaseActionFactoryContext",
"description": [
"\nAction factory context passed into ActionFactories' CollectConfig, getDisplayName, getIconType"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.BaseActionFactoryContext.triggers",
"type": "Array",
"tags": [],
"label": "triggers",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition",
"type": "Interface",
"tags": [],
"label": "DrilldownDefinition",
"description": [
"\nThis is a convenience interface to register a drilldown. Drilldown has\nability to collect configuration from user. Once drilldown is executed it\nreceives the collected information together with the context of the\nuser's interaction.\n\n`Config` is a serializable object containing the configuration that the\ndrilldown is able to collect using UI.\n\n`ExecutionContext` is an object created in response to user's interaction\nand provided to the `execute` function of the drilldown. This object contains\ninformation about the action user performed."
],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.DrilldownDefinition",
"text": "DrilldownDefinition"
},
"<Config, ExecutionContext, FactoryContext> extends Partial<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.PersistableState",
"text": "PersistableState"
},
"<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
">>"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nGlobally unique identifier for this drilldown."
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.isBeta",
"type": "CompoundType",
"tags": [],
"label": "isBeta",
"description": [
"\nIs this action factory not GA?\nAdds a beta badge on a list item representing this ActionFactory"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.minimalLicense",
"type": "CompoundType",
"tags": [],
"label": "minimalLicense",
"description": [
"\nMinimal license level\nEmpty means no restrictions"
],
"signature": [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.licenseFeatureName",
"type": "string",
"tags": [],
"label": "licenseFeatureName",
"description": [
"\nRequired when `minimalLicense` is used.\nIs a user-facing string. Has to be unique. Doesn't need i18n.\nThe feature's name will be displayed to Cloud end-users when they're billed based on their feature usage."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.order",
"type": "number",
"tags": [],
"label": "order",
"description": [
"\nDetermines the display order of the drilldowns in the flyout picker.\nHigher numbers are displayed first."
],
"signature": [
"number | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.createConfig",
"type": "Function",
"tags": [],
"label": "createConfig",
"description": [
"\nFunction that returns default config for this drilldown."
],
"signature": [
"(context: FactoryContext) => Config"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.createConfig.$1",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"Context"
],
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.CollectConfig",
"type": "Function",
"tags": [],
"label": "CollectConfig",
"description": [
"\n`UiComponent` that collects config for this drilldown. You can create\na React component and transform it `UiComponent` using `uiToReactComponent`\nhelper from `kibana_utils` plugin.\n\n```tsx\nimport React from 'react';\nimport { uiToReactComponent } from 'src/plugins/kibana_utils';\nimport { CollectConfigProps } from 'src/plugins/kibana_utils/public';\n\ntype Props = CollectConfigProps<Config>;\n\nconst ReactCollectConfig: React.FC<Props> = () => {\n return <div>Collecting config...'</div>;\n};\n\nexport const CollectConfig = uiToReactComponent(ReactCollectConfig);\n```"
],
"signature": [
"() => ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UiComponentInstance",
"text": "UiComponentInstance"
},
"<",
{
"pluginId": "kibanaUtils",
"scope": "public",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-public.CollectConfigProps",
"text": "CollectConfigProps"
},
"<Config, FactoryContext>>"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.isConfigValid",
"type": "Function",
"tags": [],
"label": "isConfigValid",
"description": [
"\nA validator function for the config object. Should always return a boolean."
],
"signature": [
"(config: Config, context: FactoryContext) => boolean"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.isConfigValid.$1",
"type": "Uncategorized",
"tags": [],
"label": "config",
"description": [],
"signature": [
"Config"
],
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.isConfigValid.$2",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"Context"
],
"path": "src/plugins/kibana_utils/public/ui/configurable.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.isConfigurable",
"type": "Function",
"tags": [],
"label": "isConfigurable",
"description": [
"\nCompatibility check during drilldown creation.\nCould be used to filter out a drilldown if it's not compatible with the current context."
],
"signature": [
"((context: FactoryContext) => boolean) | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.isConfigurable.$1",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"FactoryContext"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.euiIcon",
"type": "string",
"tags": [],
"label": "euiIcon",
"description": [
"\nName of EUI icon to display when showing this drilldown to user."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.getDisplayName",
"type": "Function",
"tags": [],
"label": "getDisplayName",
"description": [
"\nShould return an internationalized name of the drilldown, which will be\ndisplayed to the user as the name of drilldown factory when configuring a drilldown."
],
"signature": [
"() => string"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.actionMenuItem",
"type": "Function",
"tags": [],
"label": "actionMenuItem",
"description": [
"\nName of the drilldown instance displayed to the user at the moment of\ndrilldown execution. Should be internationalized."
],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.UiComponent",
"text": "UiComponent"
},
"<{ config: Omit<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedAction",
"text": "SerializedAction"
},
"<Config>, \"factoryId\">; context: ExecutionContext | ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<ExecutionContext>; }> | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.isCompatible",
"type": "Function",
"tags": [],
"label": "isCompatible",
"description": [
"\nisCompatible during execution\nCould be used to prevent drilldown from execution"
],
"signature": [
"((config: Config, context: ExecutionContext | ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<ExecutionContext>) => Promise<boolean>) | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.isCompatible.$1",
"type": "Uncategorized",
"tags": [],
"label": "config",
"description": [],
"signature": [
"Config"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.isCompatible.$2",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
"ExecutionContext | ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<ExecutionContext>"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.execute",
"type": "Function",
"tags": [],
"label": "execute",
"description": [
"\nImplements the \"navigation\" action of the drilldown. This happens when\nuser clicks something in the UI that executes a trigger to which this\ndrilldown was attached.\n"
],
"signature": [
"(config: Config, context: ExecutionContext | ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<ExecutionContext>) => void"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.execute.$1",
"type": "Uncategorized",
"tags": [],
"label": "config",
"description": [
"Config object that user configured this drilldown with."
],
"signature": [
"Config"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.execute.$2",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [
"Object that represents context in which the underlying\n`UIAction` of this drilldown is being executed in."
],
"signature": [
"ExecutionContext | ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<ExecutionContext>"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.getHref",
"type": "Function",
"tags": [],
"label": "getHref",
"description": [
"\nA link where drilldown should navigate on middle click or Ctrl + click."
],
"signature": [
"((config: Config, context: ExecutionContext | ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<ExecutionContext>) => Promise<string | undefined>) | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.getHref.$1",
"type": "Uncategorized",
"tags": [],
"label": "config",
"description": [],
"signature": [
"Config"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.getHref.$2",
"type": "CompoundType",
"tags": [],
"label": "context",
"description": [],
"signature": [
"ExecutionContext | ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionExecutionContext",
"text": "ActionExecutionContext"
},
"<ExecutionContext>"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownDefinition.supportedTriggers",
"type": "Function",
"tags": [],
"label": "supportedTriggers",
"description": [
"\nList of triggers supported by this drilldown type\nThis is used in trigger picker when configuring drilldown"
],
"signature": [
"() => string[]"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownTemplate",
"type": "Interface",
"tags": [],
"label": "DrilldownTemplate",
"description": [
"\nTemplate for a pre-configured new drilldown, this gives ability to create a\ndrilldown from a template instead of user creating a drilldown from scratch.\nThis is used in \"drilldown cloning\" functionality, where drilldowns can be\ncloned from one dashboard panel to another."
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownTemplate.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nA string that uniquely identifies this item in a list of `DrilldownTemplate[]`."
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownTemplate.icon",
"type": "string",
"tags": [],
"label": "icon",
"description": [
"\nEUI icon display next to the description."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownTemplate.description",
"type": "string",
"tags": [],
"label": "description",
"description": [
"\nA user facing text that provides information about the source of this template."
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownTemplate.factoryId",
"type": "string",
"tags": [],
"label": "factoryId",
"description": [
"\nDrilldown type, dynamic action factory ID."
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownTemplate.name",
"type": "string",
"tags": [],
"label": "name",
"description": [
"\nSuggested new name of the cloned drilldown. If a drilldown with such suggested\nname already exists at current place, a suffix like \" (copy 1)\" will be added."
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownTemplate.triggers",
"type": "Array",
"tags": [],
"label": "triggers",
"description": [
"\nPre-selected triggers."
],
"signature": [
"string[]"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DrilldownTemplate.config",
"type": "Unknown",
"tags": [],
"label": "config",
"description": [
"\nPreliminary configuration of the new drilldown, to be used in the dynamicaction factory."
],
"signature": [
"unknown"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/drilldown_manager/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManagerParams",
"type": "Interface",
"tags": [],
"label": "DynamicActionManagerParams",
"description": [],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManagerParams.storage",
"type": "Object",
"tags": [],
"label": "storage",
"description": [],
"signature": [
"ActionStorage"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManagerParams.uiActions",
"type": "Object",
"tags": [],
"label": "uiActions",
"description": [],
"signature": [
"{ readonly attachAction: (triggerId: string, actionId: string) => void; readonly detachAction: (triggerId: string, actionId: string) => void; readonly registerAction: <A extends ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.ActionDefinition",
"text": "ActionDefinition"
},
"<object>>(definition: A) => ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.Action",
"text": "Action"
},
"<",
"ActionContext",
"<A>>; readonly unregisterAction: (actionId: string) => void; readonly hasAction: (actionId: string) => boolean; readonly getActionFactory: (actionFactoryId: string) => ",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.ActionFactory",
"text": "ActionFactory"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
", object, ",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.BaseActionFactoryContext",
"text": "BaseActionFactoryContext"
},
">; readonly hasActionFactory: (actionFactoryId: string) => boolean; }"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManagerParams.isCompatible",
"type": "Function",
"tags": [],
"label": "isCompatible",
"description": [],
"signature": [
"<C = unknown>(context: C) => Promise<boolean>"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManagerParams.isCompatible.$1",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [],
"signature": [
"C"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.UrlDrilldownGlobalScope",
"type": "Interface",
"tags": [],
"label": "UrlDrilldownGlobalScope",
"description": [
"\nGlobal static variables like, for example, `kibanaUrl`\nSuch variables won’t change depending on a place where url drilldown is used."
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.UrlDrilldownGlobalScope.kibanaUrl",
"type": "string",
"tags": [],
"label": "kibanaUrl",
"description": [],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.UrlDrilldownScope",
"type": "Interface",
"tags": [],
"label": "UrlDrilldownScope",
"description": [
"\nURL drilldown has 3 sources for variables: global, context and event variables"
],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.UrlDrilldownScope",
"text": "UrlDrilldownScope"
},
"<ContextScope, EventScope> extends ",
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.UrlDrilldownGlobalScope",
"text": "UrlDrilldownGlobalScope"
}
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.UrlDrilldownScope.context",
"type": "Uncategorized",
"tags": [],
"label": "context",
"description": [
"\nDynamic variables that are differ depending on where drilldown is created and used,\nFor example: variables extracted from embeddable panel"
],
"signature": [
"ContextScope | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.UrlDrilldownScope.event",
"type": "Uncategorized",
"tags": [],
"label": "event",
"description": [
"\nVariables extracted from trigger context"
],
"signature": [
"EventScope | undefined"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.BaseActionConfig",
"type": "Type",
"tags": [],
"label": "BaseActionConfig",
"description": [],
"signature": [
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "src/plugins/ui_actions_enhanced/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionManagerState",
"type": "Type",
"tags": [],
"label": "DynamicActionManagerState",
"description": [],
"signature": [
"State"
],
"path": "src/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.DynamicActionsState",
"type": "Type",
"tags": [],
"label": "DynamicActionsState",
"description": [],
"signature": [
"{ events: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
"[]; }"
],
"path": "src/plugins/ui_actions_enhanced/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.SerializedAction",
"type": "Type",
"tags": [],
"label": "SerializedAction",
"description": [],
"signature": [
"{ readonly factoryId: string; readonly name: string; readonly config: Config; }"
],
"path": "src/plugins/ui_actions_enhanced/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.SerializedEvent",
"type": "Type",
"tags": [],
"label": "SerializedEvent",
"description": [
"\nSerialized representation of a triggers-action pair, used to persist in storage."
],
"signature": [
"{ eventId: string; triggers: string[]; action: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedAction",
"text": "SerializedAction"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">; }"
],
"path": "src/plugins/ui_actions_enhanced/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.UrlDrilldownConfig",
"type": "Type",
"tags": [],
"label": "UrlDrilldownConfig",
"description": [],
"signature": [
"{ url: { format?: \"handlebars_v1\" | undefined; template: string; }; openInNewTab: boolean; encodeUrl?: boolean | undefined; }"
],
"path": "src/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.SetupContract",
"type": "Interface",
"tags": [],
"label": "SetupContract",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.SetupContract",
"text": "SetupContract"
},
" extends ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsSetup",
"text": "UiActionsSetup"
},
",Pick<",
"UiActionsServiceEnhancements",
", \"registerDrilldown\">"
],
"path": "src/plugins/ui_actions_enhanced/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.StartContract",
"type": "Interface",
"tags": [],
"label": "StartContract",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "public",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-public.StartContract",
"text": "StartContract"
},
" extends ",
{
"pluginId": "uiActions",
"scope": "public",
"docId": "kibUiActionsPluginApi",
"section": "def-public.UiActionsStart",
"text": "UiActionsStart"
},
",Pick<",
"UiActionsServiceEnhancements",
", \"telemetry\" | \"inject\" | \"extract\" | \"getActionFactory\" | \"hasActionFactory\" | \"getActionFactories\">"
],
"path": "src/plugins/ui_actions_enhanced/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.StartContract.DrilldownManager",
"type": "Function",
"tags": [],
"label": "DrilldownManager",
"description": [],
"signature": [
"React.FunctionComponent<",
"PublicDrilldownManagerProps",
">"
],
"path": "src/plugins/ui_actions_enhanced/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.StartContract.DrilldownManager.$1",
"type": "CompoundType",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P & { children?: React.ReactNode; }"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-public.StartContract.DrilldownManager.$2",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.AdvancedUiActionsServerPlugin",
"type": "Class",
"tags": [],
"label": "AdvancedUiActionsServerPlugin",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "server",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-server.AdvancedUiActionsServerPlugin",
"text": "AdvancedUiActionsServerPlugin"
},
" implements ",
{
"pluginId": "@kbn/core-plugins-server",
"scope": "server",
"docId": "kibKbnCorePluginsServerPluginApi",
"section": "def-server.Plugin",
"text": "Plugin"
},
"<",
{
"pluginId": "uiActionsEnhanced",
"scope": "server",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-server.SetupContract",
"text": "SetupContract"
},
", void, SetupDependencies, object>"
],
"path": "src/plugins/ui_actions_enhanced/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.AdvancedUiActionsServerPlugin.actionFactories",
"type": "Object",
"tags": [],
"label": "actionFactories",
"description": [],
"signature": [
"Map<string, ",
{
"pluginId": "uiActionsEnhanced",
"scope": "server",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-server.ActionFactory",
"text": "ActionFactory"
},
"<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
">>"
],
"path": "src/plugins/ui_actions_enhanced/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.AdvancedUiActionsServerPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/ui_actions_enhanced/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.AdvancedUiActionsServerPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "@kbn/core-lifecycle-server",
"scope": "server",
"docId": "kibKbnCoreLifecycleServerPluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>, { embeddable }: SetupDependencies) => { registerActionFactory: (definition: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "server",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-server.ActionFactoryDefinition",
"text": "ActionFactoryDefinition"
},
"<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
">) => void; }"
],
"path": "src/plugins/ui_actions_enhanced/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.AdvancedUiActionsServerPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-lifecycle-server",
"scope": "server",
"docId": "kibKbnCoreLifecycleServerPluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>"
],
"path": "src/plugins/ui_actions_enhanced/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.AdvancedUiActionsServerPlugin.setup.$2",
"type": "Object",
"tags": [],
"label": "{ embeddable }",
"description": [],
"signature": [
"SetupDependencies"
],
"path": "src/plugins/ui_actions_enhanced/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.AdvancedUiActionsServerPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/ui_actions_enhanced/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.AdvancedUiActionsServerPlugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/ui_actions_enhanced/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.AdvancedUiActionsServerPlugin.registerActionFactory",
"type": "Function",
"tags": [],
"label": "registerActionFactory",
"description": [
"\nRegister an action factory. Action factories are used to configure and\nserialize/deserialize dynamic actions."
],
"signature": [
"(definition: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "server",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-server.ActionFactoryDefinition",
"text": "ActionFactoryDefinition"
},
"<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
">) => void"
],
"path": "src/plugins/ui_actions_enhanced/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.AdvancedUiActionsServerPlugin.registerActionFactory.$1",
"type": "Object",
"tags": [],
"label": "definition",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "server",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-server.ActionFactoryDefinition",
"text": "ActionFactoryDefinition"
},
"<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
">"
],
"path": "src/plugins/ui_actions_enhanced/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.ActionFactory",
"type": "Interface",
"tags": [],
"label": "ActionFactory",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "server",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-server.ActionFactory",
"text": "ActionFactory"
},
"<P> extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.PersistableState",
"text": "PersistableState"
},
"<P>"
],
"path": "src/plugins/ui_actions_enhanced/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.ActionFactory.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/plugins/ui_actions_enhanced/server/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.ActionFactoryDefinition",
"type": "Interface",
"tags": [],
"label": "ActionFactoryDefinition",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "server",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-server.ActionFactoryDefinition",
"text": "ActionFactoryDefinition"
},
"<P> extends Partial<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.PersistableState",
"text": "PersistableState"
},
"<P>>"
],
"path": "src/plugins/ui_actions_enhanced/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.ActionFactoryDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/plugins/ui_actions_enhanced/server/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.BaseActionConfig",
"type": "Type",
"tags": [],
"label": "BaseActionConfig",
"description": [],
"signature": [
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "src/plugins/ui_actions_enhanced/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.DynamicActionsState",
"type": "Type",
"tags": [],
"label": "DynamicActionsState",
"description": [],
"signature": [
"{ events: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
"[]; }"
],
"path": "src/plugins/ui_actions_enhanced/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.SerializedAction",
"type": "Type",
"tags": [],
"label": "SerializedAction",
"description": [],
"signature": [
"{ readonly factoryId: string; readonly name: string; readonly config: Config; }"
],
"path": "src/plugins/ui_actions_enhanced/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.SerializedEvent",
"type": "Type",
"tags": [],
"label": "SerializedEvent",
"description": [
"\nSerialized representation of a triggers-action pair, used to persist in storage."
],
"signature": [
"{ eventId: string; triggers: string[]; action: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedAction",
"text": "SerializedAction"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">; }"
],
"path": "src/plugins/ui_actions_enhanced/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.SetupContract",
"type": "Interface",
"tags": [],
"label": "SetupContract",
"description": [],
"path": "src/plugins/ui_actions_enhanced/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.SetupContract.registerActionFactory",
"type": "Function",
"tags": [],
"label": "registerActionFactory",
"description": [],
"signature": [
"(definition: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "server",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-server.ActionFactoryDefinition",
"text": "ActionFactoryDefinition"
},
"<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
">) => void"
],
"path": "src/plugins/ui_actions_enhanced/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.SetupContract.registerActionFactory.$1",
"type": "Object",
"tags": [],
"label": "definition",
"description": [],
"signature": [
{
"pluginId": "uiActionsEnhanced",
"scope": "server",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-server.ActionFactoryDefinition",
"text": "ActionFactoryDefinition"
},
"<",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
">"
],
"path": "src/plugins/ui_actions_enhanced/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "uiActionsEnhanced",
"id": "def-server.StartContract",
"type": "Type",
"tags": [],
"label": "StartContract",
"description": [],
"signature": [
"void"
],
"path": "src/plugins/ui_actions_enhanced/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-common.BaseActionConfig",
"type": "Type",
"tags": [],
"label": "BaseActionConfig",
"description": [],
"signature": [
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "src/plugins/ui_actions_enhanced/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-common.DynamicActionsState",
"type": "Type",
"tags": [],
"label": "DynamicActionsState",
"description": [],
"signature": [
"{ events: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedEvent",
"text": "SerializedEvent"
},
"[]; }"
],
"path": "src/plugins/ui_actions_enhanced/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-common.SerializedAction",
"type": "Type",
"tags": [],
"label": "SerializedAction",
"description": [],
"signature": [
"{ readonly factoryId: string; readonly name: string; readonly config: Config; }"
],
"path": "src/plugins/ui_actions_enhanced/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "uiActionsEnhanced",
"id": "def-common.SerializedEvent",
"type": "Type",
"tags": [],
"label": "SerializedEvent",
"description": [
"\nSerialized representation of a triggers-action pair, used to persist in storage."
],
"signature": [
"{ eventId: string; triggers: string[]; action: ",
{
"pluginId": "uiActionsEnhanced",
"scope": "common",
"docId": "kibUiActionsEnhancedPluginApi",
"section": "def-common.SerializedAction",
"text": "SerializedAction"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">; }"
],
"path": "src/plugins/ui_actions_enhanced/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink