2021-03-03 04:02:17 +01:00
{
"id" : "spaces" ,
"client" : {
"classes" : [ ] ,
"functions" : [
{
"id" : "def-public.getSpaceColor" ,
"type" : "Function" ,
"label" : "getSpaceColor" ,
"signature" : [
"(space: Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">) => string"
] ,
"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"
] ,
"children" : [
{
"type" : "Object" ,
"label" : "space" ,
"isRequired" : true ,
"signature" : [
"Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 24
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 24
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.getSpaceImageUrl" ,
"type" : "Function" ,
"label" : "getSpaceImageUrl" ,
"signature" : [
"(space: Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">) => string"
] ,
"description" : [
"\nDetermines the avatar image for the provided space.\n"
] ,
"children" : [
{
"type" : "Object" ,
"label" : "space" ,
"isRequired" : true ,
"signature" : [
"Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 64
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 64
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.getSpaceInitials" ,
"type" : "Function" ,
"label" : "getSpaceInitials" ,
"signature" : [
"(space: Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">) => string"
] ,
"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"
] ,
"children" : [
{
"type" : "Object" ,
"label" : "space" ,
"isRequired" : true ,
"signature" : [
"Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 43
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 43
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"interfaces" : [
{
"id" : "def-public.GetSpaceResult" ,
"type" : "Interface" ,
"label" : "GetSpaceResult" ,
"signature" : [
{
"pluginId" : "spaces" ,
"scope" : "common" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-common.GetSpaceResult" ,
"text" : "GetSpaceResult"
} ,
" extends " ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
}
] ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.GetSpaceResult.authorizedPurposes" ,
"type" : "Object" ,
"label" : "authorizedPurposes" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 22
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"Record<" ,
{
"pluginId" : "spaces" ,
"scope" : "common" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-common.GetAllSpacesPurpose" ,
"text" : "GetAllSpacesPurpose"
} ,
", boolean> | undefined"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 21
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-public.Space" ,
"type" : "Interface" ,
"label" : "Space" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-public.Space.id" ,
"type" : "string" ,
"label" : "id" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 10
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.Space.name" ,
"type" : "string" ,
"label" : "name" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 11
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.Space.description" ,
"type" : "string" ,
"label" : "description" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 12
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.Space.color" ,
"type" : "string" ,
"label" : "color" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 13
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.Space.initials" ,
"type" : "string" ,
"label" : "initials" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 14
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.Space.disabledFeatures" ,
"type" : "Array" ,
"label" : "disabledFeatures" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string[]"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.Space._reserved" ,
"type" : "CompoundType" ,
"label" : "_reserved" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 16
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"boolean | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-public.Space.imageUrl" ,
"type" : "string" ,
"label" : "imageUrl" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 17
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"string | undefined"
]
}
] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 9
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [
{
"id" : "def-public.GetAllSpacesPurpose" ,
"type" : "Type" ,
"label" : "GetAllSpacesPurpose" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\""
] ,
"initialIsOpen" : false
}
] ,
"objects" : [ ] ,
"setup" : {
"id" : "def-public.SpacesPluginSetup" ,
"type" : "Type" ,
"label" : "SpacesPluginSetup" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/public/plugin.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 39
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"{}"
] ,
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
"id" : "def-public.SpacesPluginStart" ,
"type" : "Type" ,
"label" : "SpacesPluginStart" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/public/plugin.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 40
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"SpacesApi"
] ,
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"server" : {
"classes" : [ ] ,
"functions" : [
{
"id" : "def-server.addSpaceIdToPath" ,
"type" : "Function" ,
"label" : "addSpaceIdToPath" ,
"signature" : [
"(basePath: string, spaceId: string, requestedPath: string) => string"
] ,
"description" : [ ] ,
"children" : [
{
"type" : "string" ,
"label" : "basePath" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 44
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "string" ,
"label" : "spaceId" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 45
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "string" ,
"label" : "requestedPath" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 46
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 43
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"interfaces" : [
2021-03-06 02:12:28 +01:00
{
"id" : "def-server.GetAllSpacesOptions" ,
"type" : "Interface" ,
"label" : "GetAllSpacesOptions" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-server.GetAllSpacesOptions.purpose" ,
"type" : "CompoundType" ,
"label" : "purpose" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 11
} ,
"signature" : [
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\" | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.GetAllSpacesOptions.includeAuthorizedPurposes" ,
"type" : "CompoundType" ,
"label" : "includeAuthorizedPurposes" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 12
} ,
"signature" : [
"boolean | undefined"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 10
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-server.GetSpaceResult" ,
"type" : "Interface" ,
"label" : "GetSpaceResult" ,
"signature" : [
{
"pluginId" : "spaces" ,
"scope" : "common" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-common.GetSpaceResult" ,
"text" : "GetSpaceResult"
} ,
" extends " ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
}
] ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-server.GetSpaceResult.authorizedPurposes" ,
"type" : "Object" ,
"label" : "authorizedPurposes" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 22
} ,
"signature" : [
"Record<" ,
{
"pluginId" : "spaces" ,
"scope" : "common" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-common.GetAllSpacesPurpose" ,
"text" : "GetAllSpacesPurpose"
} ,
", boolean> | undefined"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 21
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-server.Space" ,
"type" : "Interface" ,
"label" : "Space" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-server.Space.id" ,
"type" : "string" ,
"label" : "id" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
"lineNumber" : 10
}
} ,
{
"tags" : [ ] ,
"id" : "def-server.Space.name" ,
"type" : "string" ,
"label" : "name" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
"lineNumber" : 11
}
} ,
{
"tags" : [ ] ,
"id" : "def-server.Space.description" ,
"type" : "string" ,
"label" : "description" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
"lineNumber" : 12
} ,
"signature" : [
"string | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.Space.color" ,
"type" : "string" ,
"label" : "color" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
"lineNumber" : 13
} ,
"signature" : [
"string | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.Space.initials" ,
"type" : "string" ,
"label" : "initials" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
"lineNumber" : 14
} ,
"signature" : [
"string | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.Space.disabledFeatures" ,
"type" : "Array" ,
"label" : "disabledFeatures" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
"lineNumber" : 15
} ,
"signature" : [
"string[]"
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.Space._reserved" ,
"type" : "CompoundType" ,
"label" : "_reserved" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
"lineNumber" : 16
} ,
"signature" : [
"boolean | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.Space.imageUrl" ,
"type" : "string" ,
"label" : "imageUrl" ,
"description" : [ ] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
"lineNumber" : 17
} ,
"signature" : [
"string | undefined"
]
}
] ,
"source" : {
"path" : "src/plugins/spaces_oss/common/types.ts" ,
"lineNumber" : 9
} ,
"initialIsOpen" : false
} ,
2021-03-03 04:02:17 +01:00
{
"id" : "def-server.SpacesServiceSetup" ,
"type" : "Interface" ,
"label" : "SpacesServiceSetup" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"id" : "def-server.SpacesServiceSetup.getSpaceId" ,
"type" : "Function" ,
"label" : "getSpaceId" ,
"signature" : [
"(request: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>) => string"
] ,
"description" : [
"\nRetrieves the space id associated with the provided request."
] ,
"children" : [
{
"type" : "Object" ,
"label" : "request" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 23
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [
"deprecated"
] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 23
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-server.SpacesServiceSetup.spaceIdToNamespace" ,
"type" : "Function" ,
"label" : "spaceIdToNamespace" ,
"signature" : [
"(spaceId: string) => string | undefined"
] ,
"description" : [
"\nConverts the provided space id into the corresponding Saved Objects `namespace` id."
] ,
"children" : [
{
"type" : "string" ,
"label" : "spaceId" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 31
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [
"deprecated"
] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 31
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-server.SpacesServiceSetup.namespaceToSpaceId" ,
"type" : "Function" ,
"label" : "namespaceToSpaceId" ,
"signature" : [
"(namespace: string | undefined) => string"
] ,
"description" : [
"\nConverts the provided namespace into the corresponding space id."
] ,
"children" : [
{
"type" : "string" ,
"label" : "namespace" ,
"isRequired" : false ,
"signature" : [
"string | undefined"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 39
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [
"deprecated"
] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 39
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 16
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-server.SpacesServiceStart" ,
"type" : "Interface" ,
"label" : "SpacesServiceStart" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-server.SpacesServiceStart.createSpacesClient" ,
"type" : "Function" ,
"label" : "createSpacesClient" ,
"description" : [
"\nCreates a scoped instance of the SpacesClient."
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 46
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"(request: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>) => Pick<" ,
{
"pluginId" : "spaces" ,
"scope" : "server" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-server.SpacesClient" ,
"text" : "SpacesClient"
} ,
", \"get\" | \"delete\" | \"create\" | \"update\" | \"getAll\">"
]
} ,
{
"id" : "def-server.SpacesServiceStart.getSpaceId" ,
"type" : "Function" ,
"label" : "getSpaceId" ,
"signature" : [
"(request: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>) => string"
] ,
"description" : [
"\nRetrieves the space id associated with the provided request."
] ,
"children" : [
{
"type" : "Object" ,
"label" : "request" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 52
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 52
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-server.SpacesServiceStart.isInDefaultSpace" ,
"type" : "Function" ,
"label" : "isInDefaultSpace" ,
"signature" : [
"(request: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>) => boolean"
] ,
"description" : [
"\nIndicates if the provided request is executing within the context of the `default` space."
] ,
"children" : [
{
"type" : "Object" ,
"label" : "request" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 58
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 58
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-server.SpacesServiceStart.getActiveSpace" ,
"type" : "Function" ,
"label" : "getActiveSpace" ,
"signature" : [
"(request: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>) => Promise<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
">"
] ,
"description" : [
"\nRetrieves the Space associated with the provided request."
] ,
"children" : [
{
"type" : "Object" ,
"label" : "request" ,
"isRequired" : true ,
"signature" : [
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 64
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 64
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-server.SpacesServiceStart.spaceIdToNamespace" ,
"type" : "Function" ,
"label" : "spaceIdToNamespace" ,
"signature" : [
"(spaceId: string) => string | undefined"
] ,
"description" : [
"\nConverts the provided space id into the corresponding Saved Objects `namespace` id."
] ,
"children" : [
{
"type" : "string" ,
"label" : "spaceId" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 70
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 70
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-server.SpacesServiceStart.namespaceToSpaceId" ,
"type" : "Function" ,
"label" : "namespaceToSpaceId" ,
"signature" : [
"(namespace: string | undefined) => string"
] ,
"description" : [
"\nConverts the provided namespace into the corresponding space id."
] ,
"children" : [
{
"type" : "string" ,
"label" : "namespace" ,
"isRequired" : false ,
"signature" : [
"string | undefined"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 76
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 76
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 42
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
2021-03-06 02:12:28 +01:00
}
] ,
"enums" : [ ] ,
"misc" : [
2021-03-03 04:02:17 +01:00
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.GetAllSpacesPurpose" ,
"type" : "Type" ,
"label" : "GetAllSpacesPurpose" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
} ,
2021-03-06 02:12:28 +01:00
"signature" : [
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\""
] ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.ISpacesClient" ,
"type" : "Type" ,
"label" : "ISpacesClient" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts" ,
"lineNumber" : 27
} ,
2021-03-03 04:02:17 +01:00
"signature" : [
"{ get: (id: string) => Promise<Space>; delete: (id: string) => Promise<void>; create: (space: Space) => Promise<Space>; update: (id: string, space: Space) => Promise<Space>; getAll: (options?: GetAllSpacesOptions) => Promise<GetSpaceResult[]>; }"
] ,
"initialIsOpen" : false
}
] ,
"objects" : [ ] ,
"setup" : {
"id" : "def-server.SpacesPluginSetup" ,
"type" : "Interface" ,
"label" : "SpacesPluginSetup" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-server.SpacesPluginSetup.spacesService" ,
"type" : "Object" ,
"label" : "spacesService" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 55
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "spaces" ,
"scope" : "server" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-server.SpacesServiceSetup" ,
"text" : "SpacesServiceSetup"
}
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.SpacesPluginSetup.spacesClient" ,
"type" : "Object" ,
"label" : "spacesClient" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 56
2021-03-03 04:02:17 +01:00
} ,
"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; }"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 54
2021-03-03 04:02:17 +01:00
} ,
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
"id" : "def-server.SpacesPluginStart" ,
"type" : "Interface" ,
"label" : "SpacesPluginStart" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-server.SpacesPluginStart.spacesService" ,
"type" : "Object" ,
"label" : "spacesService" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 63
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "spaces" ,
"scope" : "server" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-server.SpacesServiceStart" ,
"text" : "SpacesServiceStart"
}
]
}
] ,
"source" : {
"path" : "x-pack/plugins/spaces/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 62
2021-03-03 04:02:17 +01:00
} ,
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"common" : {
"classes" : [ ] ,
"functions" : [
{
"id" : "def-common.addSpaceIdToPath" ,
"type" : "Function" ,
"label" : "addSpaceIdToPath" ,
"signature" : [
"(basePath: string, spaceId: string, requestedPath: string) => string"
] ,
"description" : [ ] ,
"children" : [
{
"type" : "string" ,
"label" : "basePath" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 44
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "string" ,
"label" : "spaceId" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 45
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "string" ,
"label" : "requestedPath" ,
"isRequired" : true ,
"signature" : [
"string"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 46
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 43
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.getSpaceIdFromPath" ,
"type" : "Function" ,
"label" : "getSpaceIdFromPath" ,
"signature" : [
"(requestBasePath: string | null | undefined, serverBasePath: string | null | undefined) => { spaceId: string; pathHasExplicitSpaceIdentifier: boolean; }"
] ,
"description" : [ ] ,
"children" : [
{
"type" : "CompoundType" ,
"label" : "requestBasePath" ,
"isRequired" : false ,
"signature" : [
"string | null | undefined"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 13
2021-03-03 04:02:17 +01:00
}
} ,
{
"type" : "CompoundType" ,
"label" : "serverBasePath" ,
"isRequired" : false ,
"signature" : [
"string | null | undefined"
] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 14
2021-03-03 04:02:17 +01:00
}
}
] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 12
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.isReservedSpace" ,
"type" : "Function" ,
"label" : "isReservedSpace" ,
"signature" : [
"(space: Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
"> | null | undefined) => boolean"
] ,
"description" : [
"\nReturns whether the given Space is reserved or not.\n"
] ,
"children" : [
{
"type" : "CompoundType" ,
"label" : "space" ,
"isRequired" : false ,
"signature" : [
"Partial<" ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
} ,
"> | null | undefined"
] ,
"description" : [
"the space"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/is_reserved_space.ts" ,
"lineNumber" : 18
}
}
] ,
"tags" : [ ] ,
"returnComment" : [
"boolean"
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/is_reserved_space.ts" ,
"lineNumber" : 18
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"interfaces" : [
{
"id" : "def-common.GetAllSpacesOptions" ,
"type" : "Interface" ,
"label" : "GetAllSpacesOptions" ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-common.GetAllSpacesOptions.purpose" ,
"type" : "CompoundType" ,
"label" : "purpose" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 11
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\" | undefined"
]
} ,
{
"tags" : [ ] ,
"id" : "def-common.GetAllSpacesOptions.includeAuthorizedPurposes" ,
"type" : "CompoundType" ,
"label" : "includeAuthorizedPurposes" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 12
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"boolean | undefined"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 10
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
"id" : "def-common.GetSpaceResult" ,
"type" : "Interface" ,
"label" : "GetSpaceResult" ,
"signature" : [
{
"pluginId" : "spaces" ,
"scope" : "common" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-common.GetSpaceResult" ,
"text" : "GetSpaceResult"
} ,
" extends " ,
{
"pluginId" : "spacesOss" ,
"scope" : "common" ,
"docId" : "kibSpacesOssPluginApi" ,
"section" : "def-common.Space" ,
"text" : "Space"
}
] ,
"description" : [ ] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
"id" : "def-common.GetSpaceResult.authorizedPurposes" ,
"type" : "Object" ,
"label" : "authorizedPurposes" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 22
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"Record<" ,
{
"pluginId" : "spaces" ,
"scope" : "common" ,
"docId" : "kibSpacesPluginApi" ,
"section" : "def-common.GetAllSpacesPurpose" ,
"text" : "GetAllSpacesPurpose"
} ,
", boolean> | undefined"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/types.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 21
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.ENTER_SPACE_PATH" ,
"type" : "string" ,
"label" : "ENTER_SPACE_PATH" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe path to enter a space."
2021-03-03 04:02:17 +01:00
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/constants.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 33
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"\"/spaces/enter\""
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-common.GetAllSpacesPurpose" ,
"type" : "Type" ,
"label" : "GetAllSpacesPurpose" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/spaces/common/types.ts" ,
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\""
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.MAX_SPACE_INITIALS" ,
"type" : "number" ,
"label" : "MAX_SPACE_INITIALS" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe maximum number of characters allowed in the Space Avatar's initials"
2021-03-03 04:02:17 +01:00
] ,
"source" : {
"path" : "x-pack/plugins/spaces/common/constants.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 28
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"2"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-common.SPACE_SEARCH_COUNT_THRESHOLD" ,
"type" : "number" ,
"label" : "SPACE_SEARCH_COUNT_THRESHOLD" ,
"description" : [
"\nThe minimum number of spaces required to show a search control."
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/spaces/common/constants.ts" ,
"lineNumber" : 23
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"8"
2021-03-03 04:02:17 +01:00
] ,
"initialIsOpen" : false
}
] ,
"objects" : [ ]
}
}