Opensearch dashboards.uisettingsservicestart.asscopedtoclient

Home > opensearch-dashboards > UiSettingsServiceStart > asScopedToClient

UiSettingsServiceStart.asScopedToClient() method

Creates a IUiSettingsClient with provided *scoped* saved objects client.

This should only be used in the specific case where the client needs to be accessed from outside of the scope of a RequestHandler.

Signature:

asScopedToClient(savedObjectsClient: SavedObjectsClientContract): IUiSettingsClient;

Parameters

Parameter	Type	Description
savedObjectsClient	SavedObjectsClientContract

Returns:

IUiSettingsClient

Example

start(core: CoreStart) {
 const soClient = core.savedObjects.getScopedClient(arbitraryRequest);
 const uiSettingsClient = core.uiSettings.asScopedToClient(soClient);
}