Function: showFailureNotice()

function showFailureNotice(ctx: Context, options: ShowFailureNoticeOptions): Promise<NoticeBubbleResult>;

Defined in: src/notice/showFailureNotice.tsx:42

Parameters

Parameter	Type	Description
ctx	Context	Context object.
options	ShowFailureNoticeOptions	Failure notice configuration.

Returns

Promise<NoticeBubbleResult>

The notice bubble result.

Deprecated

Use showUI.failure instead.

Show a failure notice bubble to inform the user that something went wrong.

Example

await showFailureNotice(ctx, {
  title: 'Upload failed',
  description: 'Sending quarterly report to the server.',
  text: 'The file could not be uploaded. Check your connection and try again.',
});