You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| [migrationVersion](./kibana-plugin-core-public.savedobject.migrationversion.md) | <code>SavedObjectsMigrationVersion</code>|InformationaboutthemigrationsthathavebeenappliedtothisSavedObject. WhenKibanastartsup, KibanaMigratordetectsoutdateddocumentsandmigratesthembasedonthisvalue. Foreachmigrationthathasbeenapplied, theplugin's name is used as a key and the latest migration version as the value. |
Copy file name to clipboardExpand all lines: docs/development/core/public/kibana-plugin-core-public.scopedhistory.createhref.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,12 @@
4
4
5
5
## ScopedHistory.createHref property
6
6
7
-
Creates an href (string) to the location.
7
+
Creates an href (string) to the location. If `prependBasePath` is true (default), it will prepend the location's path with the scoped history basePath.
| [createHref](./kibana-plugin-core-public.scopedhistory.createhref.md) | | <code>(location: LocationDescriptorObject<HistoryLocationState>) => string</code> | Creates an href (string) to the location. |
31
+
| [createHref](./kibana-plugin-core-public.scopedhistory.createhref.md) | | <code>(location: LocationDescriptorObject<HistoryLocationState>, { prependBasePath }?: {</code><br/><code> prependBasePath?: boolean | undefined;</code><br/><code> }) => string</code> | Creates an href (string) to the location. If <code>prependBasePath</code> is true (default), it will prepend the location's path with the scoped history basePath. |
32
32
| [createSubHistory](./kibana-plugin-core-public.scopedhistory.createsubhistory.md) | | <code><SubHistoryLocationState = unknown>(basePath: string) => ScopedHistory<SubHistoryLocationState></code> | Creates a <code>ScopedHistory</code> for a subpath of this <code>ScopedHistory</code>. Useful for applications that may have sub-apps that do not need access to the containing application's history. |
33
33
| [go](./kibana-plugin-core-public.scopedhistory.go.md) | | <code>(n: number) => void</code> | Send the user forward or backwards in the history stack. |
34
34
| [goBack](./kibana-plugin-core-public.scopedhistory.goback.md) | | <code>() => void</code> | Send the user one location back in the history stack. Equivalent to calling [ScopedHistory.go(-1)](./kibana-plugin-core-public.scopedhistory.go.md)<!-- -->. If no more entries are available backwards, this is a no-op. |
Copy file name to clipboardExpand all lines: docs/development/core/server/kibana-plugin-core-server.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -130,6 +130,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
130
130
|[SavedObjectMigrationContext](./kibana-plugin-core-server.savedobjectmigrationcontext.md)| Migration context provided when invoking a [migration handler](./kibana-plugin-core-server.savedobjectmigrationfn.md)|
131
131
|[SavedObjectMigrationMap](./kibana-plugin-core-server.savedobjectmigrationmap.md)| A map of [migration functions](./kibana-plugin-core-server.savedobjectmigrationfn.md) to be used for a given type. The map's keys must be valid semver versions.<!---->For a given document, only migrations with a higher version number than that of the document will be applied. Migrations are executed in order, starting from the lowest version and ending with the highest one. |
132
132
|[SavedObjectReference](./kibana-plugin-core-server.savedobjectreference.md)| A reference to another saved object. |
@@ -143,6 +144,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
143
144
|[SavedObjectsCoreFieldMapping](./kibana-plugin-core-server.savedobjectscorefieldmapping.md)| See [SavedObjectsFieldMapping](./kibana-plugin-core-server.savedobjectsfieldmapping.md) for documentation. |
|[SavedObjectsExportOptions](./kibana-plugin-core-server.savedobjectsexportoptions.md)| Options controlling the export operation. |
148
150
|[SavedObjectsExportResultDetails](./kibana-plugin-core-server.savedobjectsexportresultdetails.md)| Structure of the export result details entry |
@@ -262,6 +264,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
262
264
|[SavedObjectsClientFactoryProvider](./kibana-plugin-core-server.savedobjectsclientfactoryprovider.md)| Provider to invoke to retrieve a [SavedObjectsClientFactory](./kibana-plugin-core-server.savedobjectsclientfactory.md)<!---->. |
263
265
|[SavedObjectsClientWrapperFactory](./kibana-plugin-core-server.savedobjectsclientwrapperfactory.md)| Describes the factory used to create instances of Saved Objects Client Wrappers. |
264
266
|[SavedObjectsFieldMapping](./kibana-plugin-core-server.savedobjectsfieldmapping.md)| Describe a [saved object type mapping](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) field.<!---->Please refer to [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html) For the mapping documentation |
267
+
|[SavedObjectsNamespaceType](./kibana-plugin-core-server.savedobjectsnamespacetype.md)| The namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive: \* single (default): this type of saved object is namespace-isolated, e.g., it exists in only one namespace. \* multiple: this type of saved object is shareable, e.g., it can exist in one or more namespaces. \* agnostic: this type of saved object is global.<!---->Note: do not write logic that uses this value directly; instead, use the appropriate accessors in the [type registry](./kibana-plugin-core-server.savedobjecttyperegistry.md)<!---->. |
265
268
|[ScopeableRequest](./kibana-plugin-core-server.scopeablerequest.md)| A user credentials container. It accommodates the necessary auth credentials to impersonate the current user.<!---->See [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md)<!---->. |
266
269
|[ServiceStatusLevel](./kibana-plugin-core-server.servicestatuslevel.md)| A convenience type that represents the union of each value in [ServiceStatusLevels](./kibana-plugin-core-server.servicestatuslevels.md)<!---->. |
| [migrationVersion](./kibana-plugin-core-server.savedobject.migrationversion.md) | <code>SavedObjectsMigrationVersion</code>|InformationaboutthemigrationsthathavebeenappliedtothisSavedObject. WhenKibanastartsup, KibanaMigratordetectsoutdateddocumentsandmigratesthembasedonthisvalue. Foreachmigrationthathasbeenapplied, theplugin's name is used as a key and the latest migration version as the value. |
0 commit comments