Skip to main content
Version: v1

ISummarizerNodeRootContract Interface

Signature

export interface ISummarizerNodeRootContract

Methods

Method Return Type Description
clearSummary() void
completeSummary(proposalHandle) void
refreshLatestSummary(proposalHandle, summaryRefSeq, getSnapshot, readAndParseBlob, correlatedSummaryLogger) Promise<RefreshSummaryResult>
startSummary(referenceSequenceNumber, summaryLogger) void

Method Details

clearSummary

Signature

clearSummary(): void;

completeSummary

Signature

completeSummary(proposalHandle: string): void;

Parameters

Parameter Type Description
proposalHandle string

refreshLatestSummary

Signature

refreshLatestSummary(proposalHandle: string | undefined, summaryRefSeq: number, getSnapshot: () => Promise<ISnapshotTree>, readAndParseBlob: ReadAndParseBlob, correlatedSummaryLogger: ITelemetryLogger): Promise<RefreshSummaryResult>;

Parameters

Parameter Type Description
proposalHandle string | undefined
summaryRefSeq number
getSnapshot () => Promise<ISnapshotTree>
readAndParseBlob ReadAndParseBlob
correlatedSummaryLogger ITelemetryLogger

Returns

Return type: Promise<RefreshSummaryResult>

startSummary

Signature

startSummary(referenceSequenceNumber: number, summaryLogger: ITelemetryLogger): void;

Parameters

Parameter Type Description
referenceSequenceNumber number
summaryLogger ITelemetryLogger