TESSA Web API
    Preparing search index...

    Interface IWorkplaceRepository

    Provides access to workplaces available in the system.

    interface IWorkplaceRepository {
        isInitialized: boolean;
        deleteUserMetadata(compositionId: string): Promise<void>;
        getAll(): Promise<readonly IWorkplace[]>;
        getById(id: string): Promise<null | IWorkplace>;
        getByName(name: string): Promise<null | IWorkplace>;
        getByRefSection(refSection: string): Promise<IWorkplace[]>;
        getUserMetadata(): Promise<IWorkplaceUserExtensionMetadata>;
        initialize(workplaces: readonly IWorkplace[]): Promise<void>;
        saveProperties(
            properties: readonly IWorkplaceItemProperties[],
        ): Promise<void>;
        saveWorkplaceSettings(
            settings: readonly IWorkplaceSettingsMetadata[],
        ): Promise<void>;
        storeUserMetadataAsync(
            metadata: IWorkplaceComponentMetadata,
        ): Promise<void>;
    }

    Implemented by

    Index

    Properties

    isInitialized

    Methods

    deleteUserMetadata getAll getById getByName getByRefSection getUserMetadata initialize saveProperties saveWorkplaceSettings storeUserMetadataAsync

    Properties

    isInitialized: boolean

    A flag indicating that the object was successfully initialized.

    Methods

    • Delete current user's metadata extensions, such as info on added search queries, by composition identifier (workplace id, tree node id, etc.).

      Parameters

      • compositionId: string

        Composition identifier to delete.

      Returns Promise<void>

    • Returns a list of all workplaces.

      Returns Promise<readonly IWorkplace[]>

    • Returns the workplace specified by name id.

      Parameters

      • id: string

        Workplace`s id.

      Returns Promise<null | IWorkplace>

    • Returns the workplace specified by name.

      Parameters

      • name: string

        Workplace`s name.

      Returns Promise<null | IWorkplace>

    • Returns a list of workplaces containing views available by reference.

      Parameters

      • refSection: string

        Workplace section.

      Returns Promise<IWorkplace[]>

    • Get current user's metadata extensions for all accessible workplaces, such as info on private search queries. Its unavailable for other users.

      Returns Promise<IWorkplaceUserExtensionMetadata>

    • Initializes the workplaces repository.

      Parameters

      • workplaces: readonly IWorkplace[]

        Metadata of available workplaces.

      Returns Promise<void>

    • Save current user's view properties, including sorting and grouping options, columns visibility settings, relative area sizes in master-detail views, etc. Properties are unavailable for other users.

      Parameters

      Returns Promise<void>

    • Save current user's settings for specified workplaces, including tree width, option to show empty folders, etc. Settings are unavailable for other users.

      Parameters

      Returns Promise<void>

    • Save current user's metadata extensions for a workplace: add search query or folder to workplace tree, etc. Its unavailable for other users.

      Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods