# 通知設計書 6-汎用通知（Generic Notification）

## 概要

本ドキュメントは、Bagisto ECモバイルアプリにおけるアプリ内汎用通知（Generic Notification）機能の設計書である。

### 本通知の処理概要

本通知は、タイトル、メッセージ、背景色、アイコンをすべてカスタマイズ可能な汎用的なオーバーレイ通知機能を提供する。成功・エラー・警告の標準パターンに当てはまらない特殊なケースに対応するための柔軟な通知表示を実現する。

**業務上の目的・背景**：ECアプリでは、成功（緑）・エラー（赤）・警告（黄）の3パターンでは表現しきれない様々な通知シナリオが発生する。例えば、情報提供、確認、特別なプロモーション告知など、状況に応じた適切な色とアイコンでユーザーに情報を伝達する必要がある。汎用通知により、開発者は任意のビジュアルスタイルで通知を表示でき、アプリの表現力が向上する。

**通知の送信タイミング**：標準の成功・エラー・警告パターンに該当しない、カスタマイズが必要な通知が必要な時点で使用される。情報通知、確認通知、カスタムフィードバックなど、様々なシナリオで利用可能。

**通知の受信者**：通知を表示すべきユーザー。画面上のオーバーレイとして表示されるため、操作中のユーザーのみが対象。

**通知内容の概要**：任意のタイトル、任意のメッセージ、任意の背景色、任意のアイコン。すべての表示要素をパラメータとして指定可能。

**期待されるアクション**：通知内容に応じてユーザーが適切なアクションを取る。情報確認のみの場合は通知を閉じて操作を継続する。

## 通知種別

アプリ内通知（オーバーレイ通知 / トースト形式）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（呼び出し時に即座表示） |
| 優先度 | 中（カスタム可能） |
| リトライ | なし（UI表示のため不要） |

### 送信先決定ロジック

1. 通知を表示すべきユーザーの画面に対してのみ表示
2. BuildContextは不要（グローバル表示）
3. アプリ全体でグローバルにサポート（OverlaySupport.global）

## 通知テンプレート

### アプリ内通知の場合

| 項目 | 内容 |
|-----|------|
| 表示位置 | 画面上部 |
| 背景色 | {color} パラメータで指定（任意） |
| アイコン | {icon} パラメータで指定（任意） |
| 消去方向 | 上方向スワイプ（DismissDirection.up） |

### 本文テンプレート

```
タイトル: {title} - 必須パラメータ
サブタイトル: {message} ?? "Something went wrong" (StringConstants.somethingWrong.localized())
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | テキストのみ |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| title | 通知タイトル | 呼び出し元から渡される | Yes |
| message | 通知メッセージ | 呼び出し元から渡される | No（デフォルト: somethingWrong） |
| color | 背景色 | 呼び出し元から渡される | No |
| icon | 表示アイコン | 呼び出し元から渡される（Icon Widget） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| カスタム表示 | 任意のイベント | 開発者が判断 | 標準パターンに該当しない通知 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | グローバル表示のため特になし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[カスタム通知の必要性判断] --> B[パラメータ準備]
    B --> C{title指定?}
    C -->|Yes| D[title設定]
    C -->|No| E[エラー: 必須パラメータ]
    D --> F{message指定?}
    F -->|Yes| G[message設定]
    F -->|No| H[somethingWrong使用]
    G --> I[color/icon設定]
    H --> I
    I --> J[ShowMessage.showNotification呼び出し]
    J --> K[showSimpleNotification実行]
    K --> L[オーバーレイ表示]
    L --> M{ユーザーアクション}
    M -->|スワイプ| N[即座に消去]
    M -->|放置| O[自動消去]
    N --> P[終了]
    O --> P
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | - | UI表示のためDB参照なし |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | UI表示のためDB更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| Null title | titleがnullの場合 | 実行時エラー（null安全によりコンパイルエラー） |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | なし |
| 1日あたり上限 | なし |

### 配信時間帯

制限なし（任意のタイミングで呼び出し可能）

## セキュリティ考慮事項

- 通知メッセージには機密情報を含めない
- 任意のパラメータを受け付けるため、呼び出し元での入力検証が重要
- XSS等の脆弱性はFlutterフレームワークレベルで防御

## 備考

- overlay_support パッケージを使用してオーバーレイ表示を実現
- contextパラメータは不要（他の通知メソッドと異なる）
- messageがnullの場合は `StringConstants.somethingWrong.localized()` がデフォルト値として使用
- 高い柔軟性を持つが、標準パターン（success/error/warning）を優先して使用すべき

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

汎用通知のパラメータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | show_message.dart | `lib/widgets/show_message.dart` | ShowMessageクラスのshowNotificationメソッド |

**読解のコツ**: 他の通知メソッドとの違い（contextなし、全パラメータカスタマイズ可能）に注目する。

#### Step 2: 通知表示処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | show_message.dart | `lib/widgets/show_message.dart` | showNotification() メソッドの実装 |

**主要処理フロー**:
- **行79-94**: `showNotification()` メソッド
- **行80**: 引数: `String? title, String? message, Color? color, Icon icon`
  - title: 必須（non-null assertion `title!` 使用）
  - message: オプション（デフォルト: somethingWrong）
  - color: オプション
  - icon: 必須（Icon Widget）
- **行81**: `showSimpleNotification` 関数呼び出し
- **行82-85**: タイトルテキスト（白色、太字、16px）
- **行87**: 背景色（colorパラメータ）
- **行88**: アイコン（iconパラメータ）
- **行89**: スワイプ消去方向（上方向）
- **行90-93**: サブタイトル（message ?? somethingWrong）

### プログラム呼び出し階層図

```
呼び出し元（任意のコンポーネント）
    |
    +-- パラメータ準備（title, message, color, icon）
            |
            +-- ShowMessage.showNotification(title, message, color, icon)
                    |
                    +-- showSimpleNotification()
                            |
                            +-- OverlaySupport（オーバーレイ描画）
                                    |
                                    +-- 画面上部にカスタム通知表示
```

### データフロー図

```
[入力]                      [処理]                           [出力]

呼び出し元 ──────▶ パラメータ受け取り
                        |
                        ├── title! (必須)
                        ├── message ?? somethingWrong
                        ├── color (任意)
                        └── icon (必須)
                                |
                                ▼
                    showSimpleNotification()
                                |
                                ▼
                    オーバーレイ表示 ──────▶ カスタムスタイルで通知表示
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| show_message.dart | `lib/widgets/show_message.dart` | ソース | 汎用通知の表示処理 |
| main.dart | `lib/main.dart` | ソース | OverlaySupport.globalの初期化 |
| string_constants.dart | `lib/utils/string_constants.dart` | 設定 | 「somethingWrong」デフォルトメッセージ |
| application_localization.dart | `lib/utils/application_localization.dart` | ソース | 多言語対応処理 |
