TeamSharingOptions

View as Markdown

Options for managing Team Sharing - which enables Adaptable Objects to be shared between colleagues

TypeScript
export interface

Properties

PropertyTypeDescriptionDefault
applySharedEntities(sharedEntities:SharedEntity[], context:SharedEntitiesContext) =>SharedEntity[]Allows hooking into Shared Entities loading process
enableTeamSharingbooleanWhether Team Sharing is enabledfalse
handleCustomSharedEntityImport(sharedEntity:CustomSharedEntity, context:SharedEntitiesContext) => voidHandles import of Custom Shared Entities
loadSharedEntities(context:SharedEntitiesContext) => Promise<SharedEntity[]>(Async) Loads available Shared Entities - user can download and auto-merge with Adaptable Statenull
persistMigratedSharedEntitiesbooleanWhen 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.
true
persistSharedEntities(sharedEntities:SharedEntity[], context:SharedEntitiesContext) => Promise<void>(Async) Persists Shared Entities so that they can be downloaded by other team membersnull
saveSharedEntities(sharedEntities:SharedEntity[], context:SharedEntitiesContext) =>SharedEntity[]Allows hooking into Shared Entities persistence process
showUpdateNotificationOncePerUpdatebooleanWhether to show update notification once per updatefalse
suppressOverrideConfigWarningbooleanSuppress warning when an Import overrides existing Adaptable State itemfalse
updateIntervalnumberFrequency (in minutes) to check if Active Shared Entities have a newer revision0 (never)
updateNotification'Alert' | 'AlertWithNotification' | 'SystemStatus'How user is informed when Active Shared Entities have newer revisionsnull (none)

Property Details

applySharedEntities

Allows hooking into Shared Entities loading process

TypeScript
applySharedEntities?: (sharedEntities: SharedEntity[], context: SharedEntitiesContext) => SharedEntity[];
Property Value

(sharedEntities:SharedEntity[], context:SharedEntitiesContext) =>SharedEntity[]

enableTeamSharing

Whether Team Sharing is enabled

TypeScript
enableTeamSharing: boolean;
Default Value

false

Property Value

boolean

handleCustomSharedEntityImport

Handles import of Custom Shared Entities

TypeScript
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

TypeScript
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.

TypeScript
persistMigratedSharedEntities?: boolean;
Default Value

true

Property Value

boolean

persistSharedEntities

(Async) Persists Shared Entities so that they can be downloaded by other team members

TypeScript
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

TypeScript
saveSharedEntities?: (sharedEntities: SharedEntity[], context: SharedEntitiesContext) => SharedEntity[];
Property Value

(sharedEntities:SharedEntity[], context:SharedEntitiesContext) =>SharedEntity[]

showUpdateNotificationOncePerUpdate

Whether to show update notification once per update

TypeScript
showUpdateNotificationOncePerUpdate?: boolean;
Default Value

false

Property Value

boolean

suppressOverrideConfigWarning

Suppress warning when an Import overrides existing Adaptable State item

TypeScript
suppressOverrideConfigWarning?: boolean;
Default Value

false

Property Value

boolean

updateInterval

Frequency (in minutes) to check if Active Shared Entities have a newer revision

TypeScript
updateInterval?: number;
Default Value

0 (never)

Property Value

number

updateNotification

How user is informed when Active Shared Entities have newer revisions

TypeScript
updateNotification?: 'Alert' | 'AlertWithNotification' | 'SystemStatus';
Default Value

null (none)

Property Value

'Alert' | 'AlertWithNotification' | 'SystemStatus'