IContainerRuntimeMetadata Interface
Packages > @fluidframework/container-runtime > IContainerRuntimeMetadata
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 interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata
Extends: ICreateContainerMetadata , IGCMetadata
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| disableIsolatedChannels |
Alpha
|
optional, readonly
|
true | True if channels are not isolated in .channels subtrees, otherwise isolated. |
| documentSchema |
Alpha
|
optional, readonly
|
IDocumentSchema | |
| lastMessage |
Alpha
|
optional, readonly
|
ISummaryMetadataMessage | The last message processed at the time of summary. Only primitive property types are added to the summary. |
| message |
Deprecated, Alpha
|
optional, readonly
|
ISummaryMetadataMessage | |
| summaryFormatVersion |
Alpha
|
readonly
|
1 | |
| summaryNumber |
Alpha
|
optional, readonly
|
number | The summary number for a container's summary. Incremented on summaries throughout its lifetime. |
| telemetryDocumentId |
Alpha
|
optional, readonly
|
string | GUID to identify a document in telemetry |
Property Details
disableIsolatedChannels
True if channels are not isolated in .channels subtrees, otherwise isolated.
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
readonly disableIsolatedChannels?: true;
Type: true
documentSchema
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
readonly documentSchema?: IDocumentSchema;
Type: IDocumentSchema
lastMessage
The last message processed at the time of summary. Only primitive property types are added to the summary.
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
readonly lastMessage?: ISummaryMetadataMessage;
Type: ISummaryMetadataMessage
message
This API is deprecated and will be removed in a future release.
- used by old (prior to 2.0 RC3) runtimes
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
readonly message?: ISummaryMetadataMessage;
Type: ISummaryMetadataMessage
summaryFormatVersion
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
readonly summaryFormatVersion: 1;
Type: 1
summaryNumber
The summary number for a container’s summary. Incremented on summaries throughout its lifetime.
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
readonly summaryNumber?: number;
Type: number
telemetryDocumentId
GUID to identify a document in telemetry
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
readonly telemetryDocumentId?: string;
Type: string