2021-03-03 04:02:17 +01:00
{
"id" : "uiActionsEnhanced" ,
"client" : {
"classes" : [
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.AbstractActionStorage" ,
2021-03-03 04:02:17 +01:00
"type" : "Class" ,
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "AbstractActionStorage" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-public.AbstractActionStorage" ,
"text" : "AbstractActionStorage"
2021-03-03 04:02:17 +01:00
} ,
" implements " ,
2021-03-06 02:12:28 +01:00
"ActionStorage"
2021-03-03 04:02:17 +01:00
] ,
"children" : [
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.AbstractActionStorage.reload$" ,
"type" : "CompoundType" ,
"label" : "reload$" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
"lineNumber" : 34
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"Observable" ,
"<void> & Pick<" ,
"Subject" ,
"<void>, \"next\">"
2021-03-03 04:02:17 +01:00
]
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.AbstractActionStorage.count" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"label" : "count" ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<number>"
] ,
"description" : [ ] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
"lineNumber" : 36
}
} ,
{
"id" : "def-public.AbstractActionStorage.read" ,
"type" : "Function" ,
"label" : "read" ,
"signature" : [
"(eventId: string) => Promise<" ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
} ,
">"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.AbstractActionStorage.read.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "string" ,
"label" : "eventId" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
"string"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
"lineNumber" : 40
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
"lineNumber" : 40
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.AbstractActionStorage.create" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"label" : "create" ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"(event: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "uiActionsEnhanced" ,
2021-03-06 02:12:28 +01:00
"scope" : "common" ,
2021-03-03 04:02:17 +01:00
"docId" : "kibUiActionsEnhancedPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<void>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.AbstractActionStorage.create.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "event" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
2021-03-06 02:12:28 +01:00
"scope" : "common" ,
2021-03-03 04:02:17 +01:00
"docId" : "kibUiActionsEnhancedPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
}
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
"lineNumber" : 47
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
"lineNumber" : 47
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.AbstractActionStorage.update" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"label" : "update" ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"(event: " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "uiActionsEnhanced" ,
2021-03-06 02:12:28 +01:00
"scope" : "common" ,
2021-03-03 04:02:17 +01:00
"docId" : "kibUiActionsEnhancedPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
") => Promise<void>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.AbstractActionStorage.update.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "event" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
2021-03-06 02:12:28 +01:00
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
"lineNumber" : 48
2021-03-03 04:02:17 +01:00
}
2021-03-06 02:12:28 +01:00
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
"lineNumber" : 48
}
} ,
{
"id" : "def-public.AbstractActionStorage.remove" ,
"type" : "Function" ,
"label" : "remove" ,
"signature" : [
"(eventId: string) => Promise<void>"
] ,
"description" : [ ] ,
"children" : [
2021-03-03 04:02:17 +01:00
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.AbstractActionStorage.remove.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "string" ,
"label" : "eventId" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
"string"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
"lineNumber" : 49
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
"lineNumber" : 49
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.AbstractActionStorage.list" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"label" : "list" ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => Promise<" ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
} ,
"[]>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
"lineNumber" : 50
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
"lineNumber" : 33
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"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 Pick<" ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.Presentable" ,
"text" : "Presentable"
} ,
"<FactoryContext>, \"id\" | \"getDisplayName\" | \"order\" | \"MenuItem\" | \"getIconType\" | \"getDisplayNameTooltip\" | \"isCompatible\" | \"grouping\">," ,
{
"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"
}
] ,
"children" : [
{
"id" : "def-public.ActionFactory.Unnamed" ,
"type" : "Function" ,
"label" : "Constructor" ,
"signature" : [
"any"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionFactory.Unnamed.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "def" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-public.ActionFactoryDefinition" ,
"text" : "ActionFactoryDefinition"
} ,
"<Config, ExecutionContext, FactoryContext>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 37
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionFactory.Unnamed.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "deps" ,
"isRequired" : true ,
"signature" : [
2021-04-15 17:36:10 +02:00
"ActionFactoryDeps"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 38
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 36
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.ActionFactory.id" ,
"type" : "string" ,
"label" : "id" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 47
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.ActionFactory.isBeta" ,
"type" : "boolean" ,
"label" : "isBeta" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 48
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.ActionFactory.minimalLicense" ,
"type" : "CompoundType" ,
"label" : "minimalLicense" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 49
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ActionFactory.licenseFeatureName" ,
"type" : "string" ,
"label" : "licenseFeatureName" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 50
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ActionFactory.order" ,
"type" : "number" ,
"label" : "order" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 51
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.ActionFactory.MenuItem" ,
"type" : "Function" ,
"label" : "MenuItem" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 52
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.UiComponent" ,
"text" : "UiComponent"
} ,
"<{ context: FactoryContext; }> | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ActionFactory.ReactMenuItem" ,
"type" : "Function" ,
"label" : "ReactMenuItem" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 53
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"React.FC<{ context: FactoryContext; }> | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ActionFactory.CollectConfig" ,
"type" : "Function" ,
"label" : "CollectConfig" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 55
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.UiComponent" ,
"text" : "UiComponent"
} ,
"<" ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "public" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-public.CollectConfigProps" ,
"text" : "CollectConfigProps"
} ,
"<Config, FactoryContext>>"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ActionFactory.ReactCollectConfig" ,
"type" : "Function" ,
"label" : "ReactCollectConfig" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 56
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"React.FC<" ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "public" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-public.CollectConfigProps" ,
"text" : "CollectConfigProps"
} ,
"<Config, FactoryContext>>"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ActionFactory.createConfig" ,
"type" : "Function" ,
"label" : "createConfig" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 57
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"(context: FactoryContext) => Config"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ActionFactory.isConfigValid" ,
"type" : "Function" ,
"label" : "isConfigValid" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 58
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"(config: Config, context: FactoryContext) => boolean"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ActionFactory.migrations" ,
"type" : "Object" ,
"label" : "migrations" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 59
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.MigrateFunctionsObject" ,
"text" : "MigrateFunctionsObject"
}
]
} ,
{
"id" : "def-public.ActionFactory.getIconType" ,
"type" : "Function" ,
"label" : "getIconType" ,
"signature" : [
"(context: FactoryContext) => string | undefined"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionFactory.getIconType.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Uncategorized" ,
"label" : "context" ,
"isRequired" : true ,
"signature" : [
"FactoryContext"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 61
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 61
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.ActionFactory.getDisplayName" ,
"type" : "Function" ,
"label" : "getDisplayName" ,
"signature" : [
"(context: FactoryContext) => string"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionFactory.getDisplayName.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Uncategorized" ,
"label" : "context" ,
"isRequired" : true ,
"signature" : [
"FactoryContext"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 66
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 66
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.ActionFactory.getDisplayNameTooltip" ,
"type" : "Function" ,
"label" : "getDisplayNameTooltip" ,
"signature" : [
"(context: FactoryContext) => string"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionFactory.getDisplayNameTooltip.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Uncategorized" ,
"label" : "context" ,
"isRequired" : true ,
"signature" : [
"FactoryContext"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 71
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 71
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.ActionFactory.isCompatible" ,
"type" : "Function" ,
"label" : "isCompatible" ,
"signature" : [
"(context: FactoryContext) => Promise<boolean>"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionFactory.isCompatible.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Uncategorized" ,
"label" : "context" ,
"isRequired" : true ,
"signature" : [
"FactoryContext"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 75
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 75
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.ActionFactory.isCompatibleLicense" ,
"type" : "Function" ,
"label" : "isCompatibleLicense" ,
"signature" : [
"() => boolean"
] ,
"description" : [
"\nDoes this action factory license requirements\ncompatible with current license?"
] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 84
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.ActionFactory.create" ,
"type" : "Function" ,
"label" : "create" ,
"signature" : [
"(serializedAction: Pick<" ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedAction" ,
"text" : "SerializedAction"
} ,
"<Config>, \"name\" | \"config\">) => " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionDefinition" ,
"text" : "ActionDefinition"
} ,
"<ExecutionContext>"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionFactory.create.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "serializedAction" ,
"isRequired" : true ,
"signature" : [
"Pick<" ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedAction" ,
"text" : "SerializedAction"
} ,
"<Config>, \"name\" | \"config\">"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 91
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 90
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.ActionFactory.supportedTriggers" ,
"type" : "Function" ,
"label" : "supportedTriggers" ,
"signature" : [
"() => string[]"
] ,
"description" : [ ] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 108
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.ActionFactory.telemetry" ,
"type" : "Function" ,
"label" : "telemetry" ,
"signature" : [
"(state: " ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
} ,
", telemetryData: Record<string, any>) => Record<string, any>"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionFactory.telemetry.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "state" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 125
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionFactory.telemetry.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "telemetryData" ,
"isRequired" : true ,
"signature" : [
"Record<string, any>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 125
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 125
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.ActionFactory.extract" ,
"type" : "Function" ,
"label" : "extract" ,
"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: " ,
2021-04-15 17:36:10 +02:00
"SavedObjectReference" ,
2021-03-03 04:02:17 +01:00
"[]; }"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionFactory.extract.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "state" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 129
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 129
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.ActionFactory.inject" ,
"type" : "Function" ,
"label" : "inject" ,
"signature" : [
"(state: " ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
} ,
", references: " ,
2021-04-15 17:36:10 +02:00
"SavedObjectReference" ,
2021-03-03 04:02:17 +01:00
"[]) => " ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
}
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionFactory.inject.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "state" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 133
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionFactory.inject.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "Array" ,
"label" : "references" ,
"isRequired" : true ,
"signature" : [
2021-04-15 17:36:10 +02:00
"SavedObjectReference" ,
2021-03-03 04:02:17 +01:00
"[]"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 133
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 133
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 28
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.AdvancedUiActionsPublicPlugin" ,
2021-03-03 04:02:17 +01:00
"type" : "Class" ,
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "AdvancedUiActionsPublicPlugin" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-public.AdvancedUiActionsPublicPlugin" ,
"text" : "AdvancedUiActionsPublicPlugin"
2021-03-03 04:02:17 +01:00
} ,
" implements " ,
{
2021-03-06 02:12:28 +01:00
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.Plugin" ,
"text" : "Plugin"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
"<" ,
2021-03-03 04:02:17 +01:00
{
2021-03-06 02:12:28 +01:00
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-public.SetupContract" ,
"text" : "SetupContract"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
", " ,
2021-03-03 04:02:17 +01:00
{
2021-03-06 02:12:28 +01:00
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-public.StartContract" ,
"text" : "StartContract"
} ,
", SetupDependencies, " ,
"StartDependencies"
] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.AdvancedUiActionsPublicPlugin.licenseInfo" ,
"type" : "Object" ,
"label" : "licenseInfo" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/plugin.ts" ,
"lineNumber" : 65
} ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"BehaviorSubject" ,
"<" ,
2021-04-15 17:36:10 +02:00
"ILicense" ,
2021-03-06 02:12:28 +01:00
" | undefined>"
]
} ,
{
"id" : "def-public.AdvancedUiActionsPublicPlugin.Unnamed" ,
"type" : "Function" ,
"label" : "Constructor" ,
"signature" : [
"any"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.AdvancedUiActionsPublicPlugin.Unnamed.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
"label" : "initializerContext" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.PluginInitializerContext" ,
"text" : "PluginInitializerContext"
} ,
"<object>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/plugin.ts" ,
"lineNumber" : 77
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/plugin.ts" ,
"lineNumber" : 77
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.AdvancedUiActionsPublicPlugin.setup" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"label" : "setup" ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"(core: " ,
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.CoreSetup" ,
"text" : "CoreSetup"
} ,
"<" ,
2021-04-15 17:36:10 +02:00
"StartDependencies" ,
2021-03-06 02:12:28 +01:00
", unknown>, { embeddable, uiActions, licensing }: SetupDependencies) => " ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-public.SetupContract" ,
"text" : "SetupContract"
}
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.AdvancedUiActionsPublicPlugin.setup.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "core" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.CoreSetup" ,
"text" : "CoreSetup"
} ,
"<" ,
2021-04-15 17:36:10 +02:00
"StartDependencies" ,
2021-03-06 02:12:28 +01:00
", unknown>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/plugin.ts" ,
"lineNumber" : 80
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.AdvancedUiActionsPublicPlugin.setup.$2" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
"label" : "{ embeddable, uiActions, licensing }" ,
"isRequired" : true ,
"signature" : [
"SetupDependencies"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/plugin.ts" ,
"lineNumber" : 81
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/plugin.ts" ,
"lineNumber" : 79
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.AdvancedUiActionsPublicPlugin.start" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"label" : "start" ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"(core: " ,
{
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.CoreStart" ,
"text" : "CoreStart"
} ,
", { uiActions, licensing }: " ,
2021-04-15 17:36:10 +02:00
"StartDependencies" ,
2021-03-06 02:12:28 +01:00
") => " ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-public.StartContract" ,
"text" : "StartContract"
}
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.AdvancedUiActionsPublicPlugin.start.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "core" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
{
2021-03-06 02:12:28 +01:00
"pluginId" : "core" ,
"scope" : "public" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-public.CoreStart" ,
"text" : "CoreStart"
2021-03-03 04:02:17 +01:00
}
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/plugin.ts" ,
"lineNumber" : 96
2021-03-03 04:02:17 +01:00
}
2021-03-06 02:12:28 +01:00
} ,
2021-03-03 04:02:17 +01:00
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.AdvancedUiActionsPublicPlugin.start.$2" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
"label" : "{ uiActions, licensing }" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-04-15 17:36:10 +02:00
"StartDependencies"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/plugin.ts" ,
"lineNumber" : 96
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/plugin.ts" ,
"lineNumber" : 96
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.AdvancedUiActionsPublicPlugin.stop" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"label" : "stop" ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => void"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/plugin.ts" ,
"lineNumber" : 132
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/plugin.ts" ,
"lineNumber" : 63
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.DynamicActionManager" ,
"type" : "Class" ,
"tags" : [ ] ,
"label" : "DynamicActionManager" ,
"description" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.DynamicActionManager.idPrefixCounter" ,
"type" : "number" ,
"label" : "idPrefixCounter" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 48
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.DynamicActionManager.ui" ,
"type" : "Object" ,
"label" : "ui" ,
"description" : [
"\nUI State of the dynamic action manager."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 57
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.ReduxLikeStateContainer" ,
"text" : "ReduxLikeStateContainer"
} ,
"<" ,
2021-04-15 17:36:10 +02:00
"State" ,
2021-03-03 04:02:17 +01:00
", " ,
2021-04-15 17:36:10 +02:00
"Transitions" ,
2021-03-03 04:02:17 +01:00
", " ,
2021-04-15 17:36:10 +02:00
"Selectors" ,
2021-03-03 04:02:17 +01:00
">"
]
} ,
{
"id" : "def-public.DynamicActionManager.Unnamed" ,
"type" : "Function" ,
"label" : "Constructor" ,
"signature" : [
"any"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DynamicActionManager.Unnamed.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "params" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-public.DynamicActionManagerParams" ,
"text" : "DynamicActionManagerParams"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 59
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 59
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.DynamicActionManager.getEvent" ,
"type" : "Function" ,
"label" : "getEvent" ,
"signature" : [
"(eventId: string) => " ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
}
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DynamicActionManager.getEvent.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
"label" : "eventId" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 61
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 61
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.DynamicActionManager.generateActionId" ,
"type" : "Function" ,
"label" : "generateActionId" ,
"signature" : [
"(eventId: string) => string"
] ,
"description" : [
"\nWe prefix action IDs with a unique `.idPrefix`, so we can render the\nsame dashboard twice on the screen."
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DynamicActionManager.generateActionId.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
"label" : "eventId" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 71
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 71
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.DynamicActionManager.reviveAction" ,
"type" : "Function" ,
"label" : "reviveAction" ,
"signature" : [
"(event: " ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
} ,
") => void"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DynamicActionManager.reviveAction.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "event" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 75
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 75
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.DynamicActionManager.killAction" ,
"type" : "Function" ,
"label" : "killAction" ,
"signature" : [
"({ eventId, triggers }: " ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
} ,
") => void"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DynamicActionManager.killAction.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "{ eventId, triggers }" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 115
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 115
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.DynamicActionManager.state" ,
"type" : "Object" ,
"label" : "state" ,
"description" : [
"\nRead-only state container of dynamic action manager. Use it to perform all\n*read* operations."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 159
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.StateContainer" ,
"text" : "StateContainer"
} ,
"<" ,
2021-04-15 17:36:10 +02:00
"State" ,
2021-03-03 04:02:17 +01:00
", object, {}>"
]
} ,
{
"id" : "def-public.DynamicActionManager.start" ,
"type" : "Function" ,
"label" : "start" ,
"signature" : [
"() => Promise<void>"
] ,
"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."
] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 168
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.DynamicActionManager.stop" ,
"type" : "Function" ,
"label" : "stop" ,
"signature" : [
"() => Promise<void>"
] ,
"description" : [
"\n1. Removes all events from `ui_actions` registry.\n2. Puts dynamic action manager is stopped state."
] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 192
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.DynamicActionManager.createEvent" ,
"type" : "Function" ,
"label" : "createEvent" ,
"signature" : [
"(action: " ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedAction" ,
"text" : "SerializedAction"
} ,
"<" ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.SerializableState" ,
"text" : "SerializableState"
} ,
">, triggers: string[]) => Promise<void>"
] ,
"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"
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DynamicActionManager.createEvent.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "action" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedAction" ,
"text" : "SerializedAction"
} ,
"<" ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.SerializableState" ,
"text" : "SerializableState"
} ,
">"
] ,
"description" : [
"Dynamic action for which to create an event."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 215
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DynamicActionManager.createEvent.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "Array" ,
"label" : "triggers" ,
"isRequired" : true ,
"signature" : [
"string[]"
] ,
"description" : [
"List of triggers to which action should react."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 215
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 215
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.DynamicActionManager.updateEvent" ,
"type" : "Function" ,
"label" : "updateEvent" ,
"signature" : [
"(eventId: string, action: " ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedAction" ,
"text" : "SerializedAction"
} ,
"<" ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.SerializableState" ,
"text" : "SerializableState"
} ,
">, triggers: string[]) => Promise<void>"
] ,
"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"
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DynamicActionManager.updateEvent.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
"label" : "eventId" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [
"ID of the event to replace."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 246
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DynamicActionManager.updateEvent.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "action" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedAction" ,
"text" : "SerializedAction"
} ,
"<" ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.SerializableState" ,
"text" : "SerializableState"
} ,
">"
] ,
"description" : [
"New action for which to create the event."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 246
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DynamicActionManager.updateEvent.$3" ,
2021-03-03 04:02:17 +01:00
"type" : "Array" ,
"label" : "triggers" ,
"isRequired" : true ,
"signature" : [
"string[]"
] ,
"description" : [
"List of triggers to which action should react."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 246
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 246
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.DynamicActionManager.deleteEvent" ,
"type" : "Function" ,
"label" : "deleteEvent" ,
"signature" : [
"(eventId: string) => Promise<void>"
] ,
"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"
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DynamicActionManager.deleteEvent.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
"label" : "eventId" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [
"ID of the event to remove."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 277
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 277
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.DynamicActionManager.deleteEvents" ,
"type" : "Function" ,
"label" : "deleteEvents" ,
"signature" : [
"(eventIds: string[]) => Promise<void>"
] ,
"description" : [
"\nDeletes multiple events at once.\n"
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DynamicActionManager.deleteEvents.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Array" ,
"label" : "eventIds" ,
"isRequired" : true ,
"signature" : [
"string[]"
] ,
"description" : [
"List of event IDs."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 297
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 297
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 47
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"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"
}
] ,
"children" : [
{
"id" : "def-public.MemoryActionStorage.Unnamed" ,
"type" : "Function" ,
"label" : "Constructor" ,
"signature" : [
"any"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.MemoryActionStorage.Unnamed.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "events" ,
"isRequired" : true ,
"signature" : [
"readonly " ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
} ,
"[]"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 58
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 58
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.MemoryActionStorage.list" ,
"type" : "Function" ,
"label" : "list" ,
"signature" : [
"() => Promise<{ eventId: string; triggers: string[]; action: " ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedAction" ,
"text" : "SerializedAction"
} ,
"<" ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.SerializableState" ,
"text" : "SerializableState"
} ,
">; }[]>"
] ,
"description" : [ ] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 62
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.MemoryActionStorage.create" ,
"type" : "Function" ,
"label" : "create" ,
"signature" : [
"(event: " ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
} ,
") => Promise<void>"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.MemoryActionStorage.create.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "event" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 66
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 66
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.MemoryActionStorage.update" ,
"type" : "Function" ,
"label" : "update" ,
"signature" : [
"(event: " ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
} ,
") => Promise<void>"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.MemoryActionStorage.update.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "event" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedEvent" ,
"text" : "SerializedEvent"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 70
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 70
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.MemoryActionStorage.remove" ,
"type" : "Function" ,
"label" : "remove" ,
"signature" : [
"(eventId: string) => Promise<void>"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.MemoryActionStorage.remove.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
"label" : "eventId" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 76
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 76
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_storage.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 57
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"functions" : [
{
"id" : "def-public.ActionWizard" ,
"type" : "Function" ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionWizard.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
"label" : "{\n currentActionFactory,\n actionFactories,\n onActionFactoryChange,\n onConfigChange,\n config,\n context,\n onSelectedTriggersChange,\n getTriggerInfo,\n triggers,\n triggerPickerDocsLink,\n}" ,
"isRequired" : true ,
"signature" : [
"React.PropsWithChildren<" ,
2021-04-15 17:36:10 +02:00
"ActionWizardProps" ,
2021-03-03 04:02:17 +01:00
"<" ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-public.BaseActionFactoryContext" ,
"text" : "BaseActionFactoryContext"
} ,
">>"
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/components/action_wizard/action_wizard.tsx" ,
"lineNumber" : 89
}
}
] ,
"signature" : [
"({ currentActionFactory, actionFactories, onActionFactoryChange, onConfigChange, config, context, onSelectedTriggersChange, getTriggerInfo, triggers, triggerPickerDocsLink, }: React.PropsWithChildren<" ,
"ActionWizardProps" ,
"<" ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-public.BaseActionFactoryContext" ,
"text" : "BaseActionFactoryContext"
} ,
">>) => JSX.Element"
] ,
"description" : [ ] ,
"label" : "ActionWizard" ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/components/action_wizard/action_wizard.tsx" ,
"lineNumber" : 89
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.compile" ,
"type" : "Function" ,
"label" : "compile" ,
"signature" : [
"(urlTemplate: string, context: object, doEncode: boolean) => string"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.compile.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "string" ,
"label" : "urlTemplate" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_template.ts" ,
"lineNumber" : 130
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.compile.$2" ,
2021-03-06 02:12:28 +01:00
"type" : "Uncategorized" ,
"label" : "context" ,
"isRequired" : true ,
"signature" : [
"object"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_template.ts" ,
"lineNumber" : 130
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.compile.$3" ,
2021-03-06 02:12:28 +01:00
"type" : "boolean" ,
"label" : "doEncode" ,
"isRequired" : true ,
"signature" : [
"boolean"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_template.ts" ,
"lineNumber" : 130
2021-03-03 04:02:17 +01:00
}
}
] ,
2021-03-06 02:12:28 +01:00
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_template.ts" ,
"lineNumber" : 130
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.globalScopeProvider" ,
"type" : "Function" ,
"label" : "globalScopeProvider" ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"({\n core,\n}: UrlDrilldownGlobalScopeDeps) => () => " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-public.UrlDrilldownGlobalScope" ,
"text" : "UrlDrilldownGlobalScope"
}
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.globalScopeProvider.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
"label" : "{\n core,\n}" ,
"isRequired" : true ,
"signature" : [
"UrlDrilldownGlobalScopeDeps"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_drilldown_global_scope.ts" ,
"lineNumber" : 15
}
}
] ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"returnComment" : [ ] ,
2021-03-06 02:12:28 +01:00
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_drilldown_global_scope.ts" ,
"lineNumber" : 15
} ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
"id" : "def-public.UrlDrilldownCollectConfig" ,
"type" : "Function" ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.UrlDrilldownCollectConfig.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
"label" : "props" ,
"isRequired" : true ,
"signature" : [
"React.PropsWithChildren<" ,
2021-04-15 17:36:10 +02:00
"UrlDrilldownCollectConfigProps" ,
2021-03-03 04:02:17 +01:00
">"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/components/url_drilldown_collect_config/lazy.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 19
2021-03-03 04:02:17 +01:00
}
}
] ,
"signature" : [
"(props: React.PropsWithChildren<" ,
"UrlDrilldownCollectConfigProps" ,
">) => JSX.Element"
] ,
"description" : [ ] ,
"label" : "UrlDrilldownCollectConfig" ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/components/url_drilldown_collect_config/lazy.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 19
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.validateUrl" ,
"type" : "Function" ,
"label" : "validateUrl" ,
"signature" : [
"(url: string) => { isValid: boolean; error?: string | undefined; }"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.validateUrl.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
"label" : "url" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_validation.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 34
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_validation.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 34
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.validateUrlTemplate" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"label" : "validateUrlTemplate" ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"(urlTemplate: { format?: \"handlebars_v1\" | undefined; template: string; }, scope: " ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-public.UrlDrilldownScope" ,
"text" : "UrlDrilldownScope"
} ,
"<object, object>) => { isValid: boolean; error?: string | undefined; }"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.validateUrlTemplate.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
2021-03-03 04:02:17 +01:00
"label" : "urlTemplate" ,
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ format?: \"handlebars_v1\" | undefined; template: string; }"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_validation.ts" ,
"lineNumber" : 54
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.validateUrlTemplate.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "scope" ,
2021-03-03 04:02:17 +01:00
"isRequired" : true ,
"signature" : [
2021-03-06 02:12:28 +01:00
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-public.UrlDrilldownScope" ,
"text" : "UrlDrilldownScope"
} ,
"<object, object>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_validation.ts" ,
"lineNumber" : 55
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/url_validation.ts" ,
"lineNumber" : 53
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"interfaces" : [
{
"id" : "def-public.ActionFactoryDefinition" ,
"type" : "Interface" ,
"label" : "ActionFactoryDefinition" ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-public.ActionFactoryDefinition" ,
"text" : "ActionFactoryDefinition"
} ,
"<Config, ExecutionContext, FactoryContext> extends Partial<Pick<" ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.Presentable" ,
"text" : "Presentable"
} ,
"<FactoryContext>, \"id\" | \"getDisplayName\" | \"order\" | \"MenuItem\" | \"getIconType\" | \"getDisplayNameTooltip\" | \"isCompatible\" | \"grouping\">>," ,
{
"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"
}
] ,
"description" : [
"\nThis is a convenience interface for registering new action factories."
] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.ActionFactoryDefinition.id" ,
"type" : "string" ,
"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."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 37
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.ActionFactoryDefinition.minimalLicense" ,
"type" : "CompoundType" ,
"label" : "minimalLicense" ,
"description" : [
"\nMinimal license level\nEmpty means no license restrictions"
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 43
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ActionFactoryDefinition.licenseFeatureName" ,
"type" : "string" ,
"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."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 50
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ActionFactoryDefinition.isBeta" ,
"type" : "CompoundType" ,
"label" : "isBeta" ,
"description" : [
"\nIs this action factory not GA?\nAdds a beta badge on a list item representing this ActionFactory"
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 56
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"boolean | undefined"
]
} ,
{
"id" : "def-public.ActionFactoryDefinition.create" ,
"type" : "Function" ,
"label" : "create" ,
"signature" : [
"(serializedAction: Pick<" ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedAction" ,
"text" : "SerializedAction"
} ,
"<Config>, \"name\" | \"config\">) => " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionDefinition" ,
"text" : "ActionDefinition"
} ,
"<ExecutionContext>"
] ,
"description" : [
"\nThis method should return a definition of a new action, normally used to\nregister it in `ui_actions` registry."
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.ActionFactoryDefinition.create.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "serializedAction" ,
"isRequired" : true ,
"signature" : [
"Pick<" ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "common" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-common.SerializedAction" ,
"text" : "SerializedAction"
} ,
2021-03-06 02:12:28 +01:00
"<Config>, \"name\" | \"config\">"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts" ,
"lineNumber" : 63
}
2021-03-03 04:02:17 +01:00
}
2021-03-06 02:12:28 +01:00
] ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"returnComment" : [ ] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts" ,
"lineNumber" : 62
}
2021-03-03 04:02:17 +01:00
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.ActionFactoryDefinition.supportedTriggers" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"label" : "supportedTriggers" ,
"signature" : [
"() => string[]"
] ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts" ,
"lineNumber" : 66
}
2021-03-03 04:02:17 +01:00
}
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/action_factory_definition.ts" ,
"lineNumber" : 25
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.BaseActionFactoryContext" ,
"type" : "Interface" ,
"label" : "BaseActionFactoryContext" ,
"description" : [
"\nAction factory context passed into ActionFactories' CollectConfig, getDisplayName, getIconType"
] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.BaseActionFactoryContext.triggers" ,
"type" : "Array" ,
"label" : "triggers" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 16
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string[]"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.DrilldownDefinition" ,
"type" : "Interface" ,
"label" : "DrilldownDefinition" ,
"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"
} ,
">>"
] ,
"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."
] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.DrilldownDefinition.id" ,
"type" : "string" ,
"label" : "id" ,
"description" : [
"\nGlobally unique identifier for this drilldown."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 40
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.DrilldownDefinition.isBeta" ,
"type" : "CompoundType" ,
"label" : "isBeta" ,
"description" : [
"\nIs this action factory not GA?\nAdds a beta badge on a list item representing this ActionFactory"
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 46
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"boolean | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.DrilldownDefinition.minimalLicense" ,
"type" : "CompoundType" ,
"label" : "minimalLicense" ,
"description" : [
"\nMinimal license level\nEmpty means no restrictions"
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 52
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.DrilldownDefinition.licenseFeatureName" ,
"type" : "string" ,
"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."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 59
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.DrilldownDefinition.order" ,
"type" : "number" ,
"label" : "order" ,
"description" : [
"\nDetermines the display order of the drilldowns in the flyout picker.\nHigher numbers are displayed first."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 65
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"number | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.DrilldownDefinition.createConfig" ,
"type" : "Function" ,
"label" : "createConfig" ,
"description" : [
"\nFunction that returns default config for this drilldown."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 70
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"(context: FactoryContext) => Config"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.DrilldownDefinition.CollectConfig" ,
"type" : "Function" ,
"label" : "CollectConfig" ,
"description" : [
"\n`UiComponent` that collections 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```"
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 91
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.UiComponent" ,
"text" : "UiComponent"
} ,
"<" ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "public" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-public.CollectConfigProps" ,
"text" : "CollectConfigProps"
} ,
"<Config, FactoryContext>>"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.DrilldownDefinition.isConfigValid" ,
"type" : "Function" ,
"label" : "isConfigValid" ,
"description" : [
"\nA validator function for the config object. Should always return a boolean\ngiven any input."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 97
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"(config: Config, context: FactoryContext) => boolean"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.DrilldownDefinition.euiIcon" ,
"type" : "string" ,
"label" : "euiIcon" ,
"description" : [
"\nName of EUI icon to display when showing this drilldown to user."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 102
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.DrilldownDefinition.getDisplayName" ,
"type" : "Function" ,
"label" : "getDisplayName" ,
"description" : [
"\nShould return an internationalized name of the drilldown, which will be\ndisplayed to the user."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 108
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"() => string"
]
} ,
{
"id" : "def-public.DrilldownDefinition.isCompatible" ,
"type" : "Function" ,
"label" : "isCompatible" ,
"signature" : [
"((config: Config, context: ExecutionContext | " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<ExecutionContext>) => Promise<boolean>) | undefined"
] ,
"description" : [
"\nisCompatible during execution\nCould be used to prevent drilldown from execution"
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DrilldownDefinition.isCompatible.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Uncategorized" ,
"label" : "config" ,
"isRequired" : true ,
"signature" : [
"Config"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 115
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DrilldownDefinition.isCompatible.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
"label" : "context" ,
"isRequired" : true ,
"signature" : [
"ExecutionContext | " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<ExecutionContext>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 116
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 114
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.DrilldownDefinition.execute" ,
"type" : "Function" ,
"label" : "execute" ,
"signature" : [
"(config: Config, context: ExecutionContext | " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<ExecutionContext>) => void"
] ,
"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"
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DrilldownDefinition.execute.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Uncategorized" ,
"label" : "config" ,
"isRequired" : true ,
"signature" : [
"Config"
] ,
"description" : [
"Config object that user configured this drilldown with."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 129
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DrilldownDefinition.execute.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
"label" : "context" ,
"isRequired" : true ,
"signature" : [
"ExecutionContext | " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<ExecutionContext>"
] ,
"description" : [
"Object that represents context in which the underlying\n`UIAction` of this drilldown is being executed in."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 130
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 128
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.DrilldownDefinition.getHref" ,
"type" : "Function" ,
"label" : "getHref" ,
"signature" : [
"((config: Config, context: ExecutionContext | " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<ExecutionContext>) => Promise<string | undefined>) | undefined"
] ,
"description" : [
"\nA link where drilldown should navigate on middle click or Ctrl + click."
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DrilldownDefinition.getHref.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Uncategorized" ,
"label" : "config" ,
"isRequired" : true ,
"signature" : [
"Config"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 137
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.DrilldownDefinition.getHref.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "CompoundType" ,
"label" : "context" ,
"isRequired" : true ,
"signature" : [
"ExecutionContext | " ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.ActionExecutionContext" ,
"text" : "ActionExecutionContext"
} ,
"<ExecutionContext>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 138
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 136
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.DrilldownDefinition.supportedTriggers" ,
"type" : "Function" ,
"label" : "supportedTriggers" ,
"signature" : [
"() => string[]"
] ,
"description" : [
"\nList of triggers supported by this drilldown type\nThis is used in trigger picker when configuring drilldown"
] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 145
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 32
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.DynamicActionManagerParams" ,
"type" : "Interface" ,
"label" : "DynamicActionManagerParams" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.DynamicActionManagerParams.storage" ,
"type" : "Object" ,
"label" : "storage" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
"lineNumber" : 33
} ,
"signature" : [
2021-04-15 17:36:10 +02:00
"ActionStorage"
2021-03-06 02:12:28 +01:00
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.DynamicActionManagerParams.uiActions" ,
"type" : "Object" ,
"label" : "uiActions" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
"lineNumber" : 34
} ,
"signature" : [
"Pick<" ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-public.StartContract" ,
"text" : "StartContract"
} ,
", \"attachAction\" | \"detachAction\" | \"registerAction\" | \"unregisterAction\" | \"hasAction\" | \"getActionFactory\" | \"hasActionFactory\">"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.DynamicActionManagerParams.isCompatible" ,
"type" : "Function" ,
"label" : "isCompatible" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
"lineNumber" : 44
} ,
"signature" : [
"<C = unknown>(context: C) => Promise<boolean>"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
"lineNumber" : 32
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.UrlDrilldownGlobalScope" ,
"type" : "Interface" ,
"label" : "UrlDrilldownGlobalScope" ,
"description" : [
"\nGlobal static variables like, for example, `kibanaUrl`\nSuch variables won’ t change depending on a place where url drilldown is used."
] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.UrlDrilldownGlobalScope.kibanaUrl" ,
"type" : "string" ,
"label" : "kibanaUrl" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 38
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 37
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.UrlDrilldownScope" ,
"type" : "Interface" ,
"label" : "UrlDrilldownScope" ,
"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"
}
] ,
"description" : [
"\nURL drilldown has 3 sources for variables: global, context and event variables"
] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.UrlDrilldownScope.context" ,
"type" : "Uncategorized" ,
"label" : "context" ,
"description" : [
"\nDynamic variables that are differ depending on where drilldown is created and used,\nFor example: variables extracted from embeddable panel"
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 25
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"ContextScope | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.UrlDrilldownScope.event" ,
"type" : "Uncategorized" ,
"label" : "event" ,
"description" : [
"\nVariables extracted from trigger context"
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"EventScope | undefined"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 17
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.BaseActionConfig" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "BaseActionConfig" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 10
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ [key: string]: " ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.Serializable" ,
"text" : "Serializable"
} ,
"; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.DynamicActionManagerState" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "DynamicActionManagerState" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts" ,
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"State"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.DynamicActionsState" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "DynamicActionsState" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/ui_actions_enhanced/common/types.ts" ,
"lineNumber" : 27
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ events: SerializedEvent[]; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.SerializedAction" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "SerializedAction" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 12
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ readonly factoryId: string; readonly name: string; readonly config: Config; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.SerializedEvent" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "SerializedEvent" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nSerialized representation of a triggers-action pair, used to persist in storage."
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 21
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ eventId: string; triggers: string[]; action: SerializedAction; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.UrlDrilldownConfig" ,
"type" : "Type" ,
"label" : "UrlDrilldownConfig" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/drilldowns/url_drilldown/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 8
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"{ url: { format?: 'handlebars_v1'; template: string;}; openInNewTab: boolean; encodeUrl?: boolean | undefined; }"
] ,
"initialIsOpen" : false
}
] ,
"objects" : [ ] ,
"setup" : {
"id" : "def-public.SetupContract" ,
"type" : "Interface" ,
"label" : "SetupContract" ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-public.SetupContract" ,
"text" : "SetupContract"
} ,
" extends Pick<" ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.UiActionsService" ,
"text" : "UiActionsService"
} ,
", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">,Pick<" ,
"UiActionsServiceEnhancements" ,
", \"registerDrilldown\">"
] ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 45
2021-03-03 04:02:17 +01:00
} ,
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
"id" : "def-public.StartContract" ,
"type" : "Interface" ,
"label" : "StartContract" ,
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-public.StartContract" ,
"text" : "StartContract"
} ,
" extends Pick<" ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.UiActionsService" ,
"text" : "UiActionsService"
} ,
", " ,
"MethodKeysOf" ,
"<" ,
{
"pluginId" : "uiActions" ,
"scope" : "public" ,
"docId" : "kibUiActionsPluginApi" ,
"section" : "def-public.UiActionsService" ,
"text" : "UiActionsService"
} ,
">>,Pick<" ,
"UiActionsServiceEnhancements"
] ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.StartContract.FlyoutManageDrilldowns" ,
"type" : "Function" ,
"label" : "FlyoutManageDrilldowns" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 60
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"React.FC<ConnectedFlyoutManageDrilldownsProps<" ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "public" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-public.BaseActionFactoryContext" ,
"text" : "BaseActionFactoryContext"
} ,
">>"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/public/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 49
2021-03-03 04:02:17 +01:00
} ,
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"server" : {
"classes" : [
{
"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" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.Plugin" ,
"text" : "Plugin"
} ,
"<" ,
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "server" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
"section" : "def-server.SetupContract" ,
"text" : "SetupContract"
} ,
", void, SetupDependencies, object>"
] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-server.AdvancedUiActionsServerPlugin.actionFactories" ,
"type" : "Object" ,
"label" : "actionFactories" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 26
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-04-15 17:36:10 +02:00
"ActionFactoryRegistry"
2021-03-03 04:02:17 +01:00
]
} ,
{
"id" : "def-server.AdvancedUiActionsServerPlugin.Unnamed" ,
"type" : "Function" ,
"label" : "Constructor" ,
"signature" : [
"any"
] ,
"description" : [ ] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 28
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-server.AdvancedUiActionsServerPlugin.setup" ,
"type" : "Function" ,
"label" : "setup" ,
"signature" : [
"(core: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"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; }"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-server.AdvancedUiActionsServerPlugin.setup.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "core" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCorePluginApi" ,
"section" : "def-server.CoreSetup" ,
"text" : "CoreSetup"
} ,
"<object, unknown>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-server.AdvancedUiActionsServerPlugin.setup.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "{ embeddable }" ,
"isRequired" : true ,
"signature" : [
"SetupDependencies"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-server.AdvancedUiActionsServerPlugin.start" ,
"type" : "Function" ,
"label" : "start" ,
"signature" : [
"() => void"
] ,
"description" : [ ] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 40
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-server.AdvancedUiActionsServerPlugin.stop" ,
"type" : "Function" ,
"label" : "stop" ,
"signature" : [
"() => void"
] ,
"description" : [ ] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 42
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-server.AdvancedUiActionsServerPlugin.registerActionFactory" ,
"type" : "Function" ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-server.AdvancedUiActionsServerPlugin.registerActionFactory.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "definition" ,
"isRequired" : true ,
"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"
} ,
">"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 48
2021-03-03 04:02:17 +01:00
}
}
] ,
"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"
] ,
"description" : [
"\nRegister an action factory. Action factories are used to configure and\nserialize/deserialize dynamic actions."
] ,
"label" : "registerActionFactory" ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 48
2021-03-03 04:02:17 +01:00
} ,
"tags" : [ ] ,
"returnComment" : [ ]
}
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 24
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"functions" : [ ] ,
"interfaces" : [
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ActionFactory" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-03-06 02:12:28 +01:00
"label" : "ActionFactory" ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "server" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.ActionFactory" ,
"text" : "ActionFactory"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
"<P> extends " ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.PersistableState" ,
"text" : "PersistableState"
} ,
2021-03-06 02:12:28 +01:00
"<P>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ActionFactory.id" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
"label" : "id" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 24
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 22
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ActionFactoryDefinition" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-03-06 02:12:28 +01:00
"label" : "ActionFactoryDefinition" ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "uiActionsEnhanced" ,
"scope" : "server" ,
"docId" : "kibUiActionsEnhancedPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-server.ActionFactoryDefinition" ,
"text" : "ActionFactoryDefinition"
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
"<P> extends Partial<" ,
2021-03-03 04:02:17 +01:00
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.PersistableState" ,
"text" : "PersistableState"
} ,
2021-03-06 02:12:28 +01:00
"<P>>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.ActionFactoryDefinition.id" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
"label" : "id" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 19
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 17
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [
{
"id" : "def-server.BaseActionConfig" ,
"type" : "Type" ,
"label" : "BaseActionConfig" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 10
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"{ [key: string]: " ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.Serializable" ,
"text" : "Serializable"
} ,
"; }"
] ,
"initialIsOpen" : false
} ,
2021-03-06 02:12:28 +01:00
{
"id" : "def-server.DynamicActionsState" ,
"type" : "Type" ,
"label" : "DynamicActionsState" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/common/types.ts" ,
"lineNumber" : 27
} ,
"signature" : [
"{ events: SerializedEvent[]; }"
] ,
"initialIsOpen" : false
} ,
2021-03-03 04:02:17 +01:00
{
"id" : "def-server.SerializedAction" ,
"type" : "Type" ,
"label" : "SerializedAction" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 12
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"{ readonly factoryId: string; readonly name: string; readonly config: Config; }"
] ,
"initialIsOpen" : false
} ,
{
"id" : "def-server.SerializedEvent" ,
"type" : "Type" ,
"label" : "SerializedEvent" ,
"tags" : [ ] ,
"description" : [
"\nSerialized representation of a triggers-action pair, used to persist in storage."
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 21
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"{ eventId: string; triggers: string[]; action: SerializedAction; }"
] ,
"initialIsOpen" : false
}
] ,
"objects" : [ ] ,
"setup" : {
"id" : "def-server.SetupContract" ,
"type" : "Interface" ,
"label" : "SetupContract" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-server.SetupContract.registerActionFactory" ,
"type" : "Function" ,
"label" : "registerActionFactory" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
} ,
"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"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 14
2021-03-03 04:02:17 +01:00
} ,
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
"id" : "def-server.StartContract" ,
"type" : "Type" ,
"label" : "StartContract" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 18
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"void"
] ,
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"common" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [
{
"id" : "def-common.BaseActionConfig" ,
"type" : "Type" ,
"label" : "BaseActionConfig" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 10
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"{ [key: string]: " ,
{
"pluginId" : "kibanaUtils" ,
"scope" : "common" ,
"docId" : "kibKibanaUtilsPluginApi" ,
"section" : "def-common.Serializable" ,
"text" : "Serializable"
} ,
"; }"
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.DynamicActionsState" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "DynamicActionsState" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 27
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ events: SerializedEvent[]; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.SerializedAction" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "SerializedAction" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 12
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ readonly factoryId: string; readonly name: string; readonly config: Config; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.SerializedEvent" ,
2021-03-03 04:02:17 +01:00
"type" : "Type" ,
2021-03-06 02:12:28 +01:00
"label" : "SerializedEvent" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"description" : [
"\nSerialized representation of a triggers-action pair, used to persist in storage."
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/ui_actions_enhanced/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 21
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ eventId: string; triggers: string[]; action: SerializedAction; }"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
}
] ,
"objects" : [ ]
}
}