Edit

Share via

ErrorOptions interface

  • Reference
Package:
@ms-fabric/workload-client

Configurations used to render the error dialog.

Properties

errorTime

The time when the error occurrs
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
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.
stackTrace

The stack trace of the error
statusCode

The status code of the request associated with the error
tertiaryButton

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

Title of the error dialog.

Property Details

errorTime

The time when the error occurrs

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

requestId?: 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

stackTrace

The stack trace of the error

stackTrace?: string

Property Value

string

statusCode

The status code of the request associated with the error

statusCode?: string

Property Value

string

tertiaryButton

Tertiary button definition. Rendered at the left bottom of the error dialog. A go home 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