2021-03-03 04:02:17 +01:00
{
"id" : "savedObjectsTaggingOss" ,
"client" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.GetSearchBarFilterOptions" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-03-06 02:12:28 +01:00
"label" : "GetSearchBarFilterOptions" ,
"description" : [
"\nOptions for the {@link SavedObjectsTaggingApiUi.getSearchBarFilter | getSearchBarFilter api}\n"
] ,
2021-03-03 04:02:17 +01:00
"tags" : [
"public"
] ,
"children" : [
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.GetSearchBarFilterOptions.useName" ,
"type" : "CompoundType" ,
"label" : "useName" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nIf set to true, will use the tag's `name` instead of `id` for the tag field clause, which is recommended\nfor a better end-user experience.\n\nDefaults to true.\n"
2021-03-03 04:02:17 +01:00
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 276
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"boolean | undefined"
2021-03-03 04:02:17 +01:00
]
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.GetSearchBarFilterOptions.tagField" ,
"type" : "string" ,
"label" : "tagField" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe tag clause field name to generate the query. Defaults to `tag`.\n"
2021-03-03 04:02:17 +01:00
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 282
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"string | undefined"
2021-03-03 04:02:17 +01:00
]
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 259
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.ITagsCache" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-03-06 02:12:28 +01:00
"label" : "ITagsCache" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"tags" : [
"public"
] ,
"children" : [
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.ITagsCache.getState" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"label" : "getState" ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => " ,
2021-03-03 04:02:17 +01:00
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
2021-03-03 04:02:17 +01:00
"scope" : "common" ,
2021-04-15 17:36:10 +02:00
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
2021-03-03 04:02:17 +01:00
"section" : "def-common.Tag" ,
"text" : "Tag"
} ,
2021-03-06 02:12:28 +01:00
"[]"
2021-03-03 04:02:17 +01:00
] ,
"description" : [
2021-03-06 02:12:28 +01:00
"\nReturn the current state of the cache"
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 44
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.ITagsCache.getState$" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"label" : "getState$" ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"() => " ,
"Observable" ,
"<" ,
2021-03-03 04:02:17 +01:00
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
2021-03-03 04:02:17 +01:00
"scope" : "common" ,
2021-04-15 17:36:10 +02:00
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-common.Tag" ,
"text" : "Tag"
} ,
"[]>"
2021-03-03 04:02:17 +01:00
] ,
"description" : [
2021-03-06 02:12:28 +01:00
"\nReturn an observable that will emit everytime the cache's state mutates."
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"children" : [ ] ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 49
2021-03-03 04:02:17 +01:00
}
2021-03-06 02:12:28 +01:00
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 40
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.ParsedSearchQuery" ,
"type" : "Interface" ,
"label" : "ParsedSearchQuery" ,
"description" : [ ] ,
"tags" : [
"public"
] ,
"children" : [
2021-03-03 04:02:17 +01:00
{
2021-03-06 02:12:28 +01:00
"tags" : [ ] ,
"id" : "def-public.ParsedSearchQuery.searchTerm" ,
"type" : "string" ,
"label" : "searchTerm" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 289
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-03-06 02:12:28 +01:00
"tags" : [ ] ,
"id" : "def-public.ParsedSearchQuery.tagReferences" ,
"type" : "Array" ,
"label" : "tagReferences" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 290
} ,
2021-03-03 04:02:17 +01:00
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsFindOptionsReference" ,
"text" : "SavedObjectsFindOptionsReference"
} ,
2021-03-06 02:12:28 +01:00
"[]"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ParsedSearchQuery.valid" ,
"type" : "boolean" ,
"label" : "valid" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 291
}
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 288
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.ParseSearchQueryOptions" ,
"type" : "Interface" ,
"label" : "ParseSearchQueryOptions" ,
"description" : [
"\nOptions for the {@link SavedObjectsTaggingApiUi.parseSearchQuery | parseSearchQuery api}\n"
] ,
"tags" : [
"public"
] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.ParseSearchQueryOptions.useName" ,
"type" : "CompoundType" ,
"label" : "useName" ,
"description" : [
"\nIf set to true, will assume the tag clause is using tag names instead of ids.\nIn that case, will perform a reverse lookup from the client-side tag cache to resolve tag ids from names.\n\nDefaults to true.\n"
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 309
} ,
"signature" : [
"boolean | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.ParseSearchQueryOptions.tagField" ,
"type" : "string" ,
"label" : "tagField" ,
"description" : [
"\nThe tag clause field name to extract the tags from. Defaults to `tag`.\n"
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 315
} ,
"signature" : [
"string | undefined"
]
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 299
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.SavedObjectSaveModalTagSelectorComponentProps" ,
"type" : "Interface" ,
"label" : "SavedObjectSaveModalTagSelectorComponentProps" ,
"description" : [
"\nProps type for the {@link SavedObjectsTaggingApiUiComponent.SavedObjectSaveModalTagSelector | SavedObjectSaveModalTagSelector component}\n"
] ,
"tags" : [
"public"
] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.SavedObjectSaveModalTagSelectorComponentProps.initialSelection" ,
"type" : "Array" ,
"label" : "initialSelection" ,
"description" : [
"\nIds of the initially selected tags.\nChanging the value of this prop after initial mount will not rerender the component (see component description for more details)"
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 247
} ,
"signature" : [
"string[]"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.SavedObjectSaveModalTagSelectorComponentProps.onTagsSelected" ,
"type" : "Function" ,
"label" : "onTagsSelected" ,
"description" : [
"\ntags selection callback"
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 251
} ,
"signature" : [
"(ids: string[]) => void"
]
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 242
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.SavedObjectsTaggingApi" ,
"type" : "Interface" ,
"label" : "SavedObjectsTaggingApi" ,
"description" : [ ] ,
"tags" : [
"public"
] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.SavedObjectsTaggingApi.client" ,
"type" : "Object" ,
"label" : "client" ,
"description" : [
"\nThe client to perform tag-related operations on the server-side"
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 25
} ,
"signature" : [
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
2021-03-06 02:12:28 +01:00
"scope" : "common" ,
2021-04-15 17:36:10 +02:00
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-common.ITagsClient" ,
"text" : "ITagsClient"
}
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.SavedObjectsTaggingApi.cache" ,
"type" : "Object" ,
"label" : "cache" ,
"description" : [
"\nA client-side auto-refreshing cache of the existing tags. Can be used\nto synchronously access the list of tags."
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 30
} ,
"signature" : [
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
"section" : "def-public.ITagsCache" ,
2021-03-06 02:12:28 +01:00
"text" : "ITagsCache"
}
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.SavedObjectsTaggingApi.ui" ,
"type" : "Object" ,
"label" : "ui" ,
"description" : [
"\nUI API to use to add tagging capabilities to an application"
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 34
} ,
"signature" : [
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
"section" : "def-public.SavedObjectsTaggingApiUi" ,
2021-03-06 02:12:28 +01:00
"text" : "SavedObjectsTaggingApiUi"
}
]
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 21
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.SavedObjectsTaggingApiUi" ,
"type" : "Interface" ,
"label" : "SavedObjectsTaggingApiUi" ,
"description" : [
"\nReact components and utility methods to use the SO tagging feature\n"
] ,
"tags" : [
"public"
] ,
"children" : [
{
"id" : "def-public.SavedObjectsTaggingApiUi.getTag" ,
"type" : "Function" ,
"label" : "getTag" ,
"signature" : [
"(tagId: string) => " ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
2021-03-06 02:12:28 +01:00
"scope" : "common" ,
2021-04-15 17:36:10 +02:00
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
2021-03-06 02:12:28 +01:00
"section" : "def-common.Tag" ,
"text" : "Tag"
} ,
" | undefined"
] ,
"description" : [
"\nReturn a Tag from an ID\n"
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.SavedObjectsTaggingApiUi.getTag.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "string" ,
"label" : "tagId" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 68
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 68
}
} ,
{
"id" : "def-public.SavedObjectsTaggingApiUi.hasTagDecoration" ,
"type" : "Function" ,
"label" : "hasTagDecoration" ,
"signature" : [
"(object: " ,
{
"pluginId" : "savedObjects" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsPluginApi" ,
"section" : "def-public.SavedObject" ,
"text" : "SavedObject"
} ,
") => object is " ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
"section" : "def-public.TagDecoratedSavedObject" ,
2021-03-06 02:12:28 +01:00
"text" : "TagDecoratedSavedObject"
}
] ,
"description" : [
"\nType-guard to safely manipulate tag-enhanced `SavedObject` from the `savedObject` plugin.\n"
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.SavedObjectsTaggingApiUi.hasTagDecoration.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
"label" : "object" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "savedObjects" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsPluginApi" ,
"section" : "def-public.SavedObject" ,
"text" : "SavedObject"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 75
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 75
}
} ,
{
"id" : "def-public.SavedObjectsTaggingApiUi.getSearchBarFilter" ,
"type" : "Function" ,
"label" : "getSearchBarFilter" ,
"signature" : [
"(options?: " ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
"section" : "def-public.GetSearchBarFilterOptions" ,
2021-03-06 02:12:28 +01:00
"text" : "GetSearchBarFilterOptions"
} ,
" | undefined) => " ,
"SearchFilterConfig"
] ,
"description" : [
"\nReturn a filter that can be used to filter by tag with `EuiSearchBar` or EUI tables using `EuiSearchBar`.\n"
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.SavedObjectsTaggingApiUi.getSearchBarFilter.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Object" ,
"label" : "options" ,
"isRequired" : false ,
"signature" : [
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
"section" : "def-public.GetSearchBarFilterOptions" ,
2021-03-06 02:12:28 +01:00
"text" : "GetSearchBarFilterOptions"
} ,
" | undefined"
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 89
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 89
}
} ,
{
"id" : "def-public.SavedObjectsTaggingApiUi.getTableColumnDefinition" ,
"type" : "Function" ,
"label" : "getTableColumnDefinition" ,
"signature" : [
"() => " ,
"EuiTableFieldDataColumnType" ,
"<" ,
2021-04-15 17:36:10 +02:00
"SavedObject" ,
2021-03-06 02:12:28 +01:00
"<unknown>>"
] ,
"description" : [
"\nReturn the column definition to be used to display the tags in a EUI table.\nThe table's items must be of the `SavedObject` type (or at least have their references available\nvia the `references` field)\n"
] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 105
}
} ,
{
"id" : "def-public.SavedObjectsTaggingApiUi.convertNameToReference" ,
"type" : "Function" ,
"label" : "convertNameToReference" ,
"signature" : [
"(tagName: string) => " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsFindOptionsReference" ,
"text" : "SavedObjectsFindOptionsReference"
} ,
" | undefined"
] ,
"description" : [
"\nConvert given tag name to a {@link SavedObjectsFindOptionsReference | reference }\nto be used to search using the savedObjects `_find` API. Will return `undefined`\nif the given name does not match any existing tag."
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.SavedObjectsTaggingApiUi.convertNameToReference.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "string" ,
"label" : "tagName" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 112
}
}
2021-03-03 04:02:17 +01:00
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 112
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.SavedObjectsTaggingApiUi.parseSearchQuery" ,
"type" : "Function" ,
"label" : "parseSearchQuery" ,
"signature" : [
"(query: string, options?: " ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
"section" : "def-public.ParseSearchQueryOptions" ,
2021-03-03 04:02:17 +01:00
"text" : "ParseSearchQueryOptions"
} ,
" | undefined) => " ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
"section" : "def-public.ParsedSearchQuery" ,
2021-03-03 04:02:17 +01:00
"text" : "ParsedSearchQuery"
}
] ,
"description" : [
"\nParse given query using EUI's `Query` syntax, and return the search term and the tag references\nto be used when using the `_find` API to retrieve the filtered objects.\n"
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.SavedObjectsTaggingApiUi.parseSearchQuery.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
"label" : "query" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [
"The query to parse"
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 157
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.SavedObjectsTaggingApiUi.parseSearchQuery.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "options" ,
"isRequired" : false ,
"signature" : [
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
"section" : "def-public.ParseSearchQueryOptions" ,
2021-03-03 04:02:17 +01:00
"text" : "ParseSearchQueryOptions"
} ,
" | undefined"
] ,
"description" : [
"see {@link ParseSearchQueryOptions}"
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 157
2021-03-03 04:02:17 +01:00
}
}
] ,
2021-03-06 02:12:28 +01:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 157
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.SavedObjectsTaggingApiUi.getTagIdsFromReferences" ,
"type" : "Function" ,
"label" : "getTagIdsFromReferences" ,
"signature" : [
"(references: (" ,
2021-04-15 17:36:10 +02:00
"SavedObjectReference" ,
2021-03-03 04:02:17 +01:00
" | " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsFindOptionsReference" ,
"text" : "SavedObjectsFindOptionsReference"
} ,
")[]) => string[]"
] ,
"description" : [
"\nReturns the object ids for the tag references from given references array"
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.SavedObjectsTaggingApiUi.getTagIdsFromReferences.$1" ,
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
" | " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreSavedObjectsPluginApi" ,
"section" : "def-server.SavedObjectsFindOptionsReference" ,
"text" : "SavedObjectsFindOptionsReference"
} ,
")[]"
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 163
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 162
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.SavedObjectsTaggingApiUi.getTagIdFromName" ,
"type" : "Function" ,
"label" : "getTagIdFromName" ,
2021-03-06 02:12:28 +01:00
"signature" : [
"(tagName: string) => string | undefined"
2021-03-03 04:02:17 +01:00
] ,
"description" : [
2021-03-06 02:12:28 +01:00
"\nReturns the id for given tag name. Will return `undefined`\nif the given name does not match any existing tag."
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.SavedObjectsTaggingApiUi.getTagIdFromName.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "string" ,
"label" : "tagName" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 170
}
}
2021-03-03 04:02:17 +01:00
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 170
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.SavedObjectsTaggingApiUi.updateTagsReferences" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"label" : "updateTagsReferences" ,
2021-03-03 04:02:17 +01:00
"signature" : [
2021-03-06 02:12:28 +01:00
"(references: " ,
2021-04-15 17:36:10 +02:00
"SavedObjectReference" ,
2021-03-06 02:12:28 +01:00
"[], newTagIds: string[]) => " ,
2021-04-15 17:36:10 +02:00
"SavedObjectReference" ,
2021-03-06 02:12:28 +01:00
"[]"
2021-03-03 04:02:17 +01:00
] ,
"description" : [
2021-03-06 02:12:28 +01:00
"\nReturns a new references array that replace the old tag references with references to the\nnew given tag ids, while preserving all non-tag references."
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.SavedObjectsTaggingApiUi.updateTagsReferences.$1" ,
2021-03-06 02:12:28 +01:00
"type" : "Array" ,
"label" : "references" ,
"isRequired" : true ,
"signature" : [
2021-04-15 17:36:10 +02:00
"SavedObjectReference" ,
2021-03-06 02:12:28 +01:00
"[]"
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 177
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.SavedObjectsTaggingApiUi.updateTagsReferences.$2" ,
2021-03-06 02:12:28 +01:00
"type" : "Array" ,
"label" : "newTagIds" ,
"isRequired" : true ,
"signature" : [
"string[]"
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
"lineNumber" : 178
}
}
2021-03-03 04:02:17 +01:00
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 176
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
"id" : "def-public.SavedObjectsTaggingApiUi.components" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
2021-03-06 02:12:28 +01:00
"label" : "components" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\n{@link SavedObjectsTaggingApiUiComponent | React components} to support the tagging feature."
2021-03-03 04:02:17 +01:00
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 184
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
"section" : "def-public.SavedObjectsTaggingApiUiComponent" ,
2021-03-06 02:12:28 +01:00
"text" : "SavedObjectsTaggingApiUiComponent"
}
2021-03-03 04:02:17 +01:00
]
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 62
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.SavedObjectsTaggingApiUiComponent" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-03-06 02:12:28 +01:00
"label" : "SavedObjectsTaggingApiUiComponent" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nReact UI components to be used to display the tagging feature in any application.\n"
2021-03-03 04:02:17 +01:00
] ,
"tags" : [
"public"
] ,
"children" : [
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.SavedObjectsTaggingApiUiComponent.TagList" ,
"type" : "Function" ,
"label" : "TagList" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nDisplays the tags for given saved object."
2021-03-03 04:02:17 +01:00
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 196
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"React.FunctionComponent<" ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
"section" : "def-public.TagListComponentProps" ,
2021-03-06 02:12:28 +01:00
"text" : "TagListComponentProps"
} ,
">"
2021-03-03 04:02:17 +01:00
]
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.SavedObjectsTaggingApiUiComponent.TagSelector" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
2021-03-06 02:12:28 +01:00
"label" : "TagSelector" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nWidget to select tags."
2021-03-03 04:02:17 +01:00
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 200
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"React.FunctionComponent<" ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
"section" : "def-public.TagSelectorComponentProps" ,
2021-03-06 02:12:28 +01:00
"text" : "TagSelectorComponentProps"
} ,
">"
2021-03-03 04:02:17 +01:00
]
} ,
{
2021-03-06 02:12:28 +01:00
"tags" : [ ] ,
"id" : "def-public.SavedObjectsTaggingApiUiComponent.SavedObjectSaveModalTagSelector" ,
"type" : "Function" ,
"label" : "SavedObjectSaveModalTagSelector" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nComponent to be used with the `options` property of the `SavedObjectSaveModal` or `SavedObjectSaveModalOrigin`\nmodals from the `savedObjects` plugin. It displays the whole field row and handles the 'stateless' nature\nof props passed to inline components"
2021-03-03 04:02:17 +01:00
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 206
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"React.FunctionComponent<" ,
2021-03-03 04:02:17 +01:00
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
"section" : "def-public.SavedObjectSaveModalTagSelectorComponentProps" ,
2021-03-06 02:12:28 +01:00
"text" : "SavedObjectSaveModalTagSelectorComponentProps"
} ,
">"
]
2021-03-03 04:02:17 +01:00
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 192
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.TagListComponentProps" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-03-06 02:12:28 +01:00
"label" : "TagListComponentProps" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nProps type for the {@link SavedObjectsTaggingApiUiComponent.TagList | TagList component}\n"
2021-03-03 04:02:17 +01:00
] ,
"tags" : [
"public"
] ,
"children" : [
{
2021-03-06 02:12:28 +01:00
"tags" : [ ] ,
"id" : "def-public.TagListComponentProps.object" ,
"type" : "Object" ,
"label" : "object" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe object to display tags for."
2021-03-03 04:02:17 +01:00
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 218
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-04-15 17:36:10 +02:00
"SavedObject" ,
2021-03-06 02:12:28 +01:00
"<unknown>"
2021-03-03 04:02:17 +01:00
]
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 214
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-public.TagSelectorComponentProps" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-03-06 02:12:28 +01:00
"label" : "TagSelectorComponentProps" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nProps type for the {@link SavedObjectsTaggingApiUiComponent.TagSelector | TagSelector component}\n"
2021-03-03 04:02:17 +01:00
] ,
"tags" : [
"public"
] ,
"children" : [
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.TagSelectorComponentProps.selected" ,
2021-03-03 04:02:17 +01:00
"type" : "Array" ,
2021-03-06 02:12:28 +01:00
"label" : "selected" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nIds of the currently selected tags"
2021-03-03 04:02:17 +01:00
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 230
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string[]"
]
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-public.TagSelectorComponentProps.onTagsSelected" ,
2021-03-03 04:02:17 +01:00
"type" : "Function" ,
"label" : "onTagsSelected" ,
"description" : [
"\ntags selection callback"
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 234
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"(ids: string[]) => void"
]
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 226
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [
{
"id" : "def-public.SavedObjectTagDecoratorTypeGuard" ,
"type" : "Type" ,
"label" : "SavedObjectTagDecoratorTypeGuard" ,
"tags" : [
"public"
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/api.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 55
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"(object: " ,
{
"pluginId" : "savedObjects" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsPluginApi" ,
"section" : "def-public.SavedObject" ,
"text" : "SavedObject"
} ,
") => boolean"
] ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.TagDecoratedSavedObject" ,
"type" : "Type" ,
"label" : "TagDecoratedSavedObject" ,
"tags" : [
"public"
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/decorator/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 14
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"SavedObject & { getTags(): string[]; setTags(tags: string[]): void; }"
] ,
"initialIsOpen" : false
}
] ,
"objects" : [ ] ,
"setup" : {
"id" : "def-public.SavedObjectTaggingOssPluginSetup" ,
"type" : "Interface" ,
"label" : "SavedObjectTaggingOssPluginSetup" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"id" : "def-public.SavedObjectTaggingOssPluginSetup.registerTaggingApi" ,
"type" : "Function" ,
"label" : "registerTaggingApi" ,
"signature" : [
"(provider: Promise<" ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
"section" : "def-public.SavedObjectsTaggingApi" ,
2021-03-03 04:02:17 +01:00
"text" : "SavedObjectsTaggingApi"
} ,
">) => void"
] ,
"description" : [
"\nRegister a provider for the tagging API.\n\nOnly one provider can be registered, subsequent calls to this method will fail.\n"
] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-public.SavedObjectTaggingOssPluginSetup.registerTaggingApi.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "provider" ,
"isRequired" : true ,
"signature" : [
"Promise<" ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
"section" : "def-public.SavedObjectsTaggingApi" ,
2021-03-03 04:02:17 +01:00
"text" : "SavedObjectsTaggingApi"
} ,
">"
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 21
2021-03-03 04:02:17 +01:00
}
}
] ,
2021-03-06 02:12:28 +01:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 21
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 11
2021-03-03 04:02:17 +01:00
} ,
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
"id" : "def-public.SavedObjectTaggingOssPluginStart" ,
"type" : "Interface" ,
"label" : "SavedObjectTaggingOssPluginStart" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"id" : "def-public.SavedObjectTaggingOssPluginStart.isTaggingAvailable" ,
"type" : "Function" ,
"label" : "isTaggingAvailable" ,
"signature" : [
"() => boolean"
] ,
"description" : [
"\nReturns true if the tagging feature is available (if a provider registered the API)"
] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 28
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.SavedObjectTaggingOssPluginStart.getTaggingApi" ,
"type" : "Function" ,
"label" : "getTaggingApi" ,
"signature" : [
"() => " ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
"scope" : "public" ,
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
"section" : "def-public.SavedObjectsTaggingApi" ,
2021-03-03 04:02:17 +01:00
"text" : "SavedObjectsTaggingApi"
} ,
" | undefined"
] ,
"description" : [
"\nReturns the tagging API, if registered.\nThis will always returns a value if `isTaggingAvailable` returns true, and undefined otherwise."
] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 34
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/public/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 24
2021-03-03 04:02:17 +01:00
} ,
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"server" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
} ,
"common" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [
{
"id" : "def-common.GetAllTagsOptions" ,
"type" : "Interface" ,
"label" : "GetAllTagsOptions" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-common.GetAllTagsOptions.asSystemRequest" ,
"type" : "CompoundType" ,
"label" : "asSystemRequest" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 23
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"boolean | undefined"
]
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 22
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.ITagsClient" ,
"type" : "Interface" ,
"label" : "ITagsClient" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"id" : "def-common.ITagsClient.create" ,
"type" : "Function" ,
"label" : "create" ,
"signature" : [
"(attributes: " ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
2021-03-03 04:02:17 +01:00
"scope" : "common" ,
2021-04-15 17:36:10 +02:00
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
2021-03-03 04:02:17 +01:00
"section" : "def-common.TagAttributes" ,
"text" : "TagAttributes"
} ,
") => Promise<" ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
2021-03-03 04:02:17 +01:00
"scope" : "common" ,
2021-04-15 17:36:10 +02:00
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
2021-03-03 04:02:17 +01:00
"section" : "def-common.Tag" ,
"text" : "Tag"
} ,
">"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-common.ITagsClient.create.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "attributes" ,
"isRequired" : true ,
"signature" : [
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
2021-03-03 04:02:17 +01:00
"scope" : "common" ,
2021-04-15 17:36:10 +02:00
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
2021-03-03 04:02:17 +01:00
"section" : "def-common.TagAttributes" ,
"text" : "TagAttributes"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 27
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 27
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-common.ITagsClient.get" ,
"type" : "Function" ,
"label" : "get" ,
"signature" : [
"(id: string) => Promise<" ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
2021-03-03 04:02:17 +01:00
"scope" : "common" ,
2021-04-15 17:36:10 +02:00
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
2021-03-03 04:02:17 +01:00
"section" : "def-common.Tag" ,
"text" : "Tag"
} ,
">"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-common.ITagsClient.get.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
"label" : "id" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 28
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 28
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-common.ITagsClient.getAll" ,
"type" : "Function" ,
"label" : "getAll" ,
"signature" : [
"(options?: " ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
2021-03-03 04:02:17 +01:00
"scope" : "common" ,
2021-04-15 17:36:10 +02:00
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
2021-03-03 04:02:17 +01:00
"section" : "def-common.GetAllTagsOptions" ,
"text" : "GetAllTagsOptions"
} ,
" | undefined) => Promise<" ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
2021-03-03 04:02:17 +01:00
"scope" : "common" ,
2021-04-15 17:36:10 +02:00
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
2021-03-03 04:02:17 +01:00
"section" : "def-common.Tag" ,
"text" : "Tag"
} ,
"[]>"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-common.ITagsClient.getAll.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "options" ,
"isRequired" : false ,
"signature" : [
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
2021-03-03 04:02:17 +01:00
"scope" : "common" ,
2021-04-15 17:36:10 +02:00
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
2021-03-03 04:02:17 +01:00
"section" : "def-common.GetAllTagsOptions" ,
"text" : "GetAllTagsOptions"
} ,
" | undefined"
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 29
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 29
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-common.ITagsClient.delete" ,
"type" : "Function" ,
"label" : "delete" ,
"signature" : [
"(id: string) => Promise<void>"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-common.ITagsClient.delete.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
"label" : "id" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-common.ITagsClient.update" ,
"type" : "Function" ,
"label" : "update" ,
"signature" : [
"(id: string, attributes: " ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
2021-03-03 04:02:17 +01:00
"scope" : "common" ,
2021-04-15 17:36:10 +02:00
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
2021-03-03 04:02:17 +01:00
"section" : "def-common.TagAttributes" ,
"text" : "TagAttributes"
} ,
") => Promise<" ,
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
2021-03-03 04:02:17 +01:00
"scope" : "common" ,
2021-04-15 17:36:10 +02:00
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
2021-03-03 04:02:17 +01:00
"section" : "def-common.Tag" ,
"text" : "Tag"
} ,
">"
] ,
"description" : [ ] ,
"children" : [
{
2021-04-15 17:36:10 +02:00
"id" : "def-common.ITagsClient.update.$1" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
"label" : "id" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 31
2021-03-03 04:02:17 +01:00
}
} ,
{
2021-04-15 17:36:10 +02:00
"id" : "def-common.ITagsClient.update.$2" ,
2021-03-03 04:02:17 +01:00
"type" : "Object" ,
"label" : "attributes" ,
"isRequired" : true ,
"signature" : [
{
2021-04-15 17:36:10 +02:00
"pluginId" : "savedObjectsTaggingOss" ,
2021-03-03 04:02:17 +01:00
"scope" : "common" ,
2021-04-15 17:36:10 +02:00
"docId" : "kibSavedObjectsTaggingOssPluginApi" ,
2021-03-03 04:02:17 +01:00
"section" : "def-common.TagAttributes" ,
"text" : "TagAttributes"
}
] ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 31
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 31
}
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
"lineNumber" : 26
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.Tag" ,
"type" : "Interface" ,
"label" : "Tag" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-common.Tag.id" ,
"type" : "string" ,
"label" : "id" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
"lineNumber" : 10
}
} ,
{
"tags" : [ ] ,
"id" : "def-common.Tag.name" ,
"type" : "string" ,
"label" : "name" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
"lineNumber" : 11
}
} ,
{
"tags" : [ ] ,
"id" : "def-common.Tag.description" ,
"type" : "string" ,
"label" : "description" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
"lineNumber" : 12
}
} ,
{
"tags" : [ ] ,
"id" : "def-common.Tag.color" ,
"type" : "string" ,
"label" : "color" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
"lineNumber" : 13
}
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
"lineNumber" : 9
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.TagAttributes" ,
"type" : "Interface" ,
"label" : "TagAttributes" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-common.TagAttributes.name" ,
"type" : "string" ,
"label" : "name" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
"lineNumber" : 17
}
} ,
{
"tags" : [ ] ,
"id" : "def-common.TagAttributes.description" ,
"type" : "string" ,
"label" : "description" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
"lineNumber" : 18
}
} ,
{
"tags" : [ ] ,
"id" : "def-common.TagAttributes.color" ,
"type" : "string" ,
"label" : "color" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
"lineNumber" : 19
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "src/plugins/saved_objects_tagging_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 16
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
}
}