@itwin/core-frontend/lib/cjs/UserPreferences.d.ts

iTwin.js frontend components

/** @packageDocumentation
 * @module UserPreferences
 */
import { AccessToken, GuidString } from "@itwin/core-bentley";
/** Argument for methods that can supply an iTwinId and iModelId.
 * @beta
 */
export interface ITwinIdArg {
    readonly iTwinId?: GuidString;
    readonly iModelId?: GuidString;
}
/** Argument for methods that can supply an access token.
 * @beta
 */
export interface TokenArg {
    accessToken?: AccessToken;
}
/** Argument for methods that can supply the user preference content.
 * @beta
 */
export interface PreferenceArg extends PreferenceKeyArg {
    readonly content?: any;
}
/** Argument for methods that must supply a key for the user preference.
 * @beta
 */
export interface PreferenceKeyArg {
    readonly namespace?: string;
    readonly key: string;
}
/** User preferences provide a way to get, store and delete preferences for an application at
 * two different levels, iTwin and iModel.
 *
 * The user preferences are separate from any iTwin or iModel configuration intended to be shared
 * across multiple users. See [Workspace]($docs/learning/backend/Workspace.md) for more details on
 * shared configuration.
 *
 * Note: Both the key and return type are intended to be abstract and allow any preferences to be stored.
 *     Based on this simple interface, the implementation of this interface can interpret the key as needed
 *     to store and retrieve the preferences.
 * @beta
 */
export interface UserPreferencesAccess {
    /** Method to get a user preference based off of a key within a namespace.
     *
     * If both iTwinId and iModelId are provided, the iModel level will be check first. If
     * it does not exist, the iTwin level will checked next.
     *
     * @returns undefined if a preference is not found.
     * @throws if an error occurs when attempting to retrieve a preference.
     */
    get: (arg: PreferenceKeyArg & ITwinIdArg & TokenArg) => Promise<any>;
    /** Deletes the specified preference by key, if it exists, within the level provided.
     *
     * If both iTwinId and iModelId are provided, the key will be deleted from both levels.
     *
     * If the key does not exist in either level provided, then this function will do nothing.
     *
     * @throws if any error occurs when deleting the preference.
     */
    delete: (arg: PreferenceKeyArg & ITwinIdArg & TokenArg) => Promise<void>;
    /** Saves the provided preference by the key within the provided level.
     *
     * If both iTwinId and iModelId are provided, the key will be saved to both levels.
     *
     * If the key already exists, in either level, the preference will be updated.
     *
     * @throws if any error occurs while saving.
     */
    save: (arg: PreferenceArg & ITwinIdArg & TokenArg) => Promise<void>;
}
//# sourceMappingURL=UserPreferences.d.ts.map