maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/api_docs/saved_objects_management.json
Stacey Gammon 503cfcf8c9
Track API stats as part of ci (#95733) 
* Track stats and add extra output information

* Update api docs output

* Clean up id names

* update api docs

* Consolidate error messages and fix a bug

* Update docs

* Update get_declaration_nodes_for_plugin.ts

* Fix bug with removeBrokenLinks not being recursive

* Update docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-04-15 11:36:10 -04:00

1586 lines
57 KiB
JSON
Raw Blame History

{
"id": "savedObjectsManagement",
"client": {
"classes": [
{
"id": "def-public.SavedObjectsManagementAction",
"type": "Class",
"tags": [],
"label": "SavedObjectsManagementAction",
"description": [],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsManagementAction.render",
"type": "Function",
"label": "render",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/action.ts",
"lineNumber": 18
},
"signature": [
"() => React.ReactNode"
]
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementAction.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/action.ts",
"lineNumber": 19
}
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementAction.euiAction",
"type": "Object",
"label": "euiAction",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/action.ts",
"lineNumber": 20
},
"signature": [
"{ name: string; description: string; icon: string; type: string; available?: ((item: ",
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementRecord",
"text": "SavedObjectsManagementRecord"
},
") => boolean) | undefined; enabled?: ((item: ",
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementRecord",
"text": "SavedObjectsManagementRecord"
},
") => boolean) | undefined; onClick?: ((item: ",
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementRecord",
"text": "SavedObjectsManagementRecord"
},
") => void) | undefined; render?: ((item: ",
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementRecord",
"text": "SavedObjectsManagementRecord"
},
") => any) | undefined; }"
]
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementAction.refreshOnFinish",
"type": "Function",
"label": "refreshOnFinish",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/action.ts",
"lineNumber": 30
},
"signature": [
"(() => boolean) | undefined"
]
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementAction.actionContext",
"type": "CompoundType",
"label": "actionContext",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/action.ts",
"lineNumber": 34
},
"signature": [
"ActionContext | null"
]
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementAction.record",
"type": "CompoundType",
"label": "record",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/action.ts",
"lineNumber": 35
},
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementRecord",
"text": "SavedObjectsManagementRecord"
},
" | null"
]
},
{
"id": "def-public.SavedObjectsManagementAction.setActionContext",
"type": "Function",
"label": "setActionContext",
"signature": [
"(actionContext: ActionContext) => void"
],
"description": [],
"children": [
{
"id": "def-public.SavedObjectsManagementAction.setActionContext.$1",
"type": "Object",
"label": "actionContext",
"isRequired": true,
"signature": [
"ActionContext"
],
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/action.ts",
"lineNumber": 37
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/action.ts",
"lineNumber": 37
}
},
{
"id": "def-public.SavedObjectsManagementAction.registerOnFinishCallback",
"type": "Function",
"label": "registerOnFinishCallback",
"signature": [
"(callback: Function) => void"
],
"description": [],
"children": [
{
"id": "def-public.SavedObjectsManagementAction.registerOnFinishCallback.$1",
"type": "Object",
"label": "callback",
"isRequired": true,
"signature": [
"Function"
],
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/action.ts",
"lineNumber": 41
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/action.ts",
"lineNumber": 41
}
},
{
"id": "def-public.SavedObjectsManagementAction.start",
"type": "Function",
"label": "start",
"signature": [
"(record: ",
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementRecord",
"text": "SavedObjectsManagementRecord"
},
") => void"
],
"description": [],
"children": [
{
"id": "def-public.SavedObjectsManagementAction.start.$1",
"type": "Object",
"label": "record",
"isRequired": true,
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementRecord",
"text": "SavedObjectsManagementRecord"
}
],
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/action.ts",
"lineNumber": 45
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/action.ts",
"lineNumber": 45
}
},
{
"id": "def-public.SavedObjectsManagementAction.finish",
"type": "Function",
"label": "finish",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/action.ts",
"lineNumber": 49
}
}
],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/action.ts",
"lineNumber": 17
},
"initialIsOpen": false
}
],
"functions": [
{
"id": "def-public.processImportResponse",
"type": "Function",
"label": "processImportResponse",
"signature": [
"(response: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportResponse",
"text": "SavedObjectsImportResponse"
},
") => ",
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.ProcessedImportResponse",
"text": "ProcessedImportResponse"
}
],
"description": [],
"children": [
{
"id": "def-public.processImportResponse.$1",
"type": "Object",
"label": "response",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportResponse",
"text": "SavedObjectsImportResponse"
}
],
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts",
"lineNumber": 52
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts",
"lineNumber": 51
},
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-public.FailedImport",
"type": "Interface",
"label": "FailedImport",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.FailedImport.obj",
"type": "Object",
"label": "obj",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts",
"lineNumber": 22
},
"signature": [
"Pick<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportFailure",
"text": "SavedObjectsImportFailure"
},
", \"type\" | \"title\" | \"id\" | \"meta\" | \"overwrite\">"
]
},
{
"tags": [],
"id": "def-public.FailedImport.error",
"type": "CompoundType",
"label": "error",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts",
"lineNumber": 23
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportConflictError",
"text": "SavedObjectsImportConflictError"
},
" | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportAmbiguousConflictError",
"text": "SavedObjectsImportAmbiguousConflictError"
},
" | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportUnsupportedTypeError",
"text": "SavedObjectsImportUnsupportedTypeError"
},
" | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportMissingReferencesError",
"text": "SavedObjectsImportMissingReferencesError"
},
" | ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportUnknownError",
"text": "SavedObjectsImportUnknownError"
}
]
}
],
"source": {
"path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts",
"lineNumber": 21
},
"initialIsOpen": false
},
{
"id": "def-public.ProcessedImportResponse",
"type": "Interface",
"label": "ProcessedImportResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ProcessedImportResponse.failedImports",
"type": "Array",
"label": "failedImports",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts",
"lineNumber": 38
},
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.FailedImport",
"text": "FailedImport"
},
"[]"
]
},
{
"tags": [],
"id": "def-public.ProcessedImportResponse.successfulImports",
"type": "Array",
"label": "successfulImports",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts",
"lineNumber": 39
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportSuccess",
"text": "SavedObjectsImportSuccess"
},
"[]"
]
},
{
"tags": [],
"id": "def-public.ProcessedImportResponse.unmatchedReferences",
"type": "Array",
"label": "unmatchedReferences",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts",
"lineNumber": 40
},
"signature": [
"UnmatchedReference[]"
]
},
{
"tags": [],
"id": "def-public.ProcessedImportResponse.status",
"type": "CompoundType",
"label": "status",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts",
"lineNumber": 41
},
"signature": [
"\"success\" | \"idle\""
]
},
{
"tags": [],
"id": "def-public.ProcessedImportResponse.importCount",
"type": "number",
"label": "importCount",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts",
"lineNumber": 42
}
},
{
"tags": [],
"id": "def-public.ProcessedImportResponse.conflictedSavedObjectsLinkedToSavedSearches",
"type": "Uncategorized",
"label": "conflictedSavedObjectsLinkedToSavedSearches",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts",
"lineNumber": 43
},
"signature": [
"undefined"
]
},
{
"tags": [],
"id": "def-public.ProcessedImportResponse.conflictedSearchDocs",
"type": "Uncategorized",
"label": "conflictedSearchDocs",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts",
"lineNumber": 44
},
"signature": [
"undefined"
]
},
{
"tags": [],
"id": "def-public.ProcessedImportResponse.importWarnings",
"type": "Array",
"label": "importWarnings",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts",
"lineNumber": 45
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsImportWarning",
"text": "SavedObjectsImportWarning"
},
"[]"
]
}
],
"source": {
"path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts",
"lineNumber": 37
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectMetadata",
"type": "Interface",
"label": "SavedObjectMetadata",
"description": [
"\nThe metadata injected into a {@link SavedObject | saved object} when returning\n{@link SavedObjectWithMetadata | enhanced objects} from the plugin API endpoints."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectMetadata.icon",
"type": "string",
"label": "icon",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 17
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.SavedObjectMetadata.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 18
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.SavedObjectMetadata.editUrl",
"type": "string",
"label": "editUrl",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 19
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-public.SavedObjectMetadata.inAppUrl",
"type": "Object",
"label": "inAppUrl",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 20
},
"signature": [
"{ path: string; uiCapabilitiesPath: string; } | undefined"
]
},
{
"tags": [],
"id": "def-public.SavedObjectMetadata.namespaceType",
"type": "CompoundType",
"label": "namespaceType",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 21
},
"signature": [
"\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\" | undefined"
]
}
],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 16
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectRelation",
"type": "Interface",
"label": "SavedObjectRelation",
"description": [
"\nRepresents a relation between two {@link SavedObject | saved object}"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectRelation.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 37
}
},
{
"tags": [],
"id": "def-public.SavedObjectRelation.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 38
}
},
{
"tags": [],
"id": "def-public.SavedObjectRelation.relationship",
"type": "CompoundType",
"label": "relationship",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 39
},
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "common",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-common.SavedObjectRelationKind",
"text": "SavedObjectRelationKind"
}
]
},
{
"tags": [],
"id": "def-public.SavedObjectRelation.meta",
"type": "Object",
"label": "meta",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 40
},
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "common",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-common.SavedObjectMetadata",
"text": "SavedObjectMetadata"
}
]
}
],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 36
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsManagementActionServiceSetup",
"type": "Interface",
"label": "SavedObjectsManagementActionServiceSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsManagementActionServiceSetup.register",
"type": "Function",
"label": "register",
"description": [
"\nregister given action in the registry."
],
"source": {
"path": "src/plugins/saved_objects_management/public/services/action_service.ts",
"lineNumber": 15
},
"signature": [
"(action: ",
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementAction",
"text": "SavedObjectsManagementAction"
},
") => void"
]
}
],
"source": {
"path": "src/plugins/saved_objects_management/public/services/action_service.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsManagementActionServiceStart",
"type": "Interface",
"label": "SavedObjectsManagementActionServiceStart",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsManagementActionServiceStart.has",
"type": "Function",
"label": "has",
"description": [
"\nreturn true if the registry contains given action, false otherwise."
],
"source": {
"path": "src/plugins/saved_objects_management/public/services/action_service.ts",
"lineNumber": 22
},
"signature": [
"(actionId: string) => boolean"
]
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementActionServiceStart.getAll",
"type": "Function",
"label": "getAll",
"description": [
"\nreturn all {@link SavedObjectsManagementAction | actions} currently registered."
],
"source": {
"path": "src/plugins/saved_objects_management/public/services/action_service.ts",
"lineNumber": 26
},
"signature": [
"() => ",
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementAction",
"text": "SavedObjectsManagementAction"
},
"[]"
]
}
],
"source": {
"path": "src/plugins/saved_objects_management/public/services/action_service.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsManagementColumn",
"type": "Interface",
"label": "SavedObjectsManagementColumn",
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementColumn",
"text": "SavedObjectsManagementColumn"
},
"<T>"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsManagementColumn.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/column.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementColumn.euiColumn",
"type": "Object",
"label": "euiColumn",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/column.ts",
"lineNumber": 14
},
"signature": [
"Pick<",
"EuiTableFieldDataColumnType",
"<",
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementRecord",
"text": "SavedObjectsManagementRecord"
},
">, \"children\" | \"headers\" | \"onClick\" | \"onChange\" | \"color\" | \"onKeyDown\" | \"description\" | \"title\" | \"id\" | \"name\" | \"field\" | \"placeholder\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"css\" | \"data-test-subj\" | \"width\" | \"render\" | \"align\" | \"abbr\" | \"footer\" | \"colSpan\" | \"rowSpan\" | \"scope\" | \"valign\" | \"dataType\" | \"isExpander\" | \"textOnly\" | \"truncateText\" | \"isMobileHeader\" | \"mobileOptions\" | \"hideForMobile\">"
]
}
],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/column.ts",
"lineNumber": 12
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsManagementColumnServiceSetup",
"type": "Interface",
"label": "SavedObjectsManagementColumnServiceSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsManagementColumnServiceSetup.register",
"type": "Function",
"label": "register",
"description": [
"\nregister given column in the registry."
],
"source": {
"path": "src/plugins/saved_objects_management/public/services/column_service.ts",
"lineNumber": 15
},
"signature": [
"(column: ",
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementColumn",
"text": "SavedObjectsManagementColumn"
},
"<unknown>) => void"
]
}
],
"source": {
"path": "src/plugins/saved_objects_management/public/services/column_service.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsManagementColumnServiceStart",
"type": "Interface",
"label": "SavedObjectsManagementColumnServiceStart",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsManagementColumnServiceStart.getAll",
"type": "Function",
"label": "getAll",
"description": [
"\nreturn all {@link SavedObjectsManagementColumn | columns} currently registered."
],
"source": {
"path": "src/plugins/saved_objects_management/public/services/column_service.ts",
"lineNumber": 22
},
"signature": [
"() => ",
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementColumn",
"text": "SavedObjectsManagementColumn"
},
"<unknown>[]"
]
}
],
"source": {
"path": "src/plugins/saved_objects_management/public/services/column_service.ts",
"lineNumber": 18
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsManagementRecord",
"type": "Interface",
"label": "SavedObjectsManagementRecord",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsManagementRecord.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/record.ts",
"lineNumber": 12
}
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementRecord.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/record.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementRecord.meta",
"type": "Object",
"label": "meta",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/record.ts",
"lineNumber": 14
},
"signature": [
"{ icon: string; title: string; namespaceType: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsNamespaceType",
"text": "SavedObjectsNamespaceType"
},
"; }"
]
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementRecord.references",
"type": "Array",
"label": "references",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/record.ts",
"lineNumber": 19
},
"signature": [
"SavedObjectReference",
"[]"
]
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementRecord.namespaces",
"type": "Array",
"label": "namespaces",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/record.ts",
"lineNumber": 20
},
"signature": [
"string[] | undefined"
]
}
],
"source": {
"path": "src/plugins/saved_objects_management/public/services/types/record.ts",
"lineNumber": 11
},
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectsManagementServiceRegistryEntry",
"type": "Interface",
"label": "SavedObjectsManagementServiceRegistryEntry",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsManagementServiceRegistryEntry.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/service_registry.ts",
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementServiceRegistryEntry.service",
"type": "Object",
"label": "service",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/service_registry.ts",
"lineNumber": 14
},
"signature": [
{
"pluginId": "savedObjects",
"scope": "public",
"docId": "kibSavedObjectsPluginApi",
"section": "def-public.SavedObjectLoader",
"text": "SavedObjectLoader"
}
]
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementServiceRegistryEntry.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/service_registry.ts",
"lineNumber": 15
}
}
],
"source": {
"path": "src/plugins/saved_objects_management/public/services/service_registry.ts",
"lineNumber": 12
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-public.ISavedObjectsManagementServiceRegistry",
"type": "Type",
"label": "ISavedObjectsManagementServiceRegistry",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/services/service_registry.ts",
"lineNumber": 18
},
"signature": [
"{ get: (id: string) => SavedObjectsManagementServiceRegistryEntry | undefined; register: (entry: SavedObjectsManagementServiceRegistryEntry) => void; all: () => SavedObjectsManagementServiceRegistryEntry[]; }"
],
"initialIsOpen": false
},
{
"id": "def-public.SavedObjectWithMetadata",
"type": "Type",
"label": "SavedObjectWithMetadata",
"tags": [],
"description": [
"\nA {@link SavedObject | saved object} enhanced with meta properties used by the client-side plugin."
],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 27
},
"signature": [
"SavedObject<T> & { meta: SavedObjectMetadata; }"
],
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"id": "def-public.SavedObjectsManagementPluginSetup",
"type": "Interface",
"label": "SavedObjectsManagementPluginSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsManagementPluginSetup.actions",
"type": "Object",
"label": "actions",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/plugin.ts",
"lineNumber": 32
},
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementActionServiceSetup",
"text": "SavedObjectsManagementActionServiceSetup"
}
]
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementPluginSetup.columns",
"type": "Object",
"label": "columns",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/plugin.ts",
"lineNumber": 33
},
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementColumnServiceSetup",
"text": "SavedObjectsManagementColumnServiceSetup"
}
]
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementPluginSetup.serviceRegistry",
"type": "Object",
"label": "serviceRegistry",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/plugin.ts",
"lineNumber": 34
},
"signature": [
"Pick<",
"SavedObjectsManagementServiceRegistry",
", \"get\" | \"register\" | \"all\">"
]
}
],
"source": {
"path": "src/plugins/saved_objects_management/public/plugin.ts",
"lineNumber": 31
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.SavedObjectsManagementPluginStart",
"type": "Interface",
"label": "SavedObjectsManagementPluginStart",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.SavedObjectsManagementPluginStart.actions",
"type": "Object",
"label": "actions",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/plugin.ts",
"lineNumber": 38
},
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementActionServiceStart",
"text": "SavedObjectsManagementActionServiceStart"
}
]
},
{
"tags": [],
"id": "def-public.SavedObjectsManagementPluginStart.columns",
"type": "Object",
"label": "columns",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/public/plugin.ts",
"lineNumber": 39
},
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "public",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-public.SavedObjectsManagementColumnServiceStart",
"text": "SavedObjectsManagementColumnServiceStart"
}
]
}
],
"source": {
"path": "src/plugins/saved_objects_management/public/plugin.ts",
"lineNumber": 37
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-common.SavedObjectGetRelationshipsResponse",
"type": "Interface",
"label": "SavedObjectGetRelationshipsResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.SavedObjectGetRelationshipsResponse.relations",
"type": "Array",
"label": "relations",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 51
},
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "common",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-common.SavedObjectRelation",
"text": "SavedObjectRelation"
},
"[]"
]
},
{
"tags": [],
"id": "def-common.SavedObjectGetRelationshipsResponse.invalidRelations",
"type": "Array",
"label": "invalidRelations",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 52
},
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "common",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-common.SavedObjectInvalidRelation",
"text": "SavedObjectInvalidRelation"
},
"[]"
]
}
],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 50
},
"initialIsOpen": false
},
{
"id": "def-common.SavedObjectInvalidRelation",
"type": "Interface",
"label": "SavedObjectInvalidRelation",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.SavedObjectInvalidRelation.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 44
}
},
{
"tags": [],
"id": "def-common.SavedObjectInvalidRelation.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 45
}
},
{
"tags": [],
"id": "def-common.SavedObjectInvalidRelation.relationship",
"type": "CompoundType",
"label": "relationship",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 46
},
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "common",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-common.SavedObjectRelationKind",
"text": "SavedObjectRelationKind"
}
]
},
{
"tags": [],
"id": "def-common.SavedObjectInvalidRelation.error",
"type": "string",
"label": "error",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 47
}
}
],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 43
},
"initialIsOpen": false
},
{
"id": "def-common.SavedObjectMetadata",
"type": "Interface",
"label": "SavedObjectMetadata",
"description": [
"\nThe metadata injected into a {@link SavedObject | saved object} when returning\n{@link SavedObjectWithMetadata | enhanced objects} from the plugin API endpoints."
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.SavedObjectMetadata.icon",
"type": "string",
"label": "icon",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 17
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SavedObjectMetadata.title",
"type": "string",
"label": "title",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 18
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SavedObjectMetadata.editUrl",
"type": "string",
"label": "editUrl",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 19
},
"signature": [
"string | undefined"
]
},
{
"tags": [],
"id": "def-common.SavedObjectMetadata.inAppUrl",
"type": "Object",
"label": "inAppUrl",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 20
},
"signature": [
"{ path: string; uiCapabilitiesPath: string; } | undefined"
]
},
{
"tags": [],
"id": "def-common.SavedObjectMetadata.namespaceType",
"type": "CompoundType",
"label": "namespaceType",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 21
},
"signature": [
"\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\" | undefined"
]
}
],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 16
},
"initialIsOpen": false
},
{
"id": "def-common.SavedObjectRelation",
"type": "Interface",
"label": "SavedObjectRelation",
"description": [
"\nRepresents a relation between two {@link SavedObject | saved object}"
],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.SavedObjectRelation.id",
"type": "string",
"label": "id",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 37
}
},
{
"tags": [],
"id": "def-common.SavedObjectRelation.type",
"type": "string",
"label": "type",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 38
}
},
{
"tags": [],
"id": "def-common.SavedObjectRelation.relationship",
"type": "CompoundType",
"label": "relationship",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 39
},
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "common",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-common.SavedObjectRelationKind",
"text": "SavedObjectRelationKind"
}
]
},
{
"tags": [],
"id": "def-common.SavedObjectRelation.meta",
"type": "Object",
"label": "meta",
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 40
},
"signature": [
{
"pluginId": "savedObjectsManagement",
"scope": "common",
"docId": "kibSavedObjectsManagementPluginApi",
"section": "def-common.SavedObjectMetadata",
"text": "SavedObjectMetadata"
}
]
}
],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 36
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-common.SavedObjectRelationKind",
"type": "Type",
"label": "SavedObjectRelationKind",
"tags": [],
"description": [],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 31
},
"signature": [
"\"parent\" | \"child\""
],
"initialIsOpen": false
},
{
"id": "def-common.SavedObjectWithMetadata",
"type": "Type",
"label": "SavedObjectWithMetadata",
"tags": [],
"description": [
"\nA {@link SavedObject | saved object} enhanced with meta properties used by the client-side plugin."
],
"source": {
"path": "src/plugins/saved_objects_management/common/types.ts",
"lineNumber": 27
},
"signature": [
"SavedObject<T> & { meta: SavedObjectMetadata; }"
],
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink