ISummarizerRuntime Interface
Packages > @fluidframework/container-runtime > ISummarizerRuntime
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 ISummarizerRuntime extends IConnectableRuntime
Extends: IConnectableRuntime
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| baseLogger |
Alpha
|
readonly
|
ITelemetryBaseLogger | |
| deltaManager |
Alpha
|
readonly
|
IDeltaManager<ISequencedDocumentMessage, IDocumentMessage> | |
| summarizerClientId |
Alpha
|
readonly
|
string | undefined | clientId of parent (non-summarizing) container that owns summarizer container |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| closeFn() |
Alpha
|
void | |
| disposeFn() |
Alpha
|
void | |
| off(event, listener) |
Alpha
|
this | |
| on(event, listener) |
Alpha
|
this |
Property Details
baseLogger
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 baseLogger: ITelemetryBaseLogger;
Type: ITelemetryBaseLogger
deltaManager
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 deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
Type: IDeltaManager <ISequencedDocumentMessage , IDocumentMessage >
summarizerClientId
clientId of parent (non-summarizing) container that owns summarizer container
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 summarizerClientId: string | undefined;
Type: string | undefined
Method Details
closeFn
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
closeFn(): void;
disposeFn
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
disposeFn(): void;
off
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
off(event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): this;
Parameters
| Parameter | Type | Description |
|---|---|---|
| event | "op" | |
| listener | (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void |
Returns
Return type: this
on
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
on(event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): this;
Parameters
| Parameter | Type | Description |
|---|---|---|
| event | "op" | |
| listener | (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void |
Returns
Return type: this