AdaptableSharedEntity
Defines an AdaptableObject shared with Team Sharing
TypeScript
export interface AdaptableSharedEntity extendsExtends
Properties
| Property | Type | Description |
|---|---|---|
| ChangedAt | number | Last time when the object was changed |
| ChangedBy | string | Last User who changed the object |
| Description | string | Description of object being shared |
| Entity | AdaptableObject | Actual Adaptable Object being shared |
| EntityDependencyIds | TypeUuid[] | Ids of direct entity dependencies |
| EntityType | 'adaptableEntity' | Type of shared entity (either Adaptable specific or custom object) |
| Module | AdaptableModule | Adaptable Module to which object belongs |
| Revision | number | Revision - incremental for 'Active', always 1 for 'Snapshot' |
| Timestamp | number | When the object was shared |
| Type | SharedEntityType | 'Snapshot' (for 1-time sharing) or 'Active' (for continuous sharing) |
| UserName | string | User who shared the object |
| IsReadOnly | boolean | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
Property Details
ChangedAt
Last time when the object was changed
TypeScript
ChangedAt: number;Property Value
number
ChangedBy
Last User who changed the object
TypeScript
ChangedBy: string;Property Value
string
Description
Description of object being shared
TypeScript
Description: string;Property Value
string
Entity
Actual Adaptable Object being shared
TypeScript
Entity: AdaptableObject;Property Value
EntityDependencyIds
Ids of direct entity dependencies
TypeScript
EntityDependencyIds: TypeUuid[];Property Value
TypeUuid[]
EntityType
Type of shared entity (either Adaptable specific or custom object)
TypeScript
EntityType: 'adaptableEntity';Property Value
'adaptableEntity'
Module
Adaptable Module to which object belongs
TypeScript
Module: AdaptableModule;Property Value
Revision
Revision - incremental for 'Active', always 1 for 'Snapshot'
TypeScript
Revision: number;Property Value
number
Timestamp
When the object was shared
TypeScript
Timestamp: number;Property Value
number
Type
'Snapshot' (for 1-time sharing) or 'Active' (for continuous sharing)
TypeScript
Type: SharedEntityType;Property Value
UserName
User who shared the object
TypeScript
UserName: string;Property Value
string
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
TypeScript
IsReadOnly?: boolean;Property Value
boolean