Skip to main content

ISummaryContent Interface

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

To use, import via @fluidframework/driver-definitions/legacy.

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

Signature​

export interface ISummaryContent

Properties​

Property Alerts Modifiers Type Description
details Alpha optional IUploadedSummaryDetails Details of the uploaded summary.
handle Alpha string Handle reference to the summary data.
head Alpha string Handle to the current latest summary stored by the service
message Alpha string Message included as part of the summary.
parents Alpha string[] Handles to parent summaries of the proposed new summary.

Property Details​

details​

Details of the uploaded summary.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature​

details?: IUploadedSummaryDetails;

Type: IUploadedSummaryDetails

handle​

Handle reference to the summary data.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature​

handle: string;

Type: string

head​

Handle to the current latest summary stored by the service

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature​

head: string;

Type: string

message​

Message included as part of the summary.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature​

message: string;

Type: string

parents​

Handles to parent summaries of the proposed new summary.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature​

parents: string[];

Type: string[]