Class WorkplaceUserExtensionMetadata

Метаданные корневого элемента пользовательских расширений рабочего места.

Hierarchy

WorkplaceCompositeMetadata
- WorkplaceUserExtensionMetadata

Implements

IWorkplaceUserExtensionMetadata

Index

Constructors

constructor

new WorkplaceUserExtensionMetadata(): WorkplaceUserExtensionMetadata
Returns WorkplaceUserExtensionMetadata
Overrides WorkplaceCompositeMetadata.constructor
- Defined in @tessa/platform/src/workplaces/metadata/workplaceUserExtensionMetadata.ts:34

Properties

alias

alias: string = ''

Алиас элемента метаданных.

expandedIconName

expandedIconName: string = ''

Имя значка отображаемого в развернутом режиме.

`Readonly` formatVersion

formatVersion: 2 = 2

Версия формата JSON.

iconName

iconName: string = ''

Имя значка отображаемого в обычном режиме.

isOwnedByUser

isOwnedByUser: boolean = false

Владельцем является текущий пользователь.

nodeClientVisibility

nodeClientVisibility: NodeClientVisibility = NodeClientVisibility.Always

Видимость узла для клиентского приложения.

orderPos

orderPos: number = 0

Номер позиции элемента в списке.

Deprecated

parentCompositionId

parentCompositionId: string = Guid.empty

Идентификатор родительского элемента метаданных.

userSettingsLastUpdate

userSettingsLastUpdate: string = ...

Дата время последнего обновления.

Accessors

compositionId

get compositionId(): string
Уникальный идентификатор элемента.

Returns string
Implementation of IWorkplaceUserExtensionMetadata.compositionId

Inherited from WorkplaceCompositeMetadata.compositionId
- Defined in @tessa/platform/src/workplaces/metadata/workplaceComponentMetadata.ts:57
set compositionId(value: string): void
Уникальный идентификатор элемента.
Parameters
- value: string
Returns void
Implementation of IWorkplaceUserExtensionMetadata.compositionId

Inherited from WorkplaceCompositeMetadata.compositionId
- Defined in @tessa/platform/src/workplaces/metadata/workplaceComponentMetadata.ts:60

extensions

get extensions(): IDictionary<IViewExtensionMetadata>
Список имен типов расширений.

Returns IDictionary<IViewExtensionMetadata>
Implementation of IWorkplaceUserExtensionMetadata.extensions

Inherited from WorkplaceCompositeMetadata.extensions
- Defined in @tessa/platform/src/workplaces/metadata/workplaceComponentMetadata.ts:49

items

get items(): IList<IWorkplaceComponentMetadata>
Вложенные элементы.

Returns IList<IWorkplaceComponentMetadata>
Implementation of IWorkplaceUserExtensionMetadata.items

Inherited from WorkplaceCompositeMetadata.items
- Defined in @tessa/platform/src/workplaces/metadata/workplaceCompositeMetadata.ts:31

properties

get properties(): IReadonlyList<IWorkplaceItemProperties>
Свойства элементов рабочего места.

Returns IReadonlyList<IWorkplaceItemProperties>
Implementation of IWorkplaceUserExtensionMetadata.properties
- Defined in @tessa/platform/src/workplaces/metadata/workplaceUserExtensionMetadata.ts:63

roles

get roles(): IRoleLink[]
Список ролей.

Returns IRoleLink[]
Implementation of IWorkplaceUserExtensionMetadata.roles
- Defined in @tessa/platform/src/workplaces/metadata/workplaceUserExtensionMetadata.ts:54
set roles(value: IRoleLink[]): void
Список ролей.
Parameters
- value: IRoleLink[]
Returns void
Implementation of IWorkplaceUserExtensionMetadata.roles
- Defined in @tessa/platform/src/workplaces/metadata/workplaceUserExtensionMetadata.ts:57

typeName

get typeName(): string
Имя типа на серверной стороне.

Returns string
Implementation of IWorkplaceUserExtensionMetadata.typeName

Inherited from WorkplaceCompositeMetadata.typeName
- Defined in @tessa/platform/src/workplaces/metadata/workplaceComponentMetadata.ts:68

workplaceSettings

get workplaceSettings(): IReadonlyList<IWorkplaceSettingsMetadata>
Настройки рабочих мест.

Returns IReadonlyList<IWorkplaceSettingsMetadata>
Implementation of IWorkplaceUserExtensionMetadata.workplaceSettings
- Defined in @tessa/platform/src/workplaces/metadata/workplaceUserExtensionMetadata.ts:69

Methods

clone

clone(): WorkplaceUserExtensionMetadata
Создает новый объект, который является копией текущего экземпляра.

Returns WorkplaceUserExtensionMetadata
Implementation of IWorkplaceUserExtensionMetadata.clone
- Defined in @tessa/platform/src/workplaces/metadata/workplaceUserExtensionMetadata.ts:125

deserializeFromStorage

deserializeFromStorage(storage: IStorage<unknown>, context?: StorageSerializableContext): WorkplaceUserExtensionMetadata
Parameters
- storage: IStorage<unknown>
- Optional context: StorageSerializableContext
Returns WorkplaceUserExtensionMetadata
Implementation of IWorkplaceUserExtensionMetadata.deserializeFromStorage

Inherited from WorkplaceCompositeMetadata.deserializeFromStorage
- Defined in @tessa/core/src/serialization/storageSerializable.ts:54

isSealed

isSealed(): boolean
Returns boolean
Implementation of IWorkplaceUserExtensionMetadata.isSealed

Inherited from WorkplaceCompositeMetadata.isSealed
- Defined in @tessa/core/src/serialization/storageSerializable.ts:102

seal

seal(): WorkplaceUserExtensionMetadata
Returns WorkplaceUserExtensionMetadata
Implementation of IWorkplaceUserExtensionMetadata.seal

Inherited from WorkplaceCompositeMetadata.seal
- Defined in @tessa/core/src/serialization/storageSerializable.ts:85

serializeToStorage

serializeToStorage(storage?: IStorage<unknown>, context?: StorageSerializableContext): IStorage<unknown>
Parameters
- storage: IStorage<unknown> = {}
- Optional context: StorageSerializableContext
Returns IStorage<unknown>
Implementation of IWorkplaceUserExtensionMetadata.serializeToStorage

Inherited from WorkplaceCompositeMetadata.serializeToStorage
- Defined in @tessa/core/src/serialization/storageSerializable.ts:44

visit

visit(visitor: IWorkplaceMetadataVisitor): void
Deprecated
use visitAsync
Parameters
- visitor: IWorkplaceMetadataVisitor
Returns void
Implementation of IWorkplaceUserExtensionMetadata.visit

Inherited from WorkplaceCompositeMetadata.visit
- Defined in @tessa/platform/src/workplaces/metadata/workplaceCompositeMetadata.ts:67

visitAsync

visitAsync(visitor: IWorkplaceMetadataVisitorAsync): Promise<void>
Выполняет проход по дереву рабочих мест.
Parameters
- visitor: IWorkplaceMetadataVisitorAsync
  
  Объект, выполняющий операции над узлами.
Returns Promise<void>
Implementation of IWorkplaceUserExtensionMetadata.visitAsync

Inherited from WorkplaceCompositeMetadata.visitAsync
- Defined in @tessa/platform/src/workplaces/metadata/workplaceCompositeMetadata.ts:42

Class WorkplaceUserExtensionMetadata

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns WorkplaceUserExtensionMetadata

Properties

alias

expandedIconName

Readonly formatVersion

iconName

isOwnedByUser

nodeClientVisibility

orderPos

Deprecated

parentCompositionId

userSettingsLastUpdate

Accessors

compositionId

Returns string

Parameters

value: string

Returns void

extensions

Returns IDictionary<IViewExtensionMetadata>

items

Returns IList<IWorkplaceComponentMetadata>

properties

Returns IReadonlyList<IWorkplaceItemProperties>

roles

Returns IRoleLink[]

Parameters

value: IRoleLink[]

Returns void

typeName

Returns string

workplaceSettings

Returns IReadonlyList<IWorkplaceSettingsMetadata>

Methods

clone

Returns WorkplaceUserExtensionMetadata

deserializeFromStorage

Parameters

storage: IStorage<unknown>

Optional context: StorageSerializableContext

Returns WorkplaceUserExtensionMetadata

isSealed

Returns boolean

seal

Returns WorkplaceUserExtensionMetadata

serializeToStorage

Parameters

storage: IStorage<unknown> = {}

Optional context: StorageSerializableContext

Returns IStorage<unknown>

visit

Deprecated

Parameters

visitor: IWorkplaceMetadataVisitor

Returns void

visitAsync

Parameters

visitor: IWorkplaceMetadataVisitorAsync

Returns Promise<void>

`Readonly` formatVersion

`Optional` context: StorageSerializableContext

`Optional` context: StorageSerializableContext