ContainerMessageType Enum

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

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

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

Signature

export declare enum ContainerMessageType

Flags

Flag	Alerts	Description
Alias	Alpha
Attach	Alpha
BlobAttach	Alpha
ChunkedOp	Alpha
DocumentSchemaChange	Alpha	An op that changes document schema
FluidDataStoreOp	Alpha
GC	Alpha	Garbage collection specific op. This is sent by the summarizer client when GC runs. It's used to synchronize GC state across all clients.
IdAllocation	Alpha	An op containing an IdRange of Ids allocated using the runtime's IdCompressor since the last allocation op was sent. See the [IdCompressor README](./id-compressor/README.md) for more details.
Rejoin	Alpha

Alias

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

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

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

Signature

Alias = "alias"

Attach

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

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

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

Signature

Attach = "attach"

BlobAttach

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

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

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

Signature

BlobAttach = "blobAttach"

ChunkedOp

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

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

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

Signature

ChunkedOp = "chunkedOp"

DocumentSchemaChange

An op that changes document schema

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

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

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

Signature

DocumentSchemaChange = "schema"

FluidDataStoreOp

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

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

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

Signature

FluidDataStoreOp = "component"

GC

Garbage collection specific op. This is sent by the summarizer client when GC runs. It's used to synchronize GC state across all clients.

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

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

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

Signature

GC = "GC"

IdAllocation

An op containing an IdRange of Ids allocated using the runtime's IdCompressor since the last allocation op was sent. See the [IdCompressor README](./id-compressor/README.md) for more details.

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

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

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

Signature

IdAllocation = "idAllocation"

Rejoin

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

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

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

Signature

Rejoin = "rejoin"