ISummaryTracker Interface
Packages > @fluidframework/runtime-definitions > ISummaryTracker
Warning: This API is now obsolete.
0.21 summarizerNode - use ISummarizerNode instead
Signature:
export interface ISummaryTracker
Properties
| Property | Type | Description |
|---|---|---|
| latestSequenceNumber | number | The latest sequence number of change to this node or subtree. |
| referenceSequenceNumber | number | The reference sequence number of the most recent acked summary. |
Methods
| Method | Description |
|---|---|
| createOrGetChild(key, latestSequenceNumber) | Creates a child ISummaryTracker node based off information from its parent. |
| getChild(key) | Retrives a child ISummaryTracker node based off the key. |
| getId() | Gets the id to use when summarizing, or undefined if it has changed. |
| updateLatestSequenceNumber(latestSequenceNumber) | Updates the latest sequence number representing change to this node or subtree. |
Events
latestSequenceNumber
The latest sequence number of change to this node or subtree.
Signature:
readonly latestSequenceNumber: number;
referenceSequenceNumber
The reference sequence number of the most recent acked summary.
Signature:
readonly referenceSequenceNumber: number;
Methods
createOrGetChild
Creates a child ISummaryTracker node based off information from its parent.
Signature:
createOrGetChild(key: string, latestSequenceNumber: number): ISummaryTracker;
Parameters
| Parameter | Type | Description |
|---|---|---|
| key | string | key of node for newly created child ISummaryTracker |
| latestSequenceNumber | number | initial value for latest sequence number of change |
Returns:
getChild
Retrives a child ISummaryTracker node based off the key.
Signature:
getChild(key: string): ISummaryTracker | undefined;
Parameters
| Parameter | Type | Description |
|---|---|---|
| key | string | key of the child ISummaryTracker node. |
Returns:
ISummaryTracker | undefined
- The child ISummaryTracker node.
getId
Gets the id to use when summarizing, or undefined if it has changed.
Signature:
getId(): Promise<string | undefined>;
Returns:
Promise<string | undefined>
updateLatestSequenceNumber
Updates the latest sequence number representing change to this node or subtree.
Signature:
updateLatestSequenceNumber(latestSequenceNumber: number): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| latestSequenceNumber | number | new latest sequence number |
Returns:
void