メインコンテンツへスキップ
Toast API は、ユーザーに非ブロック型の通知メッセージを表示する方法を提供します。これは、ワークフローを中断せずにフィードバックを提供するのに役立ちます。

基本的な使い方

単純なトースト

// 簡単な情報トーストを表示
app.extensionManager.toast.add({
  severity: "info",
  summary: "情報",
  detail: "操作が正常に完了しました",
  life: 3000
});

トーストの種類

// 成功トースト
app.extensionManager.toast.add({
  severity: "success",
  summary: "成功",
  detail: "データが正常に保存されました",
  life: 3000
});

// 警告トースト
app.extensionManager.toast.add({
  severity: "warn",
  summary: "警告",
  detail: "このアクションは問題を引き起こす可能性があります",
  life: 5000
});

// エラートースト
app.extensionManager.toast.add({
  severity: "error",
  summary: "エラー",
  detail: "リクエストの処理に失敗しました",
  life: 5000
});

アラートヘルパー

// アラートトーストを作成するための簡略化された方法
app.extensionManager.toast.addAlert("これは重要なメッセージです");

API リファレンス

トーストメッセージ

app.extensionManager.toast.add({
  severity?: "success" | "info" | "warn" | "error" | "secondary" | "contrast", // メッセージの重要度レベル(デフォルト:"info")
  summary?: string,         // トーストの短いタイトル
  detail?: any,             // 詳細なメッセージ内容
  closable?: boolean,       // ユーザーがトーストを閉じられるかどうか(デフォルト:true)
  life?: number,            // 自動閉じるまでの期間(ミリ秒)
  group?: string,           // 関連するトーストを管理するためのグループ識別子
  styleClass?: any,         // メッセージのスタイルクラス
  contentStyleClass?: any   // 内容のスタイルクラス
});

アラートヘルパー

app.extensionManager.toast.addAlert(message: string);

その他のメソッド

// 特定のトーストを削除
app.extensionManager.toast.remove(toastMessage);

// すべてのトーストを削除
app.extensionManager.toast.removeAll();