# TeamSharingOptions

Canonical page: https://www.adaptabletools.com/docs/reference/teamsharingoptions

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

```ts title="TypeScript"
export interface TeamSharingOptions 
```

## Properties

| Property | Type | Description | Default |
| --- | --- | --- | --- |
| [applySharedEntities](https://www.adaptabletools.com/docs/reference/teamsharingoptions.md#applysharedentities) | `(sharedEntities: `[`SharedEntity`](https://www.adaptabletools.com/docs/reference/sharedentity.md)`[], context: `[`SharedEntitiesContext`](https://www.adaptabletools.com/docs/reference/sharedentitiescontext.md)`) => `[`SharedEntity`](https://www.adaptabletools.com/docs/reference/sharedentity.md)`[]` | Allows hooking into Shared Entities loading process |   |
| [enableTeamSharing](https://www.adaptabletools.com/docs/reference/teamsharingoptions.md#enableteamsharing) | `boolean` | Whether Team Sharing is enabled | false |
| [handleCustomSharedEntityImport](https://www.adaptabletools.com/docs/reference/teamsharingoptions.md#handlecustomsharedentityimport) | `(sharedEntity: `[`CustomSharedEntity`](https://www.adaptabletools.com/docs/reference/customsharedentity.md)`, context: `[`SharedEntitiesContext`](https://www.adaptabletools.com/docs/reference/sharedentitiescontext.md)`) => void` | Handles import of Custom Shared Entities |   |
| [loadSharedEntities](https://www.adaptabletools.com/docs/reference/teamsharingoptions.md#loadsharedentities) | `(context: `[`SharedEntitiesContext`](https://www.adaptabletools.com/docs/reference/sharedentitiescontext.md)`) => Promise<`[`SharedEntity`](https://www.adaptabletools.com/docs/reference/sharedentity.md)`[]>` | (Async) Loads available Shared Entities - user can download and auto-merge with Adaptable State | null |
| [persistMigratedSharedEntities](https://www.adaptabletools.com/docs/reference/teamsharingoptions.md#persistmigratedsharedentities) | `boolean` | When `true` (the default), a user with full Team Sharing rights writes shared<br/>entities back once per grid session after they are migrated on load, so the<br/>server copy matches the current shape. That write does not change `Revision`<br/>or `ChangedAt`.<br/><br/>Set to `false` when the server is read-only for most users. | true |
| [persistSharedEntities](https://www.adaptabletools.com/docs/reference/teamsharingoptions.md#persistsharedentities) | `(sharedEntities: `[`SharedEntity`](https://www.adaptabletools.com/docs/reference/sharedentity.md)`[], context: `[`SharedEntitiesContext`](https://www.adaptabletools.com/docs/reference/sharedentitiescontext.md)`) => Promise<void>` | (Async) Persists Shared Entities so that they can be downloaded by other team members | null |
| [saveSharedEntities](https://www.adaptabletools.com/docs/reference/teamsharingoptions.md#savesharedentities) | `(sharedEntities: `[`SharedEntity`](https://www.adaptabletools.com/docs/reference/sharedentity.md)`[], context: `[`SharedEntitiesContext`](https://www.adaptabletools.com/docs/reference/sharedentitiescontext.md)`) => `[`SharedEntity`](https://www.adaptabletools.com/docs/reference/sharedentity.md)`[]` | Allows hooking into Shared Entities persistence process |   |
| [showUpdateNotificationOncePerUpdate](https://www.adaptabletools.com/docs/reference/teamsharingoptions.md#showupdatenotificationonceperupdate) | `boolean` | Whether to show update notification once per update | false |
| [suppressOverrideConfigWarning](https://www.adaptabletools.com/docs/reference/teamsharingoptions.md#suppressoverrideconfigwarning) | `boolean` | Suppress warning when an Import overrides existing Adaptable State item | false |
| [updateInterval](https://www.adaptabletools.com/docs/reference/teamsharingoptions.md#updateinterval) | `number` | Frequency (in minutes) to check if Active Shared Entities have a newer revision | 0 (never) |
| [updateNotification](https://www.adaptabletools.com/docs/reference/teamsharingoptions.md#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

```ts title="TypeScript"
applySharedEntities?: (sharedEntities: SharedEntity[], context: SharedEntitiesContext) => SharedEntity[];
```

###### Property Value

`(sharedEntities: `[`SharedEntity`](https://www.adaptabletools.com/docs/reference/sharedentity.md)`[], context: `[`SharedEntitiesContext`](https://www.adaptabletools.com/docs/reference/sharedentitiescontext.md)`) => `[`SharedEntity`](https://www.adaptabletools.com/docs/reference/sharedentity.md)`[]`

### enableTeamSharing

Whether Team Sharing is enabled

```ts title="TypeScript"
enableTeamSharing: boolean;
```

###### Default Value

false

###### Property Value

`boolean`

### handleCustomSharedEntityImport

Handles import of Custom Shared Entities

```ts title="TypeScript"
handleCustomSharedEntityImport?: (sharedEntity: CustomSharedEntity, context: SharedEntitiesContext) => void;
```

###### Property Value

`(sharedEntity: `[`CustomSharedEntity`](https://www.adaptabletools.com/docs/reference/customsharedentity.md)`, context: `[`SharedEntitiesContext`](https://www.adaptabletools.com/docs/reference/sharedentitiescontext.md)`) => void`

### loadSharedEntities

(Async) Loads available Shared Entities - user can download and auto-merge with Adaptable State

```ts title="TypeScript"
loadSharedEntities: (context: SharedEntitiesContext) => Promise<SharedEntity[]>;
```

###### Default Value

null

###### Property Value

`(context: `[`SharedEntitiesContext`](https://www.adaptabletools.com/docs/reference/sharedentitiescontext.md)`) => Promise<`[`SharedEntity`](https://www.adaptabletools.com/docs/reference/sharedentity.md)`[]>`

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

```ts title="TypeScript"
persistMigratedSharedEntities?: boolean;
```

###### Default Value

true

###### Property Value

`boolean`

### persistSharedEntities

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

```ts title="TypeScript"
persistSharedEntities: (sharedEntities: SharedEntity[], context: SharedEntitiesContext) => Promise<void>;
```

###### Default Value

null

###### Property Value

`(sharedEntities: `[`SharedEntity`](https://www.adaptabletools.com/docs/reference/sharedentity.md)`[], context: `[`SharedEntitiesContext`](https://www.adaptabletools.com/docs/reference/sharedentitiescontext.md)`) => Promise<void>`

### saveSharedEntities

Allows hooking into Shared Entities persistence process

```ts title="TypeScript"
saveSharedEntities?: (sharedEntities: SharedEntity[], context: SharedEntitiesContext) => SharedEntity[];
```

###### Property Value

`(sharedEntities: `[`SharedEntity`](https://www.adaptabletools.com/docs/reference/sharedentity.md)`[], context: `[`SharedEntitiesContext`](https://www.adaptabletools.com/docs/reference/sharedentitiescontext.md)`) => `[`SharedEntity`](https://www.adaptabletools.com/docs/reference/sharedentity.md)`[]`

### showUpdateNotificationOncePerUpdate

Whether to show update notification once per update

```ts title="TypeScript"
showUpdateNotificationOncePerUpdate?: boolean;
```

###### Default Value

false

###### Property Value

`boolean`

### suppressOverrideConfigWarning

Suppress warning when an Import overrides existing Adaptable State item

```ts title="TypeScript"
suppressOverrideConfigWarning?: boolean;
```

###### Default Value

false

###### Property Value

`boolean`

### updateInterval

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

```ts title="TypeScript"
updateInterval?: number;
```

###### Default Value

0 (never)

###### Property Value

`number`

### updateNotification

How user is informed when Active Shared Entities have newer revisions

```ts title="TypeScript"
updateNotification?: 'Alert' | 'AlertWithNotification' | 'SystemStatus';
```

###### Default Value

null (none)

###### Property Value

`'Alert' | 'AlertWithNotification' | 'SystemStatus'`
