IDeltaConnection Interface
Packages > @fluidframework/datastore-definitions > IDeltaConnection
Interface to represent a connection to a delta notification stream.
Signature:
export interface IDeltaConnection
Properties
| Property | Type | Description |
|---|---|---|
| connected | boolean |
Methods
| Method | Description |
|---|---|
| attach(handler) | Attaches a message handler to the delta connection |
| dirty() | Indicates that the channel is dirty and needs to be part of the summary. It is called by a SharedSummaryBlock that needs to be part of the summary but does not generate ops. |
| submit(messageContent, localOpMetadata) | Send new messages to the server. |
Events
connected
Signature:
connected: boolean;
Methods
attach
Attaches a message handler to the delta connection
Signature:
attach(handler: IDeltaHandler): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| handler | IDeltaHandler |
Returns:
void
dirty
Indicates that the channel is dirty and needs to be part of the summary. It is called by a SharedSummaryBlock that needs to be part of the summary but does not generate ops.
Signature:
dirty(): void;
Returns:
void
submit
Send new messages to the server.
Signature:
submit(messageContent: any, localOpMetadata: unknown): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| messageContent | any | The content of the message to be sent. |
| localOpMetadata | unknown | The local metadata associated with the message. This is kept locally by the runtime and not sent to the server. It will be provided back when this message is acknowledged by the server. It will also be provided back when asked to resubmit the message. |
Returns:
void