Skip to main content
Version: v1

ISummarizerInternalsProvider Interface

Signature​

export interface ISummarizerInternalsProvider

Methods​

MethodReturn TypeDescription
refreshLatestSummaryAck(proposalHandle, ackHandle, summaryRefSeq, summaryLogger)Promise<void>Callback whenever a new SummaryAck is received, to update internal tracking state
submitSummary(options)Promise<SubmitSummaryResult>Encapsulates the work to walk the internals of the running container to generate a summary

Method Details​

refreshLatestSummaryAck​

Callback whenever a new SummaryAck is received, to update internal tracking state

Signature​

refreshLatestSummaryAck(proposalHandle: string, ackHandle: string, summaryRefSeq: number, summaryLogger: ITelemetryLogger): Promise<void>;

Parameters​

ParameterTypeDescription
proposalHandlestring
ackHandlestring
summaryRefSeqnumber
summaryLoggerITelemetryLogger

Returns​

Return type: Promise<void>

submitSummary​

Encapsulates the work to walk the internals of the running container to generate a summary

Signature​

submitSummary(options: ISubmitSummaryOptions): Promise<SubmitSummaryResult>;

Parameters​

ParameterTypeDescription
optionsISubmitSummaryOptions

Returns​

Return type: Promise<SubmitSummaryResult>