Topics

IDeltaManager Interface

Packages > @fluidframework/container-definitions > IDeltaManager

Manages the transmission of ops between the runtime and storage.

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

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

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

Signature

/** @sealed */
export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender

Extends: IEventProvider <IDeltaManagerEvents >, IDeltaSender

Type Parameters

Parameter	Description
T
U

Properties

Property	Alerts	Modifiers	Type	Description
active	`Alpha`	`readonly`	boolean	Flag to indicate whether the client can write or not.
clientDetails	`Alpha`	`readonly`	IClientDetails	Details of client
hasCheckpointSequenceNumber	`Alpha`	`readonly`	boolean	Tells if current connection has checkpoint information. I.e. we know how far behind the client was at the time of establishing connection
inbound	`Deprecated`, `Alpha`	`readonly`	IDeltaQueue<T>	The queue of inbound delta messages
inboundSignal	`Alpha`	`readonly`	IDeltaQueue<ISignalMessage>	The queue of inbound delta signals
initialSequenceNumber	`Alpha`	`readonly`	number	The initial sequence number set when attaching the op handler
lastKnownSeqNumber	`Alpha`	`readonly`	number	The latest sequence number the delta manager is aware of
lastMessage	`Alpha`	`readonly`	ISequencedDocumentMessage \| undefined	The last message processed by the delta manager
lastSequenceNumber	`Alpha`	`readonly`	number	The last sequence number processed by the delta manager
maxMessageSize	`Alpha`	`readonly`	number	Max message size allowed to the delta manager
minimumSequenceNumber	`Alpha`	`readonly`	number	The current minimum sequence number
outbound	`Deprecated`, `Alpha`	`readonly`	IDeltaQueue<U[]>	The queue of outbound delta messages
readOnlyInfo	`Alpha`	`readonly`	ReadOnlyInfo
serviceConfiguration	`Alpha`	`readonly`	IClientConfiguration \| undefined	Service configuration provided by the service.
version	`Alpha`	`readonly`	string	Protocol version being used to communicate with the service

Methods

Method	Alerts	Return Type	Description
submitSignal(content, targetClientId)	`Alpha`	void	Submit a signal to the service to be broadcast to other connected clients, but not persisted

Property Details

active

Flag to indicate whether the client can write or not.

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

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

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

Signature

readonly active: boolean;

Type: boolean

clientDetails

Details of client

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

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

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

Signature

readonly clientDetails: IClientDetails;

Type: IClientDetails

hasCheckpointSequenceNumber

Tells if current connection has checkpoint information. I.e. we know how far behind the client was at the time of establishing connection

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

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

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

Signature

readonly hasCheckpointSequenceNumber: boolean;

Type: boolean

inbound

The queue of inbound delta messages

This API is deprecated and will be removed in a future release.

Do not use, for internal use only. There are a lot of complications in core pieces of the runtime may break if this is used directly. For example summarization and op processing.

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

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

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

Signature

readonly inbound: IDeltaQueue<T>;

Type: IDeltaQueue <T>

inboundSignal

The queue of inbound delta signals

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

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

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

Signature

readonly inboundSignal: IDeltaQueue<ISignalMessage>;

Type: IDeltaQueue <ISignalMessage >

initialSequenceNumber

The initial sequence number set when attaching the op handler

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

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

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

Signature

readonly initialSequenceNumber: number;

Type: number

lastKnownSeqNumber

The latest sequence number the delta manager is aware of

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

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

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

Signature

readonly lastKnownSeqNumber: number;

Type: number

lastMessage

The last message processed by the delta manager

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

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

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

Signature

readonly lastMessage: ISequencedDocumentMessage | undefined;

Type: ISequencedDocumentMessage | undefined

lastSequenceNumber

The last sequence number processed by the delta manager

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

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

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

Signature

readonly lastSequenceNumber: number;

Type: number

maxMessageSize

Max message size allowed to the delta manager

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

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

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

Signature

readonly maxMessageSize: number;

Type: number

minimumSequenceNumber

The current minimum sequence number

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

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

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

Signature

readonly minimumSequenceNumber: number;

Type: number

outbound

The queue of outbound delta messages

This API is deprecated and will be removed in a future release.

Do not use, for internal use only. There are a lot of complications in core pieces of the runtime may break if this is used directly. For example op submission

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

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

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

Signature

readonly outbound: IDeltaQueue<U[]>;

Type: IDeltaQueue <U[]>

readOnlyInfo

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

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

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

Signature

readonly readOnlyInfo: ReadOnlyInfo;

Type: ReadOnlyInfo

serviceConfiguration

Service configuration provided by the service.

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

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

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

Signature

readonly serviceConfiguration: IClientConfiguration | undefined;

Type: IClientConfiguration | undefined

version

Protocol version being used to communicate with the service

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

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

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

Signature

readonly version: string;

Type: string

Method Details

submitSignal

Submit a signal to the service to be broadcast to other connected clients, but not persisted

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

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

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

Signature

submitSignal(content: any, targetClientId?: string): void;

Parameters

Parameter	Modifiers	Type	Description
content		any
targetClientId	optional	string