DatalayerCollaborationProvider
Datalayer Core / DatalayerCollaborationProvider
Class: DatalayerCollaborationProvider
Defined in: tech/datalayer/core/src/collaboration/DatalayerCollaborationProvider.ts:44
Datalayer collaboration provider
This provider connects to Datalayer's collaboration service using WebSockets.
Implements
ICollaborationProvider
Constructors
Constructor
new DatalayerCollaborationProvider(
config):DatalayerCollaborationProvider
Defined in: tech/datalayer/core/src/collaboration/DatalayerCollaborationProvider.ts:60
Parameters
config
Returns
DatalayerCollaborationProvider
Properties
type
readonlytype:"datalayer"='datalayer'
Defined in: tech/datalayer/core/src/collaboration/DatalayerCollaborationProvider.ts:45
Provider type identifier
Implementation of
ICollaborationProvider.type
Accessors
events
Get Signature
get events():
ICollaborationProviderEvents
Defined in: tech/datalayer/core/src/collaboration/DatalayerCollaborationProvider.ts:76
Provider events
Returns
ICollaborationProviderEvents
Implementation of
ICollaborationProvider.events
isConnected
Get Signature
get isConnected():
boolean
Defined in: tech/datalayer/core/src/collaboration/DatalayerCollaborationProvider.ts:68
Whether the provider is currently connected
Returns
boolean
Implementation of
ICollaborationProvider.isConnected
isDisposed
Get Signature
get isDisposed():
boolean
Defined in: tech/datalayer/core/src/collaboration/DatalayerCollaborationProvider.ts:72
Test whether the object has been disposed.
Notes
This property is always safe to access.
Returns
boolean
Implementation of
ICollaborationProvider.isDisposed
status
Get Signature
get status():
CollaborationStatus
Defined in: tech/datalayer/core/src/collaboration/DatalayerCollaborationProvider.ts:64
Current connection status
Returns
CollaborationStatus
Implementation of
ICollaborationProvider.status
Methods
connect()
connect(
sharedModel,documentId,options?):Promise<void>
Defined in: tech/datalayer/core/src/collaboration/DatalayerCollaborationProvider.ts:91
Connect to the collaboration service
Parameters
sharedModel
YNotebook
The shared notebook model
documentId
string
Document identifier
options?
Record<string, any>
Additional connection options
Returns
Promise<void>
Promise that resolves when connected
Implementation of
ICollaborationProvider.connect
disconnect()
disconnect():
void
Defined in: tech/datalayer/core/src/collaboration/DatalayerCollaborationProvider.ts:162
Disconnect from the collaboration service
Returns
void
Implementation of
ICollaborationProvider.disconnect
dispose()
dispose():
void
Defined in: tech/datalayer/core/src/collaboration/DatalayerCollaborationProvider.ts:203
Dispose of the resources held by the object.
Notes
If the object's dispose method is called more than once, all
calls made after the first will be a no-op.
Undefined Behavior
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.
Returns
void
Implementation of
ICollaborationProvider.dispose
getProvider()
getProvider():
null|WebsocketProvider
Defined in: tech/datalayer/core/src/collaboration/DatalayerCollaborationProvider.ts:177
Get the underlying WebSocket provider
Returns
null | WebsocketProvider
The WebSocket provider or null if not connected
Implementation of
ICollaborationProvider.getProvider
getSharedModel()
getSharedModel():
null|YNotebook
Defined in: tech/datalayer/core/src/collaboration/DatalayerCollaborationProvider.ts:181
Get the shared model
Returns
null | YNotebook
The shared model or null if not connected
Implementation of
ICollaborationProvider.getSharedModel
handleConnectionClose()
handleConnectionClose(
event):void
Defined in: tech/datalayer/core/src/collaboration/DatalayerCollaborationProvider.ts:185
Handle connection close event
Parameters
event
CloseEvent
Close event
Returns
void
Implementation of
ICollaborationProvider.handleConnectionClose
handleSync()
handleSync(
isSynced):void
Defined in: tech/datalayer/core/src/collaboration/DatalayerCollaborationProvider.ts:196
Handle synchronization event
Parameters
isSynced
boolean
Whether the document is synchronized
Returns
void
Implementation of
ICollaborationProvider.handleSync