Options
All
  • Public
  • Public/Protected
  • All
Menu

Options for managing Team Sharing (whereby Adaptable Objects can be shared between colleagues).

Hierarchy

  • TeamSharingOptions

Index

Properties

enableTeamSharing

enableTeamSharing: boolean

Whether Team Sharing is enabled

default

false

getSharedEntities

getSharedEntities: (adaptableId: string) => Promise<SharedEntity[]>

Function which retrieves any available Shared Entities that the user is able to download (and merge automatically with his Adaptable State)

Type declaration

setSharedEntities

setSharedEntities: (adaptableId: string, sharedEntities: SharedEntity[]) => Promise<void>

Function which saves (essentially uploads) Shared Entities so they can be downloaded (and re-used) by other members of the team

Type declaration

    • (adaptableId: string, sharedEntities: SharedEntity[]): Promise<void>
    • Parameters

      Returns Promise<void>

Generated using TypeDoc