IUploadSummaryResult Interface

Results of submitSummary after uploading the tree to storage.

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

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

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

Signature

export interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, "stage">

Extends: Omit<IGenerateSummaryTreeResult, "stage">

Properties

Property	Alerts	Modifiers	Type	Description
handle	Beta	readonly	string	The handle returned by storage pointing to the uploaded summary tree.
stage	Beta	readonly	"upload"
uploadDuration	Beta	readonly	number	Time it took to upload the summary tree to storage.

Property Details

handle

The handle returned by storage pointing to the uploaded summary tree.

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 handle: string;

Type: string

stage

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 stage: "upload";

Type: "upload"

uploadDuration

Time it took to upload the summary tree to storage.

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 uploadDuration: number;

Type: number