ISummarizeEventProps Interface

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

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

/** @sealed */
export interface ISummarizeEventProps

Properties

Property	Alerts	Modifiers	Type	Description
currentAttempt	Alpha		number
error	Alpha	optional	any
failureMessage	Alpha	optional	string	Result message of a failed summarize attempt
isLastSummary	Alpha	optional	boolean	Was this summarize attempt part of the lastSummary process?
maxAttempts	Alpha		number
result	Alpha		"success" | "failure" | "canceled"

Property Details

currentAttempt

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

currentAttempt: number;

Type: number

error

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

error?: any;

Type: any

failureMessage

Result message of a failed summarize attempt

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

failureMessage?: string;

Type: string

isLastSummary

Was this summarize attempt part of the lastSummary process?

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

isLastSummary?: boolean;

Type: boolean

maxAttempts

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

maxAttempts: number;

Type: number

result

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

result: "success" | "failure" | "canceled";

Type: "success" | "failure" | "canceled"