SettingsAdmin - product-settings-client

Woah! This page has a great deal of content... Give us a second to load it.

API Reference > product-Settings-client > Settings > SettingsAdmin

SettingsAdmin Interface

Beta

Methods available to save and get Settings objects on behalf of combinations of the Application, Project, iModel, and User

Methods

Name	Description
deleteSetting(requestContext: AuthorizedClientRequestContext, namespace: string, name: string, applicationSpecific: boolean, projectId?: string, iModelId?: string): Promise<SettingsResult>	Deletes a non-user-specific settings object from the settings service.
deleteSharedSetting(requestContext: AuthorizedClientRequestContext, namespace: string, name: string, applicationSpecific: boolean, projectId: string, iModelId?: string): Promise<SettingsResult>	Deletes a shared settings object from the settings service.
deleteUserSetting(requestContext: AuthorizedClientRequestContext, namespace: string, name: string, applicationSpecific: boolean, projectId?: string, iModelId?: string): Promise<SettingsResult>	Deletes a user-specific settings object from the settings service.
getSetting(requestContext: AuthorizedClientRequestContext, namespace: string, name: string, applicationSpecific: boolean, projectId?: string, iModelId?: string): Promise<SettingsResult>	Retrieves a non-user-specific settings object from the settings service.
getSettingsByNamespace(requestContext: AuthorizedClientRequestContext, namespace: string, applicationSpecific: boolean, projectId?: string, iModelId?: string): Promise<SettingsMapResult>	Retrieves an array of non-user-specific settings objects that are stored with the specified namespace
getSharedSetting(requestContext: AuthorizedClientRequestContext, namespace: string, name: string, applicationSpecific: boolean, projectId: string, iModelId?: string): Promise<SettingsResult>	Retrieves a shared settings object from the settings service.
getSharedSettingsByNamespace(requestContext: AuthorizedClientRequestContext, namespace: string, applicationSpecific: boolean, projectId: string, iModelId?: string): Promise<SettingsMapResult>	Retrieves an array of shared settings objects that are stored with the specified namespace
getUserSetting(requestContext: AuthorizedClientRequestContext, namespace: string, name: string, applicationSpecific: boolean, projectId?: string, iModelId?: string): Promise<SettingsResult>	Retrieves a user-specific settings object from the settings service.
getUserSettingsByNamespace(requestContext: AuthorizedClientRequestContext, namespace: string, applicationSpecific: boolean, projectId?: string, iModelId?: string): Promise<SettingsMapResult>	Retrieves an array of user-specific settings objects that are stored with the specified namespace
saveSetting(requestContext: AuthorizedClientRequestContext, settings: any, namespace: string, name: string, applicationSpecific: boolean, projectId?: string, iModelId?: string): Promise<SettingsResult>	Saves a non-user-specific settings object to the settings service.
saveSharedSetting(requestContext: AuthorizedClientRequestContext, settings: any, namespace: string, name: string, applicationSpecific: boolean, projectId: string, iModelId?: string): Promise<SettingsResult>	Saves a shared settings object to the settings service.
saveUserSetting(requestContext: AuthorizedClientRequestContext, settings: any, namespace: string, name: string, applicationSpecific: boolean, projectId?: string, iModelId?: string): Promise<SettingsResult>	Saves a user-specific settings object to the settings service.

Defined in

product-settings/src/SettingsAdmin.ts Line 67

Last Updated: 11 June, 2024