TESSA Web API
    Preparing search index...

    Interface IWorkplaceService

    interface IWorkplaceService {
        deleteUserMetadata(compositionId: string): Promise<void>;
        getAllWorkplaces(): Promise<IWorkplaceMetadata[]>;
        getUserMetadata(): Promise<IWorkplaceUserExtensionMetadata>;
        getWorkplaceById(id: string): Promise<null | IWorkplaceMetadata>;
        saveProperties(
            properties: readonly IWorkplaceItemProperties[],
        ): Promise<void>;
        saveWorkplaceSettings(
            settings: readonly IWorkplaceSettingsMetadata[],
        ): Promise<void>;
        storeUserMetadataAsync(
            metadata: IWorkplaceComponentMetadata,
        ): Promise<void>;
    }

    Implemented by

    Index

    Methods

    deleteUserMetadata getAllWorkplaces getUserMetadata getWorkplaceById saveProperties saveWorkplaceSettings storeUserMetadataAsync

    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>

    • Get metadata for all the workplaces accessible by current user. Returned metadata can be used to show workplace to the user, but not to modify it.

      Returns Promise<IWorkplaceMetadata[]>

    • 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>

    • Get metadata for specified workplace. It has to be accessible by current user. Returned metadata can be used to show workplace to the user, but not to modify it.

      Parameters

      • id: string

        Identifier of workplace to get.

      Returns Promise<null | IWorkplaceMetadata>

    • 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

    Methods