getSharedSettingsByNamespace Method

Retrieves an array of shared settings objects that are stored with the specified namespace

getSharedSettingsByNamespace(requestContext: AuthorizedClientRequestContext, namespace: string, applicationSpecific: boolean, projectId: string, iModelId?: string): Promise<SettingsMapResult>

Parameter Type Description
requestContext AuthorizedClientRequestContext The client request context.
namespace string A program - supplied namespace that is used to organize settings and prevent name collisions.
applicationSpecific boolean Specifies whether the setting is specific to the current application, or used by all applications.
projectId string The wsgId of the Project (required for Shared Setting).
iModelId string The wsgId of the iModel, to retrieve settings specific to an iModel, otherwise undefined.

Returns - Promise<SettingsMapResult>

The result of the retrieval operation. If successful, SettingsResult.settingsMap contains a map of string to settings values containing all of the settings stored with the specified namespace.

Last Updated: 11 June, 2024