4036 lines
143 KiB
JSON
4036 lines
143 KiB
JSON
{
|
|
"id": "spaces",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.getSpaceColor",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSpaceColor",
|
|
"description": [
|
|
"\nDetermines the color for the provided space.\nIf a color is present on the Space itself, then that is used.\nOtherwise, a color is provided from EUI's Visualization Colors based on the space name.\n"
|
|
],
|
|
"signature": [
|
|
"(space: Partial<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">) => string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.getSpaceColor.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "space",
|
|
"description": [
|
|
"the space."
|
|
],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.getSpaceImageUrl",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSpaceImageUrl",
|
|
"description": [
|
|
"\nDetermines the avatar image for the provided space.\n"
|
|
],
|
|
"signature": [
|
|
"(space: Partial<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">) => string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.getSpaceImageUrl.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "space",
|
|
"description": [
|
|
"the space."
|
|
],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.getSpaceInitials",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSpaceInitials",
|
|
"description": [
|
|
"\nDetermines the initials for the provided space.\nIf initials are present on the Space itself, then that is used.\nOtherwise, the initials are calculated based off the words in the space name, with a max length of 2 characters.\n"
|
|
],
|
|
"signature": [
|
|
"(space: Partial<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">) => string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.getSpaceInitials.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "space",
|
|
"description": [
|
|
"the space."
|
|
],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.CopyToSpaceFlyoutProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CopyToSpaceFlyoutProps",
|
|
"description": [
|
|
"\nProperties for the CopyToSpaceFlyout."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.CopyToSpaceFlyoutProps.savedObjectTarget",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectTarget",
|
|
"description": [
|
|
"\nThe object to render the flyout for."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.CopyToSpaceSavedObjectTarget",
|
|
"text": "CopyToSpaceSavedObjectTarget"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.CopyToSpaceFlyoutProps.onClose",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onClose",
|
|
"description": [
|
|
"\nOptional callback when the flyout is closed."
|
|
],
|
|
"signature": [
|
|
"(() => void) | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.CopyToSpaceSavedObjectTarget",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "CopyToSpaceSavedObjectTarget",
|
|
"description": [
|
|
"\nDescribes the target saved object during a copy operation."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.CopyToSpaceSavedObjectTarget.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\nThe object's type."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.CopyToSpaceSavedObjectTarget.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nThe object's ID."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.CopyToSpaceSavedObjectTarget.namespaces",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "namespaces",
|
|
"description": [
|
|
"\nThe namespaces that the object currently exists in."
|
|
],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.CopyToSpaceSavedObjectTarget.icon",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "icon",
|
|
"description": [
|
|
"\nThe EUI icon that is rendered in the flyout's subtitle.\n\nDefault is 'apps'."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.CopyToSpaceSavedObjectTarget.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [
|
|
"\nThe string that is rendered in the flyout's subtitle.\n\nDefault is `${type} [id=${id}]`."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.EmbeddableLegacyUrlConflictProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "EmbeddableLegacyUrlConflictProps",
|
|
"description": [
|
|
"\nProperties for the EmbeddableLegacyUrlConflict component."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.EmbeddableLegacyUrlConflictProps.targetType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "targetType",
|
|
"description": [
|
|
"\nThe target type of the legacy URL alias."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.EmbeddableLegacyUrlConflictProps.sourceId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sourceId",
|
|
"description": [
|
|
"\nThe source ID of the legacy URL alias."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.GetSpaceResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetSpaceResult",
|
|
"description": [
|
|
"\nResponse format when querying for spaces."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetSpaceResult",
|
|
"text": "GetSpaceResult"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.GetSpaceResult.authorizedPurposes",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "authorizedPurposes",
|
|
"description": [
|
|
"\nA set of flags indicating which purposes the user is authorized for."
|
|
],
|
|
"signature": [
|
|
"Record<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetAllSpacesPurpose",
|
|
"text": "GetAllSpacesPurpose"
|
|
},
|
|
", boolean> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.LegacyUrlConflictProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LegacyUrlConflictProps",
|
|
"description": [
|
|
"\nProperties for the LegacyUrlConflict component."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.LegacyUrlConflictProps.objectNoun",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "objectNoun",
|
|
"description": [
|
|
"\nThe string that is used to describe the object in the callout, e.g., _There is a legacy URL for this page that points to a different\n**object**_.\n\nDefault value is 'object'."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.LegacyUrlConflictProps.currentObjectId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "currentObjectId",
|
|
"description": [
|
|
"\nThe ID of the object that is currently shown on the page."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.LegacyUrlConflictProps.otherObjectId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "otherObjectId",
|
|
"description": [
|
|
"\nThe ID of the other object that the legacy URL alias points to."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.LegacyUrlConflictProps.otherObjectPath",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "otherObjectPath",
|
|
"description": [
|
|
"\n The path within your application to use for the new URL, optionally including `search` and/or `hash` URL components. Do not include\n `/app/my-app` or the current base path."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceFlyoutProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ShareToSpaceFlyoutProps",
|
|
"description": [
|
|
"\nProperties for the ShareToSpaceFlyout."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceFlyoutProps.savedObjectTarget",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectTarget",
|
|
"description": [
|
|
"\nThe object to render the flyout for."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.ShareToSpaceSavedObjectTarget",
|
|
"text": "ShareToSpaceSavedObjectTarget"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceFlyoutProps.flyoutIcon",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "flyoutIcon",
|
|
"description": [
|
|
"\nThe EUI icon that is rendered in the flyout's title.\n\nDefault is 'share'."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceFlyoutProps.flyoutTitle",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "flyoutTitle",
|
|
"description": [
|
|
"\nThe string that is rendered in the flyout's title.\n\nDefault is 'Edit spaces for object'."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceFlyoutProps.enableCreateCopyCallout",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "enableCreateCopyCallout",
|
|
"description": [
|
|
"\nWhen enabled, if the object is not yet shared to multiple spaces, a callout will be displayed that suggests the user might want to\ncreate a copy instead.\n\nDefault value is false."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceFlyoutProps.enableCreateNewSpaceLink",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "enableCreateNewSpaceLink",
|
|
"description": [
|
|
"\nWhen enabled, if no other spaces exist _and_ the user has the appropriate privileges, a sentence will be displayed that suggests the\nuser might want to create a space.\n\nDefault value is false."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceFlyoutProps.behaviorContext",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "behaviorContext",
|
|
"description": [
|
|
"\nWhen set to 'within-space' (default), the flyout behaves like it is running on a page within the active space, and it will prevent the\nuser from removing the object from the active space.\n\nConversely, when set to 'outside-space', the flyout behaves like it is running on a page outside of any space, so it will allow the\nuser to remove the object from the active space."
|
|
],
|
|
"signature": [
|
|
"\"within-space\" | \"outside-space\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceFlyoutProps.changeSpacesHandler",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "changeSpacesHandler",
|
|
"description": [
|
|
"\nOptional handler that is called when the user has saved changes and there are spaces to be added to and/or removed from the object and\nits relatives. If this is not defined, a default handler will be used that calls `/api/spaces/_update_objects_spaces` and displays a\ntoast indicating what occurred."
|
|
],
|
|
"signature": [
|
|
"((objects: { type: string; id: string; }[], spacesToAdd: string[], spacesToRemove: string[]) => Promise<void>) | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceFlyoutProps.changeSpacesHandler.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "objects",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: string; id: string; }[]"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceFlyoutProps.changeSpacesHandler.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "spacesToAdd",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceFlyoutProps.changeSpacesHandler.$3",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "spacesToRemove",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceFlyoutProps.onUpdate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onUpdate",
|
|
"description": [
|
|
"\nOptional callback when the target object and its relatives are updated."
|
|
],
|
|
"signature": [
|
|
"((updatedObjects: { type: string; id: string; }[]) => void) | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceFlyoutProps.onUpdate.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "updatedObjects",
|
|
"description": [],
|
|
"signature": [
|
|
"{ type: string; id: string; }[]"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceFlyoutProps.onClose",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onClose",
|
|
"description": [
|
|
"\nOptional callback when the flyout is closed."
|
|
],
|
|
"signature": [
|
|
"(() => void) | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceSavedObjectTarget",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ShareToSpaceSavedObjectTarget",
|
|
"description": [
|
|
"\nDescribes the target saved object during a share operation."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceSavedObjectTarget.type",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "type",
|
|
"description": [
|
|
"\nThe object's type."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceSavedObjectTarget.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nThe object's ID."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceSavedObjectTarget.namespaces",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "namespaces",
|
|
"description": [
|
|
"\nThe namespaces that the object currently exists in."
|
|
],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceSavedObjectTarget.icon",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "icon",
|
|
"description": [
|
|
"\nThe EUI icon that is rendered in the flyout's subtitle.\n\nDefault is 'empty'."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceSavedObjectTarget.title",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "title",
|
|
"description": [
|
|
"\nThe string that is rendered in the flyout's subtitle.\n\nDefault is `${type} [id=${id}]`."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.ShareToSpaceSavedObjectTarget.noun",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "noun",
|
|
"description": [
|
|
"\nThe string that is used to describe the object in several places, e.g., _Make **object** available in selected spaces only_.\n\nDefault value is 'object'."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.Space",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Space",
|
|
"description": [
|
|
"\nA Space."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.Space.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nThe unique identifier for this space.\nThe id becomes part of the \"URL Identifier\" of the space.\n\nExample: an id of `marketing` would result in the URL identifier of `/s/marketing`."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.Space.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"\nDisplay name for this space."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.Space.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [
|
|
"\nOptional description for this space."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.Space.color",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "color",
|
|
"description": [
|
|
"\nOptional color (hex code) for this space.\nIf neither `color` nor `imageUrl` is specified, then a color will be automatically generated."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.Space.initials",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "initials",
|
|
"description": [
|
|
"\nOptional display initials for this space's avatar. Supports a maximum of 2 characters.\nIf initials are not provided, then they will be derived from the space name automatically.\n\nInitials are not displayed if an `imageUrl` has been specified."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.Space.imageUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "imageUrl",
|
|
"description": [
|
|
"\nOptional base-64 encoded data image url to show as this space's avatar.\nThis setting takes precedence over any configured `color` or `initials`."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.Space.disabledFeatures",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "disabledFeatures",
|
|
"description": [
|
|
"\nThe set of feature ids that should be hidden within this space."
|
|
],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.Space._reserved",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"private"
|
|
],
|
|
"label": "_reserved",
|
|
"description": [
|
|
"\nIndicates that this space is reserved (system controlled).\nReserved spaces cannot be created or deleted by end-users."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpaceAvatarProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SpaceAvatarProps",
|
|
"description": [
|
|
"\nProperties for the SpaceAvatar component."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpaceAvatarProps.space",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "space",
|
|
"description": [
|
|
"The space to represent with an avatar."
|
|
],
|
|
"signature": [
|
|
"{ id?: string | undefined; name?: string | undefined; description?: string | undefined; color?: string | undefined; initials?: string | undefined; imageUrl?: string | undefined; disabledFeatures?: string[] | undefined; _reserved?: boolean | undefined; }"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpaceAvatarProps.size",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "size",
|
|
"description": [
|
|
"The size of the avatar."
|
|
],
|
|
"signature": [
|
|
"\"m\" | \"s\" | \"l\" | \"xl\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpaceAvatarProps.className",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "className",
|
|
"description": [
|
|
"Optional CSS class(es) to apply."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpaceAvatarProps.announceSpaceName",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "announceSpaceName",
|
|
"description": [
|
|
"\nWhen enabled, allows EUI to provide an aria-label for this component, which is announced on screen readers.\n\nDefault value is true."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpaceAvatarProps.isDisabled",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isDisabled",
|
|
"description": [
|
|
"\nWhether or not to render the avatar in a disabled state.\n\nDefault value is false."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_avatar/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpaceListProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SpaceListProps",
|
|
"description": [
|
|
"\nProperties for the SpaceList component."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_list/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpaceListProps.namespaces",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "namespaces",
|
|
"description": [
|
|
"\nThe namespaces of a saved object to render into a corresponding list of spaces."
|
|
],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_list/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpaceListProps.displayLimit",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "displayLimit",
|
|
"description": [
|
|
"\nOptional limit to the number of spaces that can be displayed in the list. If the number of spaces exceeds this limit, they will be\nhidden behind a \"show more\" button. Set to 0 to disable.\n\nDefault value is 5."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_list/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpaceListProps.behaviorContext",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "behaviorContext",
|
|
"description": [
|
|
"\nWhen set to 'within-space' (default), the space list behaves like it is running on a page within the active space, and it will omit the\nactive space (e.g., it displays a list of all the _other_ spaces that an object is shared to).\n\nConversely, when set to 'outside-space', the space list behaves like it is running on a page outside of any space, so it will not omit\nthe active space."
|
|
],
|
|
"signature": [
|
|
"\"within-space\" | \"outside-space\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/space_list/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUi",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SpacesApiUi",
|
|
"description": [
|
|
"\nUI components and services to add spaces capabilities to an application."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUi.components",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "components",
|
|
"description": [
|
|
"\nLazy-loadable {@link SpacesApiUiComponent | React components} to support the Spaces feature."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.SpacesApiUiComponent",
|
|
"text": "SpacesApiUiComponent"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUi.redirectLegacyUrl",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "redirectLegacyUrl",
|
|
"description": [
|
|
"\nRedirect the user from a legacy URL to a new URL. This needs to be used if a call to `SavedObjectsClient.resolve()` results in an\n`\"aliasMatch\"` outcome, which indicates that the user has loaded the page using a legacy URL. Calling this function will trigger a\nclient-side redirect to the new URL, and it will display a toast to the user.\n\nConsumers need to determine the local path for the new URL on their own, based on the object ID that was used to call\n`SavedObjectsClient.resolve()` (old ID) and the object ID in the result (new ID). For example...\n\nThe old object ID is `workpad-123` and the new object ID is `workpad-e08b9bdb-ec14-4339-94c4-063bddfd610e`.\n\nFull legacy URL: `https://localhost:5601/app/canvas#/workpad/workpad-123/page/1`\n\nNew URL path: `#/workpad/workpad-e08b9bdb-ec14-4339-94c4-063bddfd610e/page/1`\n\nThe protocol, hostname, port, base path, and app path are automatically included.\n"
|
|
],
|
|
"signature": [
|
|
"(path: string, objectNoun?: string | undefined) => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUi.redirectLegacyUrl.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [
|
|
"The path to use for the new URL, optionally including `search` and/or `hash` URL components."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUi.redirectLegacyUrl.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "objectNoun",
|
|
"description": [
|
|
"The string that is used to describe the object in the toast, e.g., _The **object** you're looking for has a new\nlocation_. Default value is 'object'."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUi.useSpaces",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "useSpaces",
|
|
"description": [
|
|
"\nHelper function to easily access the Spaces React Context provider."
|
|
],
|
|
"signature": [
|
|
"<Services extends Partial<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
">>() => ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.SpacesReactContextValue",
|
|
"text": "SpacesReactContextValue"
|
|
},
|
|
"<Services>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUiComponent",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SpacesApiUiComponent",
|
|
"description": [
|
|
"\nReact UI components to be used to display the Spaces feature in any application."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUiComponent.getSpacesContextProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSpacesContextProvider",
|
|
"description": [
|
|
"\nProvides a context that is required to render some Spaces components."
|
|
],
|
|
"signature": [
|
|
"(props: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.SpacesContextProps",
|
|
"text": "SpacesContextProps"
|
|
},
|
|
") => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUiComponent.getSpacesContextProvider.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUiComponent.getShareToSpaceFlyout",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getShareToSpaceFlyout",
|
|
"description": [
|
|
"\nDisplays a flyout to edit the spaces that an object is shared to.\n\nNote: must be rendered inside of a SpacesContext."
|
|
],
|
|
"signature": [
|
|
"(props: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.ShareToSpaceFlyoutProps",
|
|
"text": "ShareToSpaceFlyoutProps"
|
|
},
|
|
") => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUiComponent.getShareToSpaceFlyout.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUiComponent.getCopyToSpaceFlyout",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getCopyToSpaceFlyout",
|
|
"description": [
|
|
"\nDisplays a flyout to copy an object to other spaces.\n\nNote: must be rendered inside of a SpacesContext."
|
|
],
|
|
"signature": [
|
|
"(props: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.CopyToSpaceFlyoutProps",
|
|
"text": "CopyToSpaceFlyoutProps"
|
|
},
|
|
") => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUiComponent.getCopyToSpaceFlyout.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUiComponent.getSpaceList",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSpaceList",
|
|
"description": [
|
|
"\nDisplays a corresponding list of spaces for a given list of saved object namespaces. It shows up to five spaces (and an indicator for\nany number of spaces that the user is not authorized to see) by default. If more than five named spaces would be displayed, the extras\n(along with the unauthorized spaces indicator, if present) are hidden behind a button. If '*' (aka \"All spaces\") is present, it\nsupersedes all of the above and just displays a single badge without a button.\n\nNote: must be rendered inside of a SpacesContext."
|
|
],
|
|
"signature": [
|
|
"(props: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.SpaceListProps",
|
|
"text": "SpaceListProps"
|
|
},
|
|
") => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUiComponent.getSpaceList.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUiComponent.getEmbeddableLegacyUrlConflict",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getEmbeddableLegacyUrlConflict",
|
|
"description": [
|
|
"\nDisplays a callout that needs to be used if an embeddable component call to `SavedObjectsClient.resolve()` results in an `\"conflict\"`\noutcome, which indicates that the user has loaded an embeddable which is associated directly with one object (A), *and* with a legacy\nURL that points to a different object (B)."
|
|
],
|
|
"signature": [
|
|
"(props: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.EmbeddableLegacyUrlConflictProps",
|
|
"text": "EmbeddableLegacyUrlConflictProps"
|
|
},
|
|
") => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUiComponent.getEmbeddableLegacyUrlConflict.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUiComponent.getLegacyUrlConflict",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getLegacyUrlConflict",
|
|
"description": [
|
|
"\nDisplays a callout that needs to be used if a call to `SavedObjectsClient.resolve()` results in an `\"conflict\"` outcome, which\nindicates that the user has loaded the page which is associated directly with one object (A), *and* with a legacy URL that points to a\ndifferent object (B).\n\nIn this case, `SavedObjectsClient.resolve()` has returned object A. This component displays a warning callout to the user explaining\nthat there is a conflict, and it includes a button that will redirect the user to object B when clicked.\n\nConsumers need to determine the local path for the new URL on their own, based on the object ID that was used to call\n`SavedObjectsClient.resolve()` (A) and the `alias_target_id` value in the response (B). For example...\n\nA is `workpad-123` and B is `workpad-e08b9bdb-ec14-4339-94c4-063bddfd610e`.\n\nFull legacy URL: `https://localhost:5601/app/canvas#/workpad/workpad-123/page/1`\n\nNew URL path: `#/workpad/workpad-e08b9bdb-ec14-4339-94c4-063bddfd610e/page/1`"
|
|
],
|
|
"signature": [
|
|
"(props: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.LegacyUrlConflictProps",
|
|
"text": "LegacyUrlConflictProps"
|
|
},
|
|
") => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUiComponent.getLegacyUrlConflict.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUiComponent.getSpaceAvatar",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSpaceAvatar",
|
|
"description": [
|
|
"\nDisplays an avatar for the given space."
|
|
],
|
|
"signature": [
|
|
"(props: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.SpaceAvatarProps",
|
|
"text": "SpaceAvatarProps"
|
|
},
|
|
") => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApiUiComponent.getSpaceAvatar.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesContextProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SpacesContextProps",
|
|
"description": [
|
|
"\nProperties for the SpacesContext."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/spaces_context/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesContextProps.feature",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "feature",
|
|
"description": [
|
|
"\nIf a feature is specified, all Spaces components will treat it appropriately if the feature is disabled in a given Space."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/spaces_context/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesData",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SpacesData",
|
|
"description": [
|
|
"\nThe structure for all of the space data that must be loaded for share-to-space components to function."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesData.spacesMap",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "spacesMap",
|
|
"description": [
|
|
"A map of each existing space's ID and its associated {@link SpacesDataEntry}."
|
|
],
|
|
"signature": [
|
|
"Map<string, ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.SpacesDataEntry",
|
|
"text": "SpacesDataEntry"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesData.activeSpaceId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "activeSpaceId",
|
|
"description": [
|
|
"The ID of the active space."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesDataEntry",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SpacesDataEntry",
|
|
"description": [
|
|
"\nThe data that was fetched for a specific space. Includes optional additional fields that are needed to handle edge cases in the\nshare-to-space components that consume it."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.SpacesDataEntry",
|
|
"text": "SpacesDataEntry"
|
|
},
|
|
" extends Pick<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetSpaceResult",
|
|
"text": "GetSpaceResult"
|
|
},
|
|
", \"color\" | \"id\" | \"description\" | \"name\" | \"initials\" | \"imageUrl\" | \"_reserved\">"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesDataEntry.isActiveSpace",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isActiveSpace",
|
|
"description": [
|
|
"True if this space is the active space."
|
|
],
|
|
"signature": [
|
|
"true | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesDataEntry.isFeatureDisabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isFeatureDisabled",
|
|
"description": [
|
|
"True if the current feature (specified in the `SpacesContext`) is disabled in this space."
|
|
],
|
|
"signature": [
|
|
"true | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesDataEntry.isAuthorizedForPurpose",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isAuthorizedForPurpose",
|
|
"description": [
|
|
"Returns true if the user is authorized for the given purpose."
|
|
],
|
|
"signature": [
|
|
"(purpose: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetAllSpacesPurpose",
|
|
"text": "GetAllSpacesPurpose"
|
|
},
|
|
") => boolean"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesDataEntry.isAuthorizedForPurpose.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "purpose",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetAllSpacesPurpose",
|
|
"text": "GetAllSpacesPurpose"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/types.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesReactContextValue",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SpacesReactContextValue",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.SpacesReactContextValue",
|
|
"text": "SpacesReactContextValue"
|
|
},
|
|
"<Services>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/spaces_context/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesReactContextValue.spacesManager",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "spacesManager",
|
|
"description": [],
|
|
"signature": [
|
|
"SpacesManager"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/spaces_context/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesReactContextValue.spacesDataPromise",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "spacesDataPromise",
|
|
"description": [],
|
|
"signature": [
|
|
"Promise<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.SpacesData",
|
|
"text": "SpacesData"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/spaces_context/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesReactContextValue.services",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "services",
|
|
"description": [],
|
|
"signature": [
|
|
"Services"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/spaces_context/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.GetAllSpacesPurpose",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "GetAllSpacesPurpose",
|
|
"description": [
|
|
"\nThe set of purposes to retrieve spaces:\n- `any`: retrieves all spaces the user is authorized to see.\n- `copySavedObjectsIntoSpace`: retrieves all spaces the user is authorized to copy saved objects into.\n- `findSavedObjects`: retrieves all spaces the user is authorized to search within.\n- `shareSavedObjectsIntoSpace`: retrieves all spaces the user is authorized to share saved objects into."
|
|
],
|
|
"signature": [
|
|
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\""
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.LazyComponentFn",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "LazyComponentFn",
|
|
"description": [
|
|
"\nFunction that returns a promise for a lazy-loadable component."
|
|
],
|
|
"signature": [
|
|
"(props: T) => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.LazyComponentFn.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "props",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesPluginSetup",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SpacesPluginSetup",
|
|
"description": [
|
|
"\nSetup contract for the Spaces plugin."
|
|
],
|
|
"signature": [
|
|
"{}"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/plugin.tsx",
|
|
"deprecated": false,
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApi",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SpacesApi",
|
|
"description": [
|
|
"\nClient-side Spaces API."
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApi.getActiveSpace$",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getActiveSpace$",
|
|
"description": [
|
|
"\nObservable representing the currently active space.\nThe details of the space can change without a full page reload (such as display name, color, etc.)"
|
|
],
|
|
"signature": [
|
|
"() => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApi.getActiveSpace",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getActiveSpace",
|
|
"description": [
|
|
"\nRetrieve the currently active space."
|
|
],
|
|
"signature": [
|
|
"() => Promise<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-public.SpacesApi.ui",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ui",
|
|
"description": [
|
|
"\nUI components and services to add spaces capabilities to an application."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "public",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-public.SpacesApiUi",
|
|
"text": "SpacesApiUi"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/public/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.addSpaceIdToPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addSpaceIdToPath",
|
|
"description": [
|
|
"\nGiven a server base path, space id, and requested resource, this will construct a space-aware path\nthat includes a URL identifier with the space id.\n"
|
|
],
|
|
"signature": [
|
|
"(basePath: string, spaceId: string, requestedPath: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.addSpaceIdToPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "basePath",
|
|
"description": [
|
|
"the server's base path."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.addSpaceIdToPath.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "spaceId",
|
|
"description": [
|
|
"the space id."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.addSpaceIdToPath.$3",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "requestedPath",
|
|
"description": [
|
|
"the requested path (e.g. `/app/dashboard`)."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"the space-aware version of the requested path, inclusive of the server's base path."
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.GetAllSpacesOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetAllSpacesOptions",
|
|
"description": [
|
|
"\nControls how spaces are retrieved."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.GetAllSpacesOptions.purpose",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"see"
|
|
],
|
|
"label": "purpose",
|
|
"description": [
|
|
"\nAn optional purpose describing how the set of spaces will be used.\nThe default purpose (`any`) will retrieve all spaces the user is authorized to see,\nwhereas a more specific purpose will retrieve all spaces the user is authorized to perform a specific action within.\n"
|
|
],
|
|
"signature": [
|
|
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.GetAllSpacesOptions.includeAuthorizedPurposes",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"see"
|
|
],
|
|
"label": "includeAuthorizedPurposes",
|
|
"description": [
|
|
"\nSet to true to return a set of flags indicating which purposes the user is authorized for.\n"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.GetSpaceResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetSpaceResult",
|
|
"description": [
|
|
"\nResponse format when querying for spaces."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetSpaceResult",
|
|
"text": "GetSpaceResult"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.GetSpaceResult.authorizedPurposes",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "authorizedPurposes",
|
|
"description": [
|
|
"\nA set of flags indicating which purposes the user is authorized for."
|
|
],
|
|
"signature": [
|
|
"Record<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetAllSpacesPurpose",
|
|
"text": "GetAllSpacesPurpose"
|
|
},
|
|
", boolean> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.ISpacesClient",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ISpacesClient",
|
|
"description": [
|
|
"\nClient interface for interacting with spaces."
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.ISpacesClient.getAll",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAll",
|
|
"description": [
|
|
"\nRetrieve all available spaces."
|
|
],
|
|
"signature": [
|
|
"(options?: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetAllSpacesOptions",
|
|
"text": "GetAllSpacesOptions"
|
|
},
|
|
" | undefined) => Promise<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetSpaceResult",
|
|
"text": "GetSpaceResult"
|
|
},
|
|
"[]>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.ISpacesClient.getAll.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"controls which spaces are retrieved."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetAllSpacesOptions",
|
|
"text": "GetAllSpacesOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.ISpacesClient.get",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "get",
|
|
"description": [
|
|
"\nRetrieve a space by its id."
|
|
],
|
|
"signature": [
|
|
"(id: string) => Promise<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.ISpacesClient.get.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"the space id."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.ISpacesClient.create",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "create",
|
|
"description": [
|
|
"\nCreates a space."
|
|
],
|
|
"signature": [
|
|
"(space: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.ISpacesClient.create.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "space",
|
|
"description": [
|
|
"the space to create."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.ISpacesClient.update",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "update",
|
|
"description": [
|
|
"\nUpdates a space."
|
|
],
|
|
"signature": [
|
|
"(id: string, space: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.ISpacesClient.update.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"the id of the space to update."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.ISpacesClient.update.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "space",
|
|
"description": [
|
|
"the updated space."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.ISpacesClient.delete",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "delete",
|
|
"description": [
|
|
"\nDeletes a space, and all saved objects belonging to that space."
|
|
],
|
|
"signature": [
|
|
"(id: string) => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.ISpacesClient.delete.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"the id of the space to delete."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.ISpacesClient.disableLegacyUrlAliases",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "disableLegacyUrlAliases",
|
|
"description": [
|
|
"\nDisables the specified legacy URL aliases."
|
|
],
|
|
"signature": [
|
|
"(aliases: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.LegacyUrlAliasTarget",
|
|
"text": "LegacyUrlAliasTarget"
|
|
},
|
|
"[]) => Promise<void>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.ISpacesClient.disableLegacyUrlAliases.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "aliases",
|
|
"description": [
|
|
"the aliases to disable."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.LegacyUrlAliasTarget",
|
|
"text": "LegacyUrlAliasTarget"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.LegacyUrlAliasTarget",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LegacyUrlAliasTarget",
|
|
"description": [
|
|
"\nClient interface for interacting with legacy URL aliases."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.LegacyUrlAliasTarget.targetSpace",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "targetSpace",
|
|
"description": [
|
|
"\nThe namespace that the object existed in when it was converted."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.LegacyUrlAliasTarget.targetType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "targetType",
|
|
"description": [
|
|
"\nThe type of the object when it was converted."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.LegacyUrlAliasTarget.sourceId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sourceId",
|
|
"description": [
|
|
"\nThe original ID of the object, before it was converted."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.Space",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Space",
|
|
"description": [
|
|
"\nA Space."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.Space.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nThe unique identifier for this space.\nThe id becomes part of the \"URL Identifier\" of the space.\n\nExample: an id of `marketing` would result in the URL identifier of `/s/marketing`."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.Space.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"\nDisplay name for this space."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.Space.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [
|
|
"\nOptional description for this space."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.Space.color",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "color",
|
|
"description": [
|
|
"\nOptional color (hex code) for this space.\nIf neither `color` nor `imageUrl` is specified, then a color will be automatically generated."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.Space.initials",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "initials",
|
|
"description": [
|
|
"\nOptional display initials for this space's avatar. Supports a maximum of 2 characters.\nIf initials are not provided, then they will be derived from the space name automatically.\n\nInitials are not displayed if an `imageUrl` has been specified."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.Space.imageUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "imageUrl",
|
|
"description": [
|
|
"\nOptional base-64 encoded data image url to show as this space's avatar.\nThis setting takes precedence over any configured `color` or `initials`."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.Space.disabledFeatures",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "disabledFeatures",
|
|
"description": [
|
|
"\nThe set of feature ids that should be hidden within this space."
|
|
],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.Space._reserved",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"private"
|
|
],
|
|
"label": "_reserved",
|
|
"description": [
|
|
"\nIndicates that this space is reserved (system controlled).\nReserved spaces cannot be created or deleted by end-users."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SpacesServiceSetup",
|
|
"description": [
|
|
"\nThe Spaces service setup contract."
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceSetup.getSpaceId",
|
|
"type": "Function",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "getSpaceId",
|
|
"description": [
|
|
"\nRetrieves the space id associated with the provided request."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": true,
|
|
"removeBy": "7.16",
|
|
"references": [
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/audit/audit_service.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_privileges_dynamically.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "reporting",
|
|
"path": "x-pack/plugins/reporting/server/core.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/server/routes/data_view.ts"
|
|
},
|
|
{
|
|
"plugin": "infra",
|
|
"path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts"
|
|
},
|
|
{
|
|
"plugin": "infra",
|
|
"path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts"
|
|
},
|
|
{
|
|
"plugin": "infra",
|
|
"path": "x-pack/plugins/infra/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/request_context_factory.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/request_context_factory.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_privileges_dynamically.test.ts"
|
|
}
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceSetup.getSpaceId.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [
|
|
"the request."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceSetup.spaceIdToNamespace",
|
|
"type": "Function",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "spaceIdToNamespace",
|
|
"description": [
|
|
"\nConverts the provided space id into the corresponding Saved Objects `namespace` id."
|
|
],
|
|
"signature": [
|
|
"(spaceId: string) => string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": true,
|
|
"removeBy": "7.16",
|
|
"references": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceSetup.spaceIdToNamespace.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "spaceId",
|
|
"description": [
|
|
"the space id to convert."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceSetup.namespaceToSpaceId",
|
|
"type": "Function",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "namespaceToSpaceId",
|
|
"description": [
|
|
"\nConverts the provided namespace into the corresponding space id."
|
|
],
|
|
"signature": [
|
|
"(namespace: string | undefined) => string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": true,
|
|
"removeBy": "7.16",
|
|
"references": [
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/saved_objects/secure_saved_objects_client_wrapper.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/saved_objects/secure_saved_objects_client_wrapper.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/saved_objects/secure_saved_objects_client_wrapper.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_privileges_dynamically.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts"
|
|
}
|
|
],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceSetup.namespaceToSpaceId.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [
|
|
"the namespace to convert."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SpacesServiceStart",
|
|
"description": [
|
|
"\nThe Spaces service start contract."
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceStart.createSpacesClient",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createSpacesClient",
|
|
"description": [
|
|
"\nCreates a scoped instance of the SpacesClient."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "server",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-server.ISpacesClient",
|
|
"text": "ISpacesClient"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceStart.createSpacesClient.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [
|
|
"the request."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceStart.getSpaceId",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSpaceId",
|
|
"description": [
|
|
"\nRetrieves the space id associated with the provided request."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceStart.getSpaceId.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [
|
|
"the request."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceStart.isInDefaultSpace",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isInDefaultSpace",
|
|
"description": [
|
|
"\nIndicates if the provided request is executing within the context of the `default` space."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceStart.isInDefaultSpace.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [
|
|
"the request."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceStart.getActiveSpace",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getActiveSpace",
|
|
"description": [
|
|
"\nRetrieves the Space associated with the provided request."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => Promise<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
">"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceStart.getActiveSpace.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [
|
|
"the request."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceStart.spaceIdToNamespace",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "spaceIdToNamespace",
|
|
"description": [
|
|
"\nConverts the provided space id into the corresponding Saved Objects `namespace` id."
|
|
],
|
|
"signature": [
|
|
"(spaceId: string) => string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceStart.spaceIdToNamespace.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "spaceId",
|
|
"description": [
|
|
"the space id to convert."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceStart.namespaceToSpaceId",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "namespaceToSpaceId",
|
|
"description": [
|
|
"\nConverts the provided namespace into the corresponding space id."
|
|
],
|
|
"signature": [
|
|
"(namespace: string | undefined) => string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesServiceStart.namespaceToSpaceId.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "namespace",
|
|
"description": [
|
|
"the namespace to convert."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.GetAllSpacesPurpose",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "GetAllSpacesPurpose",
|
|
"description": [
|
|
"\nThe set of purposes to retrieve spaces:\n- `any`: retrieves all spaces the user is authorized to see.\n- `copySavedObjectsIntoSpace`: retrieves all spaces the user is authorized to copy saved objects into.\n- `findSavedObjects`: retrieves all spaces the user is authorized to search within.\n- `shareSavedObjectsIntoSpace`: retrieves all spaces the user is authorized to share saved objects into."
|
|
],
|
|
"signature": [
|
|
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\""
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesClientRepositoryFactory",
|
|
"type": "Type",
|
|
"tags": [
|
|
"private"
|
|
],
|
|
"label": "SpacesClientRepositoryFactory",
|
|
"description": [
|
|
"\nFor consumption by the security plugin only."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>, savedObjectsStart: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsServiceStart",
|
|
"text": "SavedObjectsServiceStart"
|
|
},
|
|
") => Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsRepository",
|
|
"text": "SavedObjectsRepository"
|
|
},
|
|
", \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"delete\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"bulkResolve\" | \"get\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesClientRepositoryFactory.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesClientRepositoryFactory.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "savedObjectsStart",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsServiceStart",
|
|
"text": "SavedObjectsServiceStart"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesClientWrapper",
|
|
"type": "Type",
|
|
"tags": [
|
|
"private"
|
|
],
|
|
"label": "SpacesClientWrapper",
|
|
"description": [
|
|
"\nFor consumption by the security plugin only."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>, baseClient: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "server",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-server.ISpacesClient",
|
|
"text": "ISpacesClient"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "server",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-server.ISpacesClient",
|
|
"text": "ISpacesClient"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts",
|
|
"deprecated": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesClientWrapper.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreHttpPluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesClientWrapper.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "baseClient",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "server",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-server.ISpacesClient",
|
|
"text": "ISpacesClient"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesPluginSetup",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SpacesPluginSetup",
|
|
"description": [
|
|
"\nSetup contract for the Spaces plugin."
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesPluginSetup.spacesService",
|
|
"type": "Object",
|
|
"tags": [
|
|
"deprecated"
|
|
],
|
|
"label": "spacesService",
|
|
"description": [
|
|
"\nService for interacting with spaces.\n"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "server",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-server.SpacesServiceSetup",
|
|
"text": "SpacesServiceSetup"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/plugin.ts",
|
|
"deprecated": true,
|
|
"removeBy": "7.16",
|
|
"references": [
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "security",
|
|
"path": "x-pack/plugins/security/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "reporting",
|
|
"path": "x-pack/plugins/reporting/server/core.ts"
|
|
},
|
|
{
|
|
"plugin": "reporting",
|
|
"path": "x-pack/plugins/reporting/server/core.ts"
|
|
},
|
|
{
|
|
"plugin": "reporting",
|
|
"path": "x-pack/plugins/reporting/server/core.ts"
|
|
},
|
|
{
|
|
"plugin": "apm",
|
|
"path": "x-pack/plugins/apm/server/routes/data_view.ts"
|
|
},
|
|
{
|
|
"plugin": "infra",
|
|
"path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts"
|
|
},
|
|
{
|
|
"plugin": "infra",
|
|
"path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts"
|
|
},
|
|
{
|
|
"plugin": "infra",
|
|
"path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts"
|
|
},
|
|
{
|
|
"plugin": "infra",
|
|
"path": "x-pack/plugins/infra/server/plugin.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/request_context_factory.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/request_context_factory.ts"
|
|
},
|
|
{
|
|
"plugin": "securitySolution",
|
|
"path": "x-pack/plugins/security_solution/server/plugin.ts"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesPluginSetup.spacesClient",
|
|
"type": "Object",
|
|
"tags": [
|
|
"private"
|
|
],
|
|
"label": "spacesClient",
|
|
"description": [
|
|
"\nRegistries exposed for the security plugin to transparently provide authorization and audit logging."
|
|
],
|
|
"signature": [
|
|
"{ setClientRepositoryFactory: (factory: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "server",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-server.SpacesClientRepositoryFactory",
|
|
"text": "SpacesClientRepositoryFactory"
|
|
},
|
|
") => void; registerClientWrapper: (wrapper: ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "server",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-server.SpacesClientWrapper",
|
|
"text": "SpacesClientWrapper"
|
|
},
|
|
") => void; }"
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/plugin.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesPluginStart",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SpacesPluginStart",
|
|
"description": [
|
|
"\nStart contract for the Spaces plugin."
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-server.SpacesPluginStart.spacesService",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "spacesService",
|
|
"description": [
|
|
"Service for interacting with spaces."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "server",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-server.SpacesServiceStart",
|
|
"text": "SpacesServiceStart"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/server/plugin.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.addSpaceIdToPath",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "addSpaceIdToPath",
|
|
"description": [
|
|
"\nGiven a server base path, space id, and requested resource, this will construct a space-aware path\nthat includes a URL identifier with the space id.\n"
|
|
],
|
|
"signature": [
|
|
"(basePath: string, spaceId: string, requestedPath: string) => string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.addSpaceIdToPath.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "basePath",
|
|
"description": [
|
|
"the server's base path."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.addSpaceIdToPath.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "spaceId",
|
|
"description": [
|
|
"the space id."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.addSpaceIdToPath.$3",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "requestedPath",
|
|
"description": [
|
|
"the requested path (e.g. `/app/dashboard`)."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"the space-aware version of the requested path, inclusive of the server's base path."
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.getSpaceIdFromPath",
|
|
"type": "Function",
|
|
"tags": [
|
|
"private"
|
|
],
|
|
"label": "getSpaceIdFromPath",
|
|
"description": [
|
|
"\nExtracts the space id from the given path.\n"
|
|
],
|
|
"signature": [
|
|
"(requestBasePath: string | null | undefined, serverBasePath: string | null | undefined) => { spaceId: string; pathHasExplicitSpaceIdentifier: boolean; }"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.getSpaceIdFromPath.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "requestBasePath",
|
|
"description": [
|
|
"The base path of the current request."
|
|
],
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.getSpaceIdFromPath.$2",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "serverBasePath",
|
|
"description": [
|
|
"The server's base path."
|
|
],
|
|
"signature": [
|
|
"string | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"the space id."
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.isReservedSpace",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isReservedSpace",
|
|
"description": [
|
|
"\nReturns whether the given Space is reserved or not.\n"
|
|
],
|
|
"signature": [
|
|
"(space: Partial<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
"> | null | undefined) => boolean"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/is_reserved_space.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.isReservedSpace.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "space",
|
|
"description": [
|
|
"the space"
|
|
],
|
|
"signature": [
|
|
"Partial<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
},
|
|
"> | null | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/is_reserved_space.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"boolean"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.GetAllSpacesOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetAllSpacesOptions",
|
|
"description": [
|
|
"\nControls how spaces are retrieved."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.GetAllSpacesOptions.purpose",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"see"
|
|
],
|
|
"label": "purpose",
|
|
"description": [
|
|
"\nAn optional purpose describing how the set of spaces will be used.\nThe default purpose (`any`) will retrieve all spaces the user is authorized to see,\nwhereas a more specific purpose will retrieve all spaces the user is authorized to perform a specific action within.\n"
|
|
],
|
|
"signature": [
|
|
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\" | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.GetAllSpacesOptions.includeAuthorizedPurposes",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"see"
|
|
],
|
|
"label": "includeAuthorizedPurposes",
|
|
"description": [
|
|
"\nSet to true to return a set of flags indicating which purposes the user is authorized for.\n"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.GetSpaceResult",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetSpaceResult",
|
|
"description": [
|
|
"\nResponse format when querying for spaces."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetSpaceResult",
|
|
"text": "GetSpaceResult"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.Space",
|
|
"text": "Space"
|
|
}
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.GetSpaceResult.authorizedPurposes",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "authorizedPurposes",
|
|
"description": [
|
|
"\nA set of flags indicating which purposes the user is authorized for."
|
|
],
|
|
"signature": [
|
|
"Record<",
|
|
{
|
|
"pluginId": "spaces",
|
|
"scope": "common",
|
|
"docId": "kibSpacesPluginApi",
|
|
"section": "def-common.GetAllSpacesPurpose",
|
|
"text": "GetAllSpacesPurpose"
|
|
},
|
|
", boolean> | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.LegacyUrlAliasTarget",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "LegacyUrlAliasTarget",
|
|
"description": [
|
|
"\nClient interface for interacting with legacy URL aliases."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.LegacyUrlAliasTarget.targetSpace",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "targetSpace",
|
|
"description": [
|
|
"\nThe namespace that the object existed in when it was converted."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.LegacyUrlAliasTarget.targetType",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "targetType",
|
|
"description": [
|
|
"\nThe type of the object when it was converted."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.LegacyUrlAliasTarget.sourceId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "sourceId",
|
|
"description": [
|
|
"\nThe original ID of the object, before it was converted."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.Space",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Space",
|
|
"description": [
|
|
"\nA Space."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.Space.id",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [
|
|
"\nThe unique identifier for this space.\nThe id becomes part of the \"URL Identifier\" of the space.\n\nExample: an id of `marketing` would result in the URL identifier of `/s/marketing`."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.Space.name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "name",
|
|
"description": [
|
|
"\nDisplay name for this space."
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.Space.description",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [
|
|
"\nOptional description for this space."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.Space.color",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "color",
|
|
"description": [
|
|
"\nOptional color (hex code) for this space.\nIf neither `color` nor `imageUrl` is specified, then a color will be automatically generated."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.Space.initials",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "initials",
|
|
"description": [
|
|
"\nOptional display initials for this space's avatar. Supports a maximum of 2 characters.\nIf initials are not provided, then they will be derived from the space name automatically.\n\nInitials are not displayed if an `imageUrl` has been specified."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.Space.imageUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "imageUrl",
|
|
"description": [
|
|
"\nOptional base-64 encoded data image url to show as this space's avatar.\nThis setting takes precedence over any configured `color` or `initials`."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.Space.disabledFeatures",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "disabledFeatures",
|
|
"description": [
|
|
"\nThe set of feature ids that should be hidden within this space."
|
|
],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.Space._reserved",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"private"
|
|
],
|
|
"label": "_reserved",
|
|
"description": [
|
|
"\nIndicates that this space is reserved (system controlled).\nReserved spaces cannot be created or deleted by end-users."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.ENTER_SPACE_PATH",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ENTER_SPACE_PATH",
|
|
"description": [
|
|
"\nThe path to enter a space."
|
|
],
|
|
"signature": [
|
|
"\"/spaces/enter\""
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.GetAllSpacesPurpose",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "GetAllSpacesPurpose",
|
|
"description": [
|
|
"\nThe set of purposes to retrieve spaces:\n- `any`: retrieves all spaces the user is authorized to see.\n- `copySavedObjectsIntoSpace`: retrieves all spaces the user is authorized to copy saved objects into.\n- `findSavedObjects`: retrieves all spaces the user is authorized to search within.\n- `shareSavedObjectsIntoSpace`: retrieves all spaces the user is authorized to share saved objects into."
|
|
],
|
|
"signature": [
|
|
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\""
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/types.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.MAX_SPACE_INITIALS",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "MAX_SPACE_INITIALS",
|
|
"description": [
|
|
"\nThe maximum number of characters allowed in the Space Avatar's initials"
|
|
],
|
|
"signature": [
|
|
"2"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "spaces",
|
|
"id": "def-common.SPACE_SEARCH_COUNT_THRESHOLD",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "SPACE_SEARCH_COUNT_THRESHOLD",
|
|
"description": [
|
|
"\nThe minimum number of spaces required to show a search control."
|
|
],
|
|
"signature": [
|
|
"8"
|
|
],
|
|
"path": "x-pack/plugins/spaces/common/constants.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |