Skip to main content
Version: v1

ISummarizerNodeRootContract Interface

Signature

export interface ISummarizerNodeRootContract

Methods

MethodReturn TypeDescription
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

ParameterTypeDescription
proposalHandlestring

refreshLatestSummary

Signature

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

Parameters

ParameterTypeDescription
proposalHandlestring | undefined
summaryRefSeqnumber
getSnapshot() => Promise<ISnapshotTree>
readAndParseBlobReadAndParseBlob
correlatedSummaryLoggerITelemetryLogger

Returns

Return type: Promise<RefreshSummaryResult>

startSummary

Signature

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

Parameters

ParameterTypeDescription
referenceSequenceNumbernumber
summaryLoggerITelemetryLogger