Class WorkplaceRepository

Provides access to workplaces available in the system.

Hierarchy

WorkplaceRepository

Implements

IWorkplaceRepository

Index

Constructors

constructor

new WorkplaceRepository(_metadataRestorer: IWorkplaceMetadataRestorer, _workplaceService: IWorkplaceService, _extensionContainer: null | IExtensionContainer): WorkplaceRepository
Parameters
- _metadataRestorer: IWorkplaceMetadataRestorer
- _workplaceService: IWorkplaceService
- _extensionContainer: null | IExtensionContainer
Returns WorkplaceRepository
- Defined in @tessa/platform/src/workplaces/workplaceRepository.ts:33

Accessors

isInitialized

get isInitialized(): boolean
A flag indicating that the object was successfully initialized.

Returns boolean
Implementation of IWorkplaceRepository.isInitialized
- Defined in @tessa/platform/src/workplaces/workplaceRepository.ts:59

Methods

deleteUserMetadata

deleteUserMetadata(compositionId: string): Promise<void>
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>
Implementation of IWorkplaceRepository.deleteUserMetadata
- Defined in @tessa/platform/src/workplaces/workplaceRepository.ts:144

getAll

getAll(): Promise<readonly IWorkplace[]>
Returns a list of all workplaces.

Returns Promise<readonly IWorkplace[]>
Implementation of IWorkplaceRepository.getAll
- Defined in @tessa/platform/src/workplaces/workplaceRepository.ts:88

getById

getById(id: string): Promise<null | IWorkplace>
Returns the workplace specified by name id.
Parameters
- id: string
  
  Workplace`s id.
Returns Promise<null | IWorkplace>
Implementation of IWorkplaceRepository.getById
- Defined in @tessa/platform/src/workplaces/workplaceRepository.ts:92

getByName

getByName(name: string): Promise<null | IWorkplace>
Returns the workplace specified by name.
Parameters
- name: string
  
  Workplace`s name.
Returns Promise<null | IWorkplace>
Implementation of IWorkplaceRepository.getByName
- Defined in @tessa/platform/src/workplaces/workplaceRepository.ts:96

getByRefSection

getByRefSection(refSection: string): Promise<IWorkplace[]>
Returns a list of workplaces containing views available by reference.
Parameters
- refSection: string
  
  Workplace section.
Returns Promise<IWorkplace[]>
Implementation of IWorkplaceRepository.getByRefSection
- Defined in @tessa/platform/src/workplaces/workplaceRepository.ts:101

getUserMetadata

getUserMetadata(): Promise<IWorkplaceUserExtensionMetadata>
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>
Implementation of IWorkplaceRepository.getUserMetadata
- Defined in @tessa/platform/src/workplaces/workplaceRepository.ts:140

initialize

initialize(workplaces: readonly IWorkplace[]): Promise<void>
Initializes the workplaces repository.
Parameters
- workplaces: readonly IWorkplace[]
  
  Metadata of available workplaces.
Returns Promise<void>
Implementation of IWorkplaceRepository.initialize
- Defined in @tessa/platform/src/workplaces/workplaceRepository.ts:63

saveProperties

saveProperties(properties: readonly IWorkplaceItemProperties[]): 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
- properties: readonly IWorkplaceItemProperties[]
  
  View properties to save.
Returns Promise<void>
Implementation of IWorkplaceRepository.saveProperties
- Defined in @tessa/platform/src/workplaces/workplaceRepository.ts:125

saveWorkplaceSettings

saveWorkplaceSettings(settings: readonly IWorkplaceSettingsMetadata[]): 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
- settings: readonly IWorkplaceSettingsMetadata[]
  
  Workplace settings to save.
Returns Promise<void>
Implementation of IWorkplaceRepository.saveWorkplaceSettings
- Defined in @tessa/platform/src/workplaces/workplaceRepository.ts:116

storeUserMetadataAsync

storeUserMetadataAsync(metadata: IWorkplaceComponentMetadata): 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
- metadata: IWorkplaceComponentMetadata
  
  Metadata extensions to save.
Returns Promise<void>
Implementation of IWorkplaceRepository.storeUserMetadataAsync
- Defined in @tessa/platform/src/workplaces/workplaceRepository.ts:134

Class WorkplaceRepository

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

_metadataRestorer: IWorkplaceMetadataRestorer

_workplaceService: IWorkplaceService

_extensionContainer: null | IExtensionContainer

Returns WorkplaceRepository

Accessors

isInitialized

Returns boolean

Methods

deleteUserMetadata

Parameters

compositionId: string

Returns Promise<void>

getAll

Returns Promise<readonly IWorkplace[]>

getById

Parameters

id: string

Returns Promise<null | IWorkplace>

getByName

Parameters

name: string

Returns Promise<null | IWorkplace>

getByRefSection

Parameters

refSection: string

Returns Promise<IWorkplace[]>

getUserMetadata

Returns Promise<IWorkplaceUserExtensionMetadata>

initialize

Parameters

workplaces: readonly IWorkplace[]

Returns Promise<void>

saveProperties

Parameters

properties: readonly IWorkplaceItemProperties[]

Returns Promise<void>

saveWorkplaceSettings

Parameters

settings: readonly IWorkplaceSettingsMetadata[]

Returns Promise<void>

storeUserMetadataAsync

Parameters

metadata: IWorkplaceComponentMetadata

Returns Promise<void>