ISummarizerInternalsProvider Interface

Packages > @fluidframework/container-runtime > ISummarizerInternalsProvider

Signature:

export interface ISummarizerInternalsProvider 

Methods

List of methods of this class
Method Description
generateSummary(options) Encapsulates the work to walk the internals of the running container to generate a summary
refreshLatestSummaryAck(proposalHandle, ackHandle, summaryLogger) Callback whenever a new SummaryAck is received, to update internal tracking state

Methods

generateSummary

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

Signature:

generateSummary(options: IGenerateSummaryOptions): Promise<GenerateSummaryData | undefined>;

Parameters

List of parameters
Parameter Type Description
options IGenerateSummaryOptions

Returns:

Promise<GenerateSummaryData | undefined>

refreshLatestSummaryAck

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

Signature:

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

Parameters

List of parameters
Parameter Type Description
proposalHandle string
ackHandle string
summaryLogger ITelemetryLogger

Returns:

Promise<void>