Skip to main content
Version: v1

ISummarizerInternalsProvider Interface

Signature

export interface ISummarizerInternalsProvider

Methods

Method Return Type Description
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

Parameter Type Description
proposalHandle string
ackHandle string
summaryRefSeq number
summaryLogger ITelemetryLogger

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

Parameter Type Description
options ISubmitSummaryOptions

Returns

Return type: Promise<SubmitSummaryResult>