Class WorkplaceUserExtensionMetadata

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

Hierarchy (View Summary)

WorkplaceCompositeMetadata
- WorkplaceUserExtensionMetadata

Implements

IWorkplaceUserExtensionMetadata

Index

Constructors

constructor

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

Properties

alias

alias: string = ''

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

expandedIconName

expandedIconName: string = ''

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

`Readonly`formatVersion

formatVersion: 4 = WorkplaceMetadata.currentFormatVersion

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

iconName

iconName: string = ''

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

isOwnedByUser

isOwnedByUser: boolean = false

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

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:61
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:64

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:45

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:64

roles

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

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

typeName

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

Returns string
Implementation of IWorkplaceUserExtensionMetadata.typeName
Inherited from WorkplaceCompositeMetadata.typeName
- Defined in @tessa/platform/src/workplaces/metadata/workplaceComponentMetadata.ts:70

workplaceSettings

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

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

Methods

clone

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

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

deserializeFromStorage

deserializeFromStorage(
storage: IStorage,
context?: StorageSerializableContext,
): this
Parameters
- storage: IStorage
- Optionalcontext: StorageSerializableContext
Returns this
Implementation of IWorkplaceUserExtensionMetadata.deserializeFromStorage
Inherited from WorkplaceCompositeMetadata.deserializeFromStorage
- Defined in @tessa/core/src/serialization/storageSerializableObject.ts:41

isSealed

isSealed(): boolean
Returns boolean
Implementation of IWorkplaceUserExtensionMetadata.isSealed
Inherited from WorkplaceCompositeMetadata.isSealed
- Defined in @tessa/core/src/serialization/storageSerializableObject.ts:89

seal

seal(): this
Returns this
Implementation of IWorkplaceUserExtensionMetadata.seal
Inherited from WorkplaceCompositeMetadata.seal
- Defined in @tessa/core/src/serialization/storageSerializableObject.ts:72

serializeToStorage

serializeToStorage(
storage?: IStorage,
context?: StorageSerializableContext,
): IStorage
Parameters
- storage: IStorage = {}
- Optionalcontext: StorageSerializableContext
Returns IStorage
Implementation of IWorkplaceUserExtensionMetadata.serializeToStorage
Inherited from WorkplaceCompositeMetadata.serializeToStorage
- Defined in @tessa/core/src/serialization/storageSerializableObject.ts:28

visit

visit(visitor: IWorkplaceMetadataVisitor): void
Parameters
- visitor: IWorkplaceMetadataVisitor
Returns void
Deprecated
use visitAsync
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 (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns WorkplaceUserExtensionMetadata

Properties

alias

expandedIconName

ReadonlyformatVersion

iconName

isOwnedByUser

orderPos

Deprecated

parentCompositionId

userSettingsLastUpdate

Accessors

compositionId

Returns string

Parameters

Returns void

extensions

Returns IDictionary<IViewExtensionMetadata>

items

Returns IList<IWorkplaceComponentMetadata>

properties

Returns IReadonlyList<IWorkplaceItemProperties>

roles

Returns IRoleLink[]

Parameters

Returns void

typeName

Returns string

workplaceSettings

Returns IReadonlyList<IWorkplaceSettingsMetadata>

Methods

clone

Returns WorkplaceUserExtensionMetadata

deserializeFromStorage

Parameters

Returns this

isSealed

Returns boolean

seal

Returns this

serializeToStorage

Parameters

Returns IStorage

visit

Parameters

Returns void

Deprecated

visitAsync

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`formatVersion