Skip to main content

IDeltaConnection Interface

Interface to represent a connection to a delta notification stream.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/datastore-definitions/legacy.

For more information about our API support guarantees, see here.

Signature​

export interface IDeltaConnection

Properties​

Property Alerts Type Description
connected Alpha boolean

Methods​

Method Alerts Return Type Description
attach(handler) Alpha void Attaches a message handler to the delta connection
dirty() Alpha void 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) Alpha void Send new messages to the server.

Property Details​

connected​

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/datastore-definitions/alpha.

For more information about our API support guarantees, see here.

Signature​

connected: boolean;

Type: boolean

Method Details​

attach​

Attaches a message handler to the delta connection

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/datastore-definitions/alpha.

For more information about our API support guarantees, see here.

Signature​

attach(handler: IDeltaHandler): void;

Parameters​

Parameter Type Description
handler IDeltaHandler

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.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/datastore-definitions/alpha.

For more information about our API support guarantees, see here.

Signature​

dirty(): void;

submit​

Send new messages to the server.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/datastore-definitions/alpha.

For more information about our API support guarantees, see here.

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.