github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/share.devdocs.json

2968 lines
No EOL
104 KiB
JSON
Raw Blame History

{
"id": "share",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "share",
"id": "def-public.downloadFileAs",
"type": "Function",
"tags": [],
"label": "downloadFileAs",
"description": [
"\nConvenient method to use for a single file download\n**Note**: for multiple files use the downloadMultipleAs method, do not iterate with this method here"
],
"signature": [
"(filename: string, payload: ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.DownloadableContent",
"text": "DownloadableContent"
},
") => Promise<void>"
],
"path": "src/platform/plugins/shared/share/public/lib/download_as.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.downloadFileAs.$1",
"type": "string",
"tags": [],
"label": "filename",
"description": [
"full name of the file"
],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/share/public/lib/download_as.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "share",
"id": "def-public.downloadFileAs.$2",
"type": "CompoundType",
"tags": [],
"label": "payload",
"description": [
"either a Blob content, or a Record with a stringified content and type"
],
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.DownloadableContent",
"text": "DownloadableContent"
}
],
"path": "src/platform/plugins/shared/share/public/lib/download_as.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"a Promise that resolves when the download has been correctly started"
],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.downloadMultipleAs",
"type": "Function",
"tags": [],
"label": "downloadMultipleAs",
"description": [
"\nMultiple files download method"
],
"signature": [
"(files: Record<string, ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.DownloadableContent",
"text": "DownloadableContent"
},
">) => Promise<void>"
],
"path": "src/platform/plugins/shared/share/public/lib/download_as.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.downloadMultipleAs.$1",
"type": "Object",
"tags": [],
"label": "files",
"description": [
"a Record containing one entry per file: the key entry should be the filename\nand the value either a Blob content, or a Record with a stringified content and type"
],
"signature": [
"Record<string, ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.DownloadableContent",
"text": "DownloadableContent"
},
">"
],
"path": "src/platform/plugins/shared/share/public/lib/download_as.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"a Promise that resolves when all the downloads have been correctly started"
],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.useLocatorUrl",
"type": "Function",
"tags": [],
"label": "useLocatorUrl",
"description": [],
"signature": [
"<P extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
">(locator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<P> | null | undefined, params: P, getUrlParams?: ",
"LocatorGetUrlParams",
" | undefined, deps?: React.DependencyList) => string"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/use_locator_url.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.useLocatorUrl.$1",
"type": "CompoundType",
"tags": [],
"label": "locator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<P> | null | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/use_locator_url.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "share",
"id": "def-public.useLocatorUrl.$2",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/use_locator_url.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "share",
"id": "def-public.useLocatorUrl.$3",
"type": "Object",
"tags": [],
"label": "getUrlParams",
"description": [],
"signature": [
"LocatorGetUrlParams",
" | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/use_locator_url.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "share",
"id": "def-public.useLocatorUrl.$4",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"signature": [
"React.DependencyList"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/use_locator_url.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.useShareTypeContext",
"type": "Function",
"tags": [],
"label": "useShareTypeContext",
"description": [],
"signature": [
"<T extends \"link\" | \"embed\" | \"integration\", G extends T extends \"integration\" ? string : never>(shareType: T, groupId?: G | undefined) => { objectTypeMeta: Omit<Partial<{ link: ",
"LinkShareUIConfig",
"; embed: ",
"EmbedShareUIConfig",
"; integration: { [key: string]: ShareActionUserInputBase<Record<string, unknown>>; export: ExportShareUIConfig; }; }>, \"config\"> & { config: T extends \"integration\" ? { [key: string]: ShareActionUserInputBase<Record<string, unknown>>; export: ExportShareUIConfig; }[G] | undefined : Partial<{ link: ",
"LinkShareUIConfig",
"; embed: ",
"EmbedShareUIConfig",
"; integration: { [key: string]: ShareActionUserInputBase<Record<string, unknown>>; export: ExportShareUIConfig; }; }>[T]; }; shareMenuItems: T extends \"integration\" ? (Extract<",
"LinkShareConfig",
", { shareType: T; groupId?: G | undefined; }> | Extract<",
"EmbedShareConfig",
", { shareType: T; groupId?: G | undefined; }> | Extract<",
"ShareIntegrationConfig",
", { shareType: T; groupId?: G | undefined; }> | Extract<",
"ExportShareConfig",
", { shareType: T; groupId?: G | undefined; }> | Extract<",
"ExportShareDerivativesConfig",
", { shareType: T; groupId?: G | undefined; }> | Extract<",
"LegacyIntegrationConfig",
", { shareType: T; groupId?: G | undefined; }>)[] : Extract<",
"LinkShareConfig",
", { shareType: T; }> | Extract<",
"EmbedShareConfig",
", { shareType: T; }> | Extract<",
"ShareIntegrationConfig",
", { shareType: T; }> | Extract<",
"ExportShareConfig",
", { shareType: T; }> | Extract<",
"ExportShareDerivativesConfig",
", { shareType: T; }> | Extract<",
"LegacyIntegrationConfig",
", { shareType: T; }>; onClose: () => void; objectType: string; objectTypeAlias?: string | undefined; objectId?: string | undefined; shareableUrl?: string | undefined; shareableUrlForSavedObject?: string | undefined; shareableUrlLocatorParams?: { locator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<any>; params: any; } | undefined; sharingData: { [key: string]: unknown; }; isDirty: boolean; asExport?: boolean | undefined; anchorElement?: HTMLElement | undefined; allowShortUrl: boolean; publicAPIEnabled?: boolean | undefined; }"
],
"path": "src/platform/plugins/shared/share/public/components/context/index.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.useShareTypeContext.$1",
"type": "Uncategorized",
"tags": [],
"label": "shareType",
"description": [],
"signature": [
"T"
],
"path": "src/platform/plugins/shared/share/public/components/context/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "share",
"id": "def-public.useShareTypeContext.$2",
"type": "Uncategorized",
"tags": [],
"label": "groupId",
"description": [],
"signature": [
"G | undefined"
],
"path": "src/platform/plugins/shared/share/public/components/context/index.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "share",
"id": "def-public.ExportShare",
"type": "Interface",
"tags": [
"description"
],
"label": "ExportShare",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.ExportShare",
"text": "ExportShare"
},
" extends { id: string; groupId?: string | undefined; shareType: \"integration\"; config: (ctx: ShareActionConfigArgs) => { name?: string | undefined; icon?: ",
"IconType",
" | undefined; sortOrder?: number | undefined; toolTipContent?: string | undefined; label: string; exportType: string; disabled?: boolean | undefined; helpText?: React.ReactNode; generateExportButtonLabel?: React.ReactNode; generateAssetExport: (args: ",
"ExportGenerationOpts",
") => Promise<unknown>; renderCopyURIButton?: boolean | undefined; warnings?: { title: string; message: string; }[] | undefined; requiresSavedState?: boolean | undefined; supportedLayoutOptions?: \"print\"[] | undefined; renderLayoutOptionSwitch?: boolean | undefined; } & ({ generateAssetComponent?: undefined; copyAssetURIConfig: { headingText: string; helpText?: string | undefined; contentType: string | undefined; generateAssetURIValue: (args: ",
"ExportGenerationOpts",
") => string | undefined; }; } | { generateAssetComponent: React.ReactNode; copyAssetURIConfig?: undefined; } | { generateAssetComponent?: undefined; copyAssetURIConfig?: undefined; }); prerequisiteCheck?: ((args: { capabilities: ",
"Capabilities",
"; objectType: string; license?: ",
"ILicense",
" | undefined; }) => boolean) | undefined; }"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.ExportShare.groupId",
"type": "string",
"tags": [],
"label": "groupId",
"description": [],
"signature": [
"\"export\""
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.ExportShareDerivatives",
"type": "Interface",
"tags": [
"description"
],
"label": "ExportShareDerivatives",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.ExportShareDerivatives",
"text": "ExportShareDerivatives"
},
" extends { id: string; groupId?: string | undefined; shareType: \"integration\"; config: (ctx: ShareActionConfigArgs) => { label: React.FC<{ openFlyout: () => void; }>; toolTipContent?: React.ReactNode; flyoutContent: React.FC<{ closeFlyout: () => void; flyoutRef: React.RefObject<HTMLDivElement>; }>; flyoutSizing?: Pick<",
"EuiFlyoutProps",
"<\"div\">, \"size\" | \"maxWidth\"> | undefined; }; prerequisiteCheck?: ((args: { capabilities: ",
"Capabilities",
"; objectType: string; license?: ",
"ILicense",
" | undefined; }) => boolean) | undefined; }"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.ExportShareDerivatives.groupId",
"type": "string",
"tags": [],
"label": "groupId",
"description": [],
"signature": [
"\"exportDerivatives\""
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.KibanaLocation",
"type": "Interface",
"tags": [],
"label": "KibanaLocation",
"description": [
"\nThis interface represents a location in Kibana to which one can navigate\nusing the `core.application.navigateToApp()` method."
],
"signature": [
"KibanaLocation",
"<S>"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.KibanaLocation.app",
"type": "string",
"tags": [],
"label": "app",
"description": [
"\nKibana application ID."
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.KibanaLocation.path",
"type": "string",
"tags": [],
"label": "path",
"description": [
"\nA relative URL path within a Kibana application."
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.KibanaLocation.state",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [
"\nA serializable location state object, which the app can use to determine\nwhat should be displayed on the screen."
],
"signature": [
"S"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.LocatorDefinition",
"type": "Interface",
"tags": [],
"label": "LocatorDefinition",
"description": [
"\nA convenience interface used to define and register a locator."
],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<P> extends Partial<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.PersistableState",
"text": "PersistableState"
},
"<P>>"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.LocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nUnique ID of the locator. Should be constant and unique across Kibana."
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.LocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [
"\nReturns a deep link, including location state, which can be used for\nnavigation in Kibana.\n"
],
"signature": [
"(params: P) => Promise<",
"KibanaLocation",
"<object>>"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.LocatorDefinition.getLocation.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"Parameters from which to generate a Kibana location."
],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic",
"type": "Interface",
"tags": [],
"label": "LocatorPublic",
"description": [
"\nPublic interface of a registered locator."
],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<P> extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.PersistableState",
"text": "PersistableState"
},
"<P>"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [
"\nReturns a reference to a Kibana client-side location.\n"
],
"signature": [
"(params: P) => Promise<",
"KibanaLocation",
"<object>>"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.getLocation.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"URL locator parameters."
],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.getUrl",
"type": "Function",
"tags": [],
"label": "getUrl",
"description": [
"\nReturns a URL as a string.\n\nYou may want to use `getRedirectUrl` instead. `getRedirectUrl` will\npreserve the location state, whereas the `getUrl` just returns the URL\nwithout the location state. Use this method if you know you don't need\nremember the location state and version of the URL locator.\n"
],
"signature": [
"(params: P, getUrlParams?: ",
"LocatorGetUrlParams",
" | undefined) => Promise<string>"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.getUrl.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"URL locator parameters."
],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.getUrl.$2",
"type": "Object",
"tags": [],
"label": "getUrlParams",
"description": [
"URL construction parameters."
],
"signature": [
"LocatorGetUrlParams",
" | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.getRedirectUrl",
"type": "Function",
"tags": [],
"label": "getRedirectUrl",
"description": [
"\nReturns a URL to the redirect endpoint, which will redirect the user to\nthe final destination.\n"
],
"signature": [
"(params: P, options?: ",
"GetRedirectUrlOptions",
" | undefined) => string"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.getRedirectUrl.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"URL locator parameters."
],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.getRedirectUrl.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [
"URL serialization options."
],
"signature": [
"GetRedirectUrlOptions",
" | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.navigate",
"type": "Function",
"tags": [],
"label": "navigate",
"description": [
"\nNavigate using the `core.application.navigateToApp()` method to a Kibana\nlocation generated by this locator. This method is available only on the\nbrowser.\n"
],
"signature": [
"(params: P, navigationParams?: ",
"LocatorNavigationParams",
" | undefined) => Promise<void>"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.navigate.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"URL locator parameters."
],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.navigate.$2",
"type": "Object",
"tags": [],
"label": "navigationParams",
"description": [
"Navigation parameters."
],
"signature": [
"LocatorNavigationParams",
" | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.navigateSync",
"type": "Function",
"tags": [],
"label": "navigateSync",
"description": [
"\nSynchronous fire-and-forget navigation method. Use it when you want to\nnavigate without waiting for the navigation to complete and you don't\ncare to process any async promise errors.\n"
],
"signature": [
"(params: P, navigationParams?: ",
"LocatorNavigationParams",
" | undefined) => void"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.navigateSync.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"URL locator parameters."
],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.navigateSync.$2",
"type": "Object",
"tags": [],
"label": "navigationParams",
"description": [
"Navigation parameters."
],
"signature": [
"LocatorNavigationParams",
" | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.useUrl",
"type": "Function",
"tags": [],
"label": "useUrl",
"description": [
"\nReact hook which returns a URL string given locator parameters. Returns\nempty string if URL is being loaded or an error happened."
],
"signature": [
"(params: P, getUrlParams?: ",
"LocatorGetUrlParams",
" | undefined, deps?: React.DependencyList | undefined) => string"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.useUrl.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.useUrl.$2",
"type": "Object",
"tags": [],
"label": "getUrlParams",
"description": [],
"signature": [
"LocatorGetUrlParams",
" | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "share",
"id": "def-public.LocatorPublic.useUrl.$3",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"signature": [
"React.DependencyList | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.RedirectOptions",
"type": "Interface",
"tags": [],
"label": "RedirectOptions",
"description": [],
"signature": [
"RedirectOptions",
"<P>"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/redirect/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.RedirectOptions.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"Locator ID."
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/redirect/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.RedirectOptions.version",
"type": "string",
"tags": [],
"label": "version",
"description": [
"Kibana version when locator params were generated."
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/redirect/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.RedirectOptions.params",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"Locator params."
],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/redirect/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.ShareContext",
"type": "Interface",
"tags": [],
"label": "ShareContext",
"description": [],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.ShareContext.objectType",
"type": "string",
"tags": [],
"label": "objectType",
"description": [
"\nThe type of the object to share. for example lens, dashboard, etc."
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.ShareContext.objectTypeAlias",
"type": "string",
"tags": [],
"label": "objectTypeAlias",
"description": [
"\nAn alias of type of the object to share, that's more human friendly."
],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.ShareContext.objectTypeMeta",
"type": "Object",
"tags": [],
"label": "objectTypeMeta",
"description": [
"\nAllows for passing contextual information that each consumer can provide to customize the share menu"
],
"signature": [
"{ title: string; config: Partial<{ link: ",
"LinkShareUIConfig",
"; embed: ",
"EmbedShareUIConfig",
"; integration: { [key: string]: ShareActionUserInputBase<Record<string, unknown>>; export: ExportShareUIConfig; }; }>; }"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.ShareContext.objectId",
"type": "string",
"tags": [],
"label": "objectId",
"description": [
"\nId of the object that's been attempted to be shared"
],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.ShareContext.shareableUrl",
"type": "string",
"tags": [],
"label": "shareableUrl",
"description": [
"\nCurrent url for sharing. This can be set in cases where `window.location.href`\ndoes not contain a shareable URL (e.g. if using session storage to store the current\napp state is enabled). In these cases the property should contain the URL in a\nformat which makes it possible to use it without having access to any other state\nlike the current session.\n\nIf not set it will default to `window.location.href`"
],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.ShareContext.shareableUrlForSavedObject",
"type": "string",
"tags": [
"deprecated"
],
"label": "shareableUrlForSavedObject",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "discover",
"path": "src/platform/plugins/shared/discover/public/application/main/components/top_nav/app_menu_actions/get_share.tsx"
},
{
"plugin": "@kbn/reporting-public",
"path": "src/platform/packages/private/kbn-reporting/public/share/share_context_menu/register_pdf_png_modal_reporting.tsx"
},
{
"plugin": "@kbn/reporting-public",
"path": "src/platform/packages/private/kbn-reporting/public/share/share_context_menu/register_pdf_png_modal_reporting.tsx"
}
]
},
{
"parentPluginId": "share",
"id": "def-public.ShareContext.shareableUrlLocatorParams",
"type": "Object",
"tags": [],
"label": "shareableUrlLocatorParams",
"description": [],
"signature": [
"{ locator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<any>; params: any; } | undefined"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.ShareContext.sharingData",
"type": "Object",
"tags": [],
"label": "sharingData",
"description": [],
"signature": [
"{ [key: string]: unknown; }"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.ShareContext.isDirty",
"type": "boolean",
"tags": [],
"label": "isDirty",
"description": [],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.ShareContext.onClose",
"type": "Function",
"tags": [],
"label": "onClose",
"description": [],
"signature": [
"() => void"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.ShareContextMenuPanelItem",
"type": "Interface",
"tags": [],
"label": "ShareContextMenuPanelItem",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.ShareContextMenuPanelItem",
"text": "ShareContextMenuPanelItem"
},
" extends Omit<",
"EuiContextMenuPanelItemDescriptorEntry",
", \"name\">"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.ShareContextMenuPanelItem.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.ShareContextMenuPanelItem.sortOrder",
"type": "number",
"tags": [],
"label": "sortOrder",
"description": [],
"signature": [
"number | undefined"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.ShareMenuItemLegacy",
"type": "Interface",
"tags": [],
"label": "ShareMenuItemLegacy",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.ShareMenuItemLegacy",
"text": "ShareMenuItemLegacy"
},
" extends ShareMenuItemBase"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.ShareMenuItemLegacy.panel",
"type": "Object",
"tags": [],
"label": "panel",
"description": [],
"signature": [
"EuiContextMenuPanelDescriptor",
" | undefined"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.ShowShareMenuOptions",
"type": "Interface",
"tags": [],
"label": "ShowShareMenuOptions",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.ShowShareMenuOptions",
"text": "ShowShareMenuOptions"
},
" extends Omit<",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.ShareContext",
"text": "ShareContext"
},
", \"onClose\">"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.ShowShareMenuOptions.asExport",
"type": "CompoundType",
"tags": [],
"label": "asExport",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.ShowShareMenuOptions.anchorElement",
"type": "Object",
"tags": [],
"label": "anchorElement",
"description": [],
"signature": [
"HTMLElement | undefined"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.ShowShareMenuOptions.allowShortUrl",
"type": "boolean",
"tags": [],
"label": "allowShortUrl",
"description": [],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.ShowShareMenuOptions.onClose",
"type": "Function",
"tags": [],
"label": "onClose",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "share",
"id": "def-public.ShowShareMenuOptions.publicAPIEnabled",
"type": "CompoundType",
"tags": [],
"label": "publicAPIEnabled",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "share",
"id": "def-public.BrowserUrlService",
"type": "Type",
"tags": [],
"label": "BrowserUrlService",
"description": [],
"signature": [
"UrlService",
"<null, ",
"BrowserShortUrlClient",
">"
],
"path": "src/platform/plugins/shared/share/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.ConfigSchema",
"type": "Type",
"tags": [],
"label": "ConfigSchema",
"description": [],
"signature": [
"{ readonly new_version: Readonly<{} & { enabled: boolean; }>; readonly url_expiration: Readonly<{} & { enabled: boolean; duration: moment.Duration; check_interval: moment.Duration; url_limit: number; }>; }"
],
"path": "src/platform/plugins/shared/share/server/config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.CSV_QUOTE_VALUES_SETTING",
"type": "string",
"tags": [],
"label": "CSV_QUOTE_VALUES_SETTING",
"description": [],
"signature": [
"\"csv:quoteValues\""
],
"path": "src/platform/plugins/shared/share/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.CSV_SEPARATOR_SETTING",
"type": "string",
"tags": [],
"label": "CSV_SEPARATOR_SETTING",
"description": [],
"signature": [
"\"csv:separator\""
],
"path": "src/platform/plugins/shared/share/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-public.DownloadableContent",
"type": "Type",
"tags": [],
"label": "DownloadableContent",
"description": [],
"signature": [
"Blob | { content: string; type: string; }"
],
"path": "src/platform/plugins/shared/share/public/lib/download_as.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "share",
"id": "def-public.SharePublicSetup",
"type": "Interface",
"tags": [],
"label": "SharePublicSetup",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.SharePublicSetup",
"text": "SharePublicSetup"
},
" extends { register: (value: ",
"ShareMenuProviderLegacy",
") => void; registerShareIntegration: <I extends { id: string; groupId?: string | undefined; shareType: \"integration\"; config: (ctx: ShareActionConfigArgs) => Record<string, unknown>; prerequisiteCheck?: ((args: { capabilities: ",
"Capabilities",
"; objectType: string; license?: ",
"ILicense",
" | undefined; }) => boolean) | undefined; }>(...args: [string, Omit<I, \"shareType\">] | [Omit<I, \"shareType\">]) => void; }"
],
"path": "src/platform/plugins/shared/share/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.SharePublicSetup.url",
"type": "Object",
"tags": [],
"label": "url",
"description": [
"\nUtilities to work with URL locators and short URLs."
],
"signature": [
"UrlService",
"<null, ",
"BrowserShortUrlClient",
">"
],
"path": "src/platform/plugins/shared/share/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-public.SharePublicSetup.navigate",
"type": "Function",
"tags": [],
"label": "navigate",
"description": [
"\nAccepts serialized values for extracting a locator, migrating state from a provided version against\nthe locator, then using the locator to navigate."
],
"signature": [
"(options: ",
"RedirectOptions",
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
">) => void"
],
"path": "src/platform/plugins/shared/share/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.SharePublicSetup.navigate.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"RedirectOptions",
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
">"
],
"path": "src/platform/plugins/shared/share/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "share",
"id": "def-public.SharePublicSetup.setAnonymousAccessServiceProvider",
"type": "Function",
"tags": [],
"label": "setAnonymousAccessServiceProvider",
"description": [
"\nSets the provider for the anonymous access service; this is consumed by the Security plugin to avoid a circular dependency."
],
"signature": [
"(provider: () => ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.AnonymousAccessServiceContract",
"text": "AnonymousAccessServiceContract"
},
") => void"
],
"path": "src/platform/plugins/shared/share/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-public.SharePublicSetup.setAnonymousAccessServiceProvider.$1",
"type": "Function",
"tags": [],
"label": "provider",
"description": [],
"signature": [
"() => ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.AnonymousAccessServiceContract",
"text": "AnonymousAccessServiceContract"
}
],
"path": "src/platform/plugins/shared/share/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "share",
"id": "def-public.SharePublicStart",
"type": "Type",
"tags": [],
"label": "SharePublicStart",
"description": [],
"signature": [
"{ toggleShareContextMenu: (options: ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.ShowShareMenuOptions",
"text": "ShowShareMenuOptions"
},
") => void; } & { url: ",
{
"pluginId": "share",
"scope": "public",
"docId": "kibSharePluginApi",
"section": "def-public.BrowserUrlService",
"text": "BrowserUrlService"
},
"; navigate(options: ",
"RedirectOptions",
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
">): void; availableIntegrations: (objectType: string, groupId?: string | undefined) => ",
"ShareActionIntents",
"[]; }"
],
"path": "src/platform/plugins/shared/share/public/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [
{
"parentPluginId": "share",
"id": "def-server.deleteUnusedUrls",
"type": "Function",
"tags": [],
"label": "deleteUnusedUrls",
"description": [],
"signature": [
"({ savedObjectsRepository, unusedUrls, namespace, logger, }: { savedObjectsRepository: ",
"ISavedObjectsRepository",
"; unusedUrls: ",
"SavedObjectsBulkDeleteObject",
"[]; namespace: string; logger: ",
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.Logger",
"text": "Logger"
},
"; }) => Promise<void>"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-server.deleteUnusedUrls.$1",
"type": "Object",
"tags": [],
"label": "{\n savedObjectsRepository,\n unusedUrls,\n namespace,\n logger,\n}",
"description": [],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-server.deleteUnusedUrls.$1.savedObjectsRepository",
"type": "Object",
"tags": [],
"label": "savedObjectsRepository",
"description": [],
"signature": [
"ISavedObjectsRepository"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-server.deleteUnusedUrls.$1.unusedUrls",
"type": "Array",
"tags": [],
"label": "unusedUrls",
"description": [],
"signature": [
"SavedObjectsBulkDeleteObject",
"[]"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-server.deleteUnusedUrls.$1.namespace",
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-server.deleteUnusedUrls.$1.logger",
"type": "Object",
"tags": [],
"label": "logger",
"description": [],
"signature": [
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.Logger",
"text": "Logger"
}
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-server.durationToSeconds",
"type": "Function",
"tags": [],
"label": "durationToSeconds",
"description": [],
"signature": [
"(duration: moment.Duration) => string"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-server.durationToSeconds.$1",
"type": "Object",
"tags": [],
"label": "duration",
"description": [],
"signature": [
"moment.Duration"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-server.fetchUnusedUrlsFromFirstNamespace",
"type": "Function",
"tags": [],
"label": "fetchUnusedUrlsFromFirstNamespace",
"description": [],
"signature": [
"({ savedObjectsRepository, urlExpirationDuration, urlLimit, }: { savedObjectsRepository: ",
"ISavedObjectsRepository",
"; urlExpirationDuration: moment.Duration; urlLimit: number; }) => Promise<{ unusedUrls: { id: string; type: string; }[]; hasMore: boolean; namespace: string; }>"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-server.fetchUnusedUrlsFromFirstNamespace.$1",
"type": "Object",
"tags": [],
"label": "{\n savedObjectsRepository,\n urlExpirationDuration,\n urlLimit,\n}",
"description": [],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-server.fetchUnusedUrlsFromFirstNamespace.$1.savedObjectsRepository",
"type": "Object",
"tags": [],
"label": "savedObjectsRepository",
"description": [],
"signature": [
"ISavedObjectsRepository"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-server.fetchUnusedUrlsFromFirstNamespace.$1.urlExpirationDuration",
"type": "Object",
"tags": [],
"label": "urlExpirationDuration",
"description": [],
"signature": [
"moment.Duration"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-server.fetchUnusedUrlsFromFirstNamespace.$1.urlLimit",
"type": "number",
"tags": [],
"label": "urlLimit",
"description": [],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-server.getDeleteUnusedUrlTaskInstance",
"type": "Function",
"tags": [],
"label": "getDeleteUnusedUrlTaskInstance",
"description": [],
"signature": [
"(interval: moment.Duration) => ",
"TaskInstanceWithId"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-server.getDeleteUnusedUrlTaskInstance.$1",
"type": "Object",
"tags": [],
"label": "interval",
"description": [],
"signature": [
"moment.Duration"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-server.runDeleteUnusedUrlsTask",
"type": "Function",
"tags": [],
"label": "runDeleteUnusedUrlsTask",
"description": [],
"signature": [
"({ core, urlExpirationDuration, urlLimit, logger, isEnabled, }: { core: ",
"CoreSetup",
"<{}, unknown>; urlExpirationDuration: moment.Duration; urlLimit: number; logger: ",
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.Logger",
"text": "Logger"
},
"; isEnabled: boolean; }) => Promise<{ deletedCount: number; }>"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-server.runDeleteUnusedUrlsTask.$1",
"type": "Object",
"tags": [],
"label": "{\n core,\n urlExpirationDuration,\n urlLimit,\n logger,\n isEnabled,\n}",
"description": [],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-server.runDeleteUnusedUrlsTask.$1.core",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
"CoreSetup",
"<{}, unknown>"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-server.runDeleteUnusedUrlsTask.$1.urlExpirationDuration",
"type": "Object",
"tags": [],
"label": "urlExpirationDuration",
"description": [],
"signature": [
"moment.Duration"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-server.runDeleteUnusedUrlsTask.$1.urlLimit",
"type": "number",
"tags": [],
"label": "urlLimit",
"description": [],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-server.runDeleteUnusedUrlsTask.$1.logger",
"type": "Object",
"tags": [],
"label": "logger",
"description": [],
"signature": [
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.Logger",
"text": "Logger"
}
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-server.runDeleteUnusedUrlsTask.$1.isEnabled",
"type": "boolean",
"tags": [],
"label": "isEnabled",
"description": [],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-server.scheduleUnusedUrlsCleanupTask",
"type": "Function",
"tags": [],
"label": "scheduleUnusedUrlsCleanupTask",
"description": [],
"signature": [
"({ taskManager, checkInterval, isEnabled, }: { taskManager: ",
{
"pluginId": "taskManager",
"scope": "server",
"docId": "kibTaskManagerPluginApi",
"section": "def-server.TaskManagerStartContract",
"text": "TaskManagerStartContract"
},
"; checkInterval: moment.Duration; isEnabled: boolean; }) => Promise<void>"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-server.scheduleUnusedUrlsCleanupTask.$1",
"type": "Object",
"tags": [],
"label": "{\n taskManager,\n checkInterval,\n isEnabled,\n}",
"description": [],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-server.scheduleUnusedUrlsCleanupTask.$1.taskManager",
"type": "CompoundType",
"tags": [],
"label": "taskManager",
"description": [],
"signature": [
"Pick<",
"TaskScheduling",
", \"schedule\" | \"runSoon\" | \"bulkEnable\" | \"ensureScheduled\" | \"bulkUpdateSchedules\" | \"bulkDisable\" | \"bulkSchedule\" | \"bulkUpdateState\"> & Pick<",
"TaskStore",
", \"get\" | \"aggregate\" | \"fetch\" | \"remove\" | \"bulkRemove\"> & { removeIfExists: (id: string) => Promise<void>; } & { getRegisteredTypes: () => string[]; registerEncryptedSavedObjectsClient: (client: ",
{
"pluginId": "@kbn/encrypted-saved-objects-shared",
"scope": "common",
"docId": "kibKbnEncryptedSavedObjectsSharedPluginApi",
"section": "def-common.EncryptedSavedObjectsClient",
"text": "EncryptedSavedObjectsClient"
},
") => void; }"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-server.scheduleUnusedUrlsCleanupTask.$1.checkInterval",
"type": "Object",
"tags": [],
"label": "checkInterval",
"description": [],
"signature": [
"moment.Duration"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-server.scheduleUnusedUrlsCleanupTask.$1.isEnabled",
"type": "boolean",
"tags": [],
"label": "isEnabled",
"description": [],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/task.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "share",
"id": "def-server.CSV_QUOTE_VALUES_SETTING",
"type": "string",
"tags": [],
"label": "CSV_QUOTE_VALUES_SETTING",
"description": [],
"signature": [
"\"csv:quoteValues\""
],
"path": "src/platform/plugins/shared/share/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-server.CSV_SEPARATOR_SETTING",
"type": "string",
"tags": [],
"label": "CSV_SEPARATOR_SETTING",
"description": [],
"signature": [
"\"csv:separator\""
],
"path": "src/platform/plugins/shared/share/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-server.DEFAULT_URL_EXPIRATION_CHECK_INTERVAL",
"type": "string",
"tags": [],
"label": "DEFAULT_URL_EXPIRATION_CHECK_INTERVAL",
"description": [],
"signature": [
"\"7d\""
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-server.DEFAULT_URL_EXPIRATION_DURATION",
"type": "string",
"tags": [],
"label": "DEFAULT_URL_EXPIRATION_DURATION",
"description": [],
"signature": [
"\"1y\""
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-server.DEFAULT_URL_LIMIT",
"type": "number",
"tags": [],
"label": "DEFAULT_URL_LIMIT",
"description": [],
"signature": [
"10000"
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-server.SAVED_OBJECT_TYPE",
"type": "string",
"tags": [],
"label": "SAVED_OBJECT_TYPE",
"description": [],
"signature": [
"\"url\""
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-server.TASK_ID",
"type": "string",
"tags": [],
"label": "TASK_ID",
"description": [],
"signature": [
"\"unusedUrlsCleanupTask\""
],
"path": "src/platform/plugins/shared/share/server/unused_urls_task/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "share",
"id": "def-server.SharePublicSetup",
"type": "Interface",
"tags": [],
"label": "SharePublicSetup",
"description": [],
"path": "src/platform/plugins/shared/share/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-server.SharePublicSetup.url",
"type": "Object",
"tags": [],
"label": "url",
"description": [],
"signature": [
"UrlService",
"<",
"ServerShortUrlClientFactoryCreateParams",
", ",
"IShortUrlClient",
">"
],
"path": "src/platform/plugins/shared/share/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "share",
"id": "def-server.SharePublicStart",
"type": "Interface",
"tags": [],
"label": "SharePublicStart",
"description": [],
"path": "src/platform/plugins/shared/share/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-server.SharePublicStart.url",
"type": "Object",
"tags": [],
"label": "url",
"description": [],
"signature": [
"UrlService",
"<",
"ServerShortUrlClientFactoryCreateParams",
", ",
"IShortUrlClient",
">"
],
"path": "src/platform/plugins/shared/share/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "share",
"id": "def-common.useLocatorUrl",
"type": "Function",
"tags": [],
"label": "useLocatorUrl",
"description": [],
"signature": [
"<P extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
">(locator: ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<P> | null | undefined, params: P, getUrlParams?: ",
"LocatorGetUrlParams",
" | undefined, deps?: React.DependencyList) => string"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/use_locator_url.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-common.useLocatorUrl.$1",
"type": "CompoundType",
"tags": [],
"label": "locator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<P> | null | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/use_locator_url.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "share",
"id": "def-common.useLocatorUrl.$2",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/use_locator_url.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "share",
"id": "def-common.useLocatorUrl.$3",
"type": "Object",
"tags": [],
"label": "getUrlParams",
"description": [],
"signature": [
"LocatorGetUrlParams",
" | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/use_locator_url.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "share",
"id": "def-common.useLocatorUrl.$4",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"signature": [
"React.DependencyList"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/use_locator_url.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "share",
"id": "def-common.AnonymousAccessServiceContract",
"type": "Interface",
"tags": [],
"label": "AnonymousAccessServiceContract",
"description": [
"\nThe contract that is used to check anonymous access for the purposes of sharing public links. The implementation is intended to be\nprovided by the security plugin."
],
"path": "src/platform/plugins/shared/share/common/anonymous_access/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-common.AnonymousAccessServiceContract.getState",
"type": "Function",
"tags": [],
"label": "getState",
"description": [
"\nThis function returns the current state of anonymous access."
],
"signature": [
"() => Promise<",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.AnonymousAccessState",
"text": "AnonymousAccessState"
},
">"
],
"path": "src/platform/plugins/shared/share/common/anonymous_access/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "share",
"id": "def-common.AnonymousAccessServiceContract.getCapabilities",
"type": "Function",
"tags": [],
"label": "getCapabilities",
"description": [
"\nThis function returns the capabilities of the anonymous access user."
],
"signature": [
"() => Promise<",
"Capabilities",
">"
],
"path": "src/platform/plugins/shared/share/common/anonymous_access/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-common.AnonymousAccessState",
"type": "Interface",
"tags": [],
"label": "AnonymousAccessState",
"description": [
"\nThe state of anonymous access."
],
"path": "src/platform/plugins/shared/share/common/anonymous_access/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-common.AnonymousAccessState.isEnabled",
"type": "boolean",
"tags": [],
"label": "isEnabled",
"description": [
"\nWhether anonymous access is enabled or not."
],
"path": "src/platform/plugins/shared/share/common/anonymous_access/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-common.AnonymousAccessState.accessURLParameters",
"type": "CompoundType",
"tags": [],
"label": "accessURLParameters",
"description": [
"\nIf anonymous access is enabled, this reflects what URL parameters need to be added to a Kibana link to make it publicly accessible.\nNote that if anonymous access is the only authentication method, this will be null."
],
"signature": [
"Record<string, string> | null"
],
"path": "src/platform/plugins/shared/share/common/anonymous_access/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-common.LocatorDefinition",
"type": "Interface",
"tags": [],
"label": "LocatorDefinition",
"description": [
"\nA convenience interface used to define and register a locator."
],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<P> extends Partial<",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.PersistableState",
"text": "PersistableState"
},
"<P>>"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-common.LocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nUnique ID of the locator. Should be constant and unique across Kibana."
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-common.LocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [
"\nReturns a deep link, including location state, which can be used for\nnavigation in Kibana.\n"
],
"signature": [
"(params: P) => Promise<",
"KibanaLocation",
"<object>>"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-common.LocatorDefinition.getLocation.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"Parameters from which to generate a Kibana location."
],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic",
"type": "Interface",
"tags": [],
"label": "LocatorPublic",
"description": [
"\nPublic interface of a registered locator."
],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<P> extends ",
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.PersistableState",
"text": "PersistableState"
},
"<P>"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [
"\nReturns a reference to a Kibana client-side location.\n"
],
"signature": [
"(params: P) => Promise<",
"KibanaLocation",
"<object>>"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.getLocation.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"URL locator parameters."
],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.getUrl",
"type": "Function",
"tags": [],
"label": "getUrl",
"description": [
"\nReturns a URL as a string.\n\nYou may want to use `getRedirectUrl` instead. `getRedirectUrl` will\npreserve the location state, whereas the `getUrl` just returns the URL\nwithout the location state. Use this method if you know you don't need\nremember the location state and version of the URL locator.\n"
],
"signature": [
"(params: P, getUrlParams?: ",
"LocatorGetUrlParams",
" | undefined) => Promise<string>"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.getUrl.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"URL locator parameters."
],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.getUrl.$2",
"type": "Object",
"tags": [],
"label": "getUrlParams",
"description": [
"URL construction parameters."
],
"signature": [
"LocatorGetUrlParams",
" | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.getRedirectUrl",
"type": "Function",
"tags": [],
"label": "getRedirectUrl",
"description": [
"\nReturns a URL to the redirect endpoint, which will redirect the user to\nthe final destination.\n"
],
"signature": [
"(params: P, options?: ",
"GetRedirectUrlOptions",
" | undefined) => string"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.getRedirectUrl.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"URL locator parameters."
],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.getRedirectUrl.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [
"URL serialization options."
],
"signature": [
"GetRedirectUrlOptions",
" | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.navigate",
"type": "Function",
"tags": [],
"label": "navigate",
"description": [
"\nNavigate using the `core.application.navigateToApp()` method to a Kibana\nlocation generated by this locator. This method is available only on the\nbrowser.\n"
],
"signature": [
"(params: P, navigationParams?: ",
"LocatorNavigationParams",
" | undefined) => Promise<void>"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.navigate.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"URL locator parameters."
],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.navigate.$2",
"type": "Object",
"tags": [],
"label": "navigationParams",
"description": [
"Navigation parameters."
],
"signature": [
"LocatorNavigationParams",
" | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.navigateSync",
"type": "Function",
"tags": [],
"label": "navigateSync",
"description": [
"\nSynchronous fire-and-forget navigation method. Use it when you want to\nnavigate without waiting for the navigation to complete and you don't\ncare to process any async promise errors.\n"
],
"signature": [
"(params: P, navigationParams?: ",
"LocatorNavigationParams",
" | undefined) => void"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.navigateSync.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [
"URL locator parameters."
],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.navigateSync.$2",
"type": "Object",
"tags": [],
"label": "navigationParams",
"description": [
"Navigation parameters."
],
"signature": [
"LocatorNavigationParams",
" | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.useUrl",
"type": "Function",
"tags": [],
"label": "useUrl",
"description": [
"\nReact hook which returns a URL string given locator parameters. Returns\nempty string if URL is being loaded or an error happened."
],
"signature": [
"(params: P, getUrlParams?: ",
"LocatorGetUrlParams",
" | undefined, deps?: React.DependencyList | undefined) => string"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.useUrl.$1",
"type": "Uncategorized",
"tags": [],
"label": "params",
"description": [],
"signature": [
"P"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.useUrl.$2",
"type": "Object",
"tags": [],
"label": "getUrlParams",
"description": [],
"signature": [
"LocatorGetUrlParams",
" | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "share",
"id": "def-common.LocatorPublic.useUrl.$3",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"signature": [
"React.DependencyList | undefined"
],
"path": "src/platform/plugins/shared/share/common/url_service/locators/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink