TeamSharingOptions
Options for managing Team Sharing - which enables Adaptable Objects to be shared between colleagues
export interfaceProperties
| Property | Type | Description | Default |
|---|---|---|---|
| applySharedEntities | (sharedEntities:SharedEntity[], context:SharedEntitiesContext) =>SharedEntity[] | Allows hooking into Shared Entities loading process | |
| enableTeamSharing | boolean | Whether Team Sharing is enabled | false |
| handleCustomSharedEntityImport | (sharedEntity:CustomSharedEntity, context:SharedEntitiesContext) => void | Handles import of Custom Shared Entities | |
| loadSharedEntities | (context:SharedEntitiesContext) => Promise<SharedEntity[]> | (Async) Loads available Shared Entities - user can download and auto-merge with Adaptable State | null |
| persistMigratedSharedEntities | boolean | When true (the default), a user with full Team Sharing rights writes sharedentities back once per grid session after they are migrated on load, so the server copy matches the current shape. That write does not change Revisionor ChangedAt.Set to false when the server is read-only for most users. | true |
| persistSharedEntities | (sharedEntities:SharedEntity[], context:SharedEntitiesContext) => Promise<void> | (Async) Persists Shared Entities so that they can be downloaded by other team members | null |
| saveSharedEntities | (sharedEntities:SharedEntity[], context:SharedEntitiesContext) =>SharedEntity[] | Allows hooking into Shared Entities persistence process | |
| showUpdateNotificationOncePerUpdate | boolean | Whether to show update notification once per update | false |
| suppressOverrideConfigWarning | boolean | Suppress warning when an Import overrides existing Adaptable State item | false |
| updateInterval | number | Frequency (in minutes) to check if Active Shared Entities have a newer revision | 0 (never) |
| updateNotification | 'Alert' | 'AlertWithNotification' | 'SystemStatus' | How user is informed when Active Shared Entities have newer revisions | null (none) |
Property Details
applySharedEntities
Allows hooking into Shared Entities loading process
applySharedEntities?: (sharedEntities: SharedEntity[], context: SharedEntitiesContext) => SharedEntity[];Property Value
(sharedEntities:SharedEntity[], context:SharedEntitiesContext) =>SharedEntity[]
enableTeamSharing
Whether Team Sharing is enabled
enableTeamSharing: boolean;Default Value
false
Property Value
boolean
handleCustomSharedEntityImport
Handles import of Custom Shared Entities
handleCustomSharedEntityImport?: (sharedEntity: CustomSharedEntity, context: SharedEntitiesContext) => void;Property Value
(sharedEntity:CustomSharedEntity, context:SharedEntitiesContext) => void
loadSharedEntities
(Async) Loads available Shared Entities - user can download and auto-merge with Adaptable State
loadSharedEntities: (context: SharedEntitiesContext) => Promise<SharedEntity[]>;Default Value
null
Property Value
(context:SharedEntitiesContext) => Promise<SharedEntity[]>
persistMigratedSharedEntities
When true (the default), a user with full Team Sharing rights writes shared
entities back once per grid session after they are migrated on load, so the
server copy matches the current shape. That write does not change Revision
or ChangedAt.
Set to false when the server is read-only for most users.
persistMigratedSharedEntities?: boolean;Default Value
true
Property Value
boolean
persistSharedEntities
(Async) Persists Shared Entities so that they can be downloaded by other team members
persistSharedEntities: (sharedEntities: SharedEntity[], context: SharedEntitiesContext) => Promise<void>;Default Value
null
Property Value
(sharedEntities:SharedEntity[], context:SharedEntitiesContext) => Promise<void>
saveSharedEntities
Allows hooking into Shared Entities persistence process
saveSharedEntities?: (sharedEntities: SharedEntity[], context: SharedEntitiesContext) => SharedEntity[];Property Value
(sharedEntities:SharedEntity[], context:SharedEntitiesContext) =>SharedEntity[]
showUpdateNotificationOncePerUpdate
Whether to show update notification once per update
showUpdateNotificationOncePerUpdate?: boolean;Default Value
false
Property Value
boolean
suppressOverrideConfigWarning
Suppress warning when an Import overrides existing Adaptable State item
suppressOverrideConfigWarning?: boolean;Default Value
false
Property Value
boolean
updateInterval
Frequency (in minutes) to check if Active Shared Entities have a newer revision
updateInterval?: number;Default Value
0 (never)
Property Value
number
updateNotification
How user is informed when Active Shared Entities have newer revisions
updateNotification?: 'Alert' | 'AlertWithNotification' | 'SystemStatus';Default Value
null (none)
Property Value
'Alert' | 'AlertWithNotification' | 'SystemStatus'