Skip to main content
Version: v2

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​

PropertyAlertsModifiersTypeDescription
detailsBetaoptionalIUploadedSummaryDetailsDetails of the uploaded summary.
handleBetastringHandle reference to the summary data.
headBetastringHandle to the current latest summary stored by the service
messageBetastringMessage included as part of the summary.
parentsBetastring[]Handles to parent summaries of the proposed new summary.

Property Details​

details​

Details of the uploaded summary.

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​

details?: IUploadedSummaryDetails;

Type: IUploadedSummaryDetails

handle​

Handle reference to the summary data.

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​

handle: string;

Type: string

head​

Handle to the current latest summary stored by the service

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​

head: string;

Type: string

message​

Message included as part of the summary.

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​

message: string;

Type: string

parents​

Handles to parent summaries of the proposed new summary.

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​

parents: string[];

Type: string[]