Edit

Share via

ErrorOptions interface

Package:
@ms-fabric/workload-client

Configurations used to render the error dialog.

Properties

capacitySkuTier

SKU tier for capacity-related information, which may affect error handling or display. This property will only be displayed in the error dialog when showAdditionalErrorInfo is set to be true.
customizedActivityId

A customized activity ID for tracking the error. If not assigned, the activity ID will be replaced with the telemetrySessionId. This property will only be displayed in the error dialog when showAdditionalErrorInfo is set to be true.
errorTime

The time when the error occurred, will be assigned to the current time if not be assigned. This property will only be displayed in the error dialog when showAdditionalErrorInfo is set to be true.
helpLink

The help link to render
labelValueDetails

Label value error details.
plainTextDetail

Plain text error detail.
primaryButton

Primary button definition. Rendered at the right bottom of the error dialog.
requestId

The id of the request associated with the error This property will only be displayed in the error dialog when showAdditionalErrorInfo is set to be true.
searchKeywordForGetHelp

When configured, 'Get Help' button will open the help pane with a search of customized search keyword.
secondaryButton

Secondary button definition. Rendered at the right bottom of the error dialog close to primary button. A close button will be rendered if users don't provide a secondary button.
showAdditionalErrorInfo

Indicates whether to show additional information about the error.
stackTrace

The stack trace of the error This property will only be displayed in the error dialog when showAdditionalErrorInfo is set to be true.
statusCode

The status code of the request associated with the error This property will only be displayed in the error dialog when showAdditionalErrorInfo is set to be true.
tertiaryButton

Tertiary button definition. Rendered at the left bottom of the error dialog. A 'Get Help' button will be rendered if users don't provide a tertiary button.
title

Title of the error dialog.

Property Details

capacitySkuTier

SKU tier for capacity-related information, which may affect error handling or display. This property will only be displayed in the error dialog when showAdditionalErrorInfo is set to be true.

capacitySkuTier?: CapacitySkuTier

Property Value

CapacitySkuTier

customizedActivityId

A customized activity ID for tracking the error. If not assigned, the activity ID will be replaced with the telemetrySessionId. This property will only be displayed in the error dialog when showAdditionalErrorInfo is set to be true.

customizedActivityId?: string

Property Value

string

errorTime

The time when the error occurred, will be assigned to the current time if not be assigned. This property will only be displayed in the error dialog when showAdditionalErrorInfo is set to be true.

errorTime?: string

Property Value

string

The help link to render

helpLink?: string

Property Value

string

labelValueDetails

Label value error details.

labelValueDetails?: ErrorDetail[]

Property Value

ErrorDetail[]

plainTextDetail

Plain text error detail.

plainTextDetail?: string

Property Value

string

primaryButton

Primary button definition. Rendered at the right bottom of the error dialog.

primaryButton?: ErrorDialogButton

Property Value

ErrorDialogButton

requestId

The id of the request associated with the error This property will only be displayed in the error dialog when showAdditionalErrorInfo is set to be true.

requestId?: string

Property Value

string

searchKeywordForGetHelp

When configured, 'Get Help' button will open the help pane with a search of customized search keyword.

searchKeywordForGetHelp?: string

Property Value

string

secondaryButton

Secondary button definition. Rendered at the right bottom of the error dialog close to primary button. A close button will be rendered if users don't provide a secondary button.

secondaryButton?: ErrorDialogButton

Property Value

ErrorDialogButton

showAdditionalErrorInfo

Indicates whether to show additional information about the error.

showAdditionalErrorInfo?: boolean

Property Value

boolean

stackTrace

The stack trace of the error This property will only be displayed in the error dialog when showAdditionalErrorInfo is set to be true.

stackTrace?: string

Property Value

string

statusCode

The status code of the request associated with the error This property will only be displayed in the error dialog when showAdditionalErrorInfo is set to be true.

statusCode?: string

Property Value

string

tertiaryButton

Tertiary button definition. Rendered at the left bottom of the error dialog. A 'Get Help' button will be rendered if users don't provide a tertiary button.

tertiaryButton?: ErrorDialogButton

Property Value

ErrorDialogButton

title

Title of the error dialog.

title: string

Property Value

string