OnDemandSummaryResults Interface

Results from an on-demand summary request.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-loader/legacy.

For more information about our API support guarantees, see here.

Signature

export interface OnDemandSummaryResults

Properties

Property	Alerts	Modifiers	Type	Description
summaryInfo	Alpha	readonly	{ readonly stage?: SummaryStage; readonly handle?: string; }	Information about the summary that was submitted, if any.
summaryOpBroadcasted	Alpha	readonly	boolean	True if summarize op broadcast was observed.
summarySubmitted	Alpha	readonly	boolean	True if summary was generated, uploaded, and submitted.

Property Details

summaryInfo

Information about the summary that was submitted, if any.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly summaryInfo: {
        readonly stage?: SummaryStage;
        readonly handle?: string;
    };

Type: { readonly stage?: SummaryStage; readonly handle?: string; }

summaryOpBroadcasted

True if summarize op broadcast was observed.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly summaryOpBroadcasted: boolean;

Type: boolean

summarySubmitted

True if summary was generated, uploaded, and submitted.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly summarySubmitted: boolean;

Type: boolean