# 通知設計書 41-削除成功

## 概要

本ドキュメントは、InvenTreeモバイルアプリにおける「削除成功」通知の設計仕様を定義するものである。パーツ画像の削除操作が正常に完了した際に、ユーザーに視覚的なフィードバックを提供するスナックバー通知について記載する。

### 本通知の処理概要

本通知は、パーツ画像の削除処理が正常に完了したことをユーザーに通知するためのアプリ内スナックバー通知である。

**業務上の目的・背景**：在庫管理業務において、パーツに紐づく画像の管理は重要な作業である。誤った画像が登録されている場合や、画像を更新する必要がある場合に削除機能が使用される。削除操作は不可逆的な操作であるため、操作の完了をユーザーに明確に通知することで、作業の確実性を担保し、ユーザーが次のアクションに移行できるようにする必要がある。

**通知の送信タイミング**：パーツ画像削除のAPIリクエスト（PATCH `/api/part/{id}/`）がステータスコード200系で成功した直後に送信される。具体的には、`part_image_widget.dart`の`_deleteImage`メソッド内で、`InvenTreeAPI().patch()`の戻り値が`successful()`を返した時点でトリガーされる。

**通知の受信者**：削除操作を実行したユーザー本人のみ。アプリ内通知であるため、他のユーザーには通知されない。

**通知内容の概要**：「削除成功」を示すローカライズされたメッセージ（`L10().deleteSuccess`）と、成功を示す緑色の背景、チェックマークアイコンがスナックバーとして画面下部に表示される。

**期待されるアクション**：ユーザーは削除が完了したことを確認し、必要に応じて新しい画像のアップロードや、他の作業に移行する。画面は自動的にリフレッシュされ、削除後の状態が反映される。

## 通知種別

アプリ内通知（スナックバー）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中 |
| リトライ | なし（UI通知のため） |

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

操作を実行したユーザーのアプリ画面に直接表示。ユーザー選択や条件分岐は不要。

## 通知テンプレート

### スナックバー通知

| 項目 | 内容 |
|-----|------|
| 背景色 | `Colors.lightGreen`（成功時） |
| アイコン | `TablerIcons.circle_check` |
| 表示時間 | 5秒 |
| 形式 | スナックバー（画面下部） |

### 本文テンプレート

```
{L10().deleteSuccess}
```

英語の場合: "Delete successful" または類似のメッセージ

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| deleteSuccess | 削除成功メッセージ | L10()（国際化リソース） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | パーツ画像削除ボタン押下後、確認ダイアログでOK | APIレスポンスが成功（200系） | `_deleteImage`メソッド内で`response.successful()`がtrueの場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| APIエラー | レスポンスが成功でない場合は「削除失敗」通知が表示される |
| ユーザーキャンセル | 確認ダイアログでキャンセルした場合は何も表示されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[削除ボタン押下] --> B[確認ダイアログ表示]
    B -->|キャンセル| C[処理終了]
    B -->|OK| D[API PATCH リクエスト送信]
    D --> E{レスポンス確認}
    E -->|成功| F[showSnackIcon 削除成功]
    E -->|失敗| G[showSnackIcon 削除失敗]
    F --> H[画面リフレッシュ]
    G --> H
    H --> I[終了]
    C --> I
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| Part | パーツ情報の取得 | InvenTreeサーバー側 |

### テーブル別参照項目詳細

#### Part（サーバー側）

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| pk | パーツID | 現在表示中のパーツ |
| image | 画像パス | 削除対象 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| Part | UPDATE | imageフィールドをnullに更新 |

#### Part更新

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| PATCH | image | null | 画像を削除 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| API失敗 | サーバーエラー、ネットワークエラー | 削除失敗通知を表示 |
| 権限エラー | パーツ編集権限がない | 削除失敗通知を表示（エラー詳細付き） |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（ユーザー操作による再試行） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（ユーザー操作に応じて即座に表示）

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

- 削除操作は認証済みユーザーのみ実行可能
- パーツの編集権限（`canEdit`）を持つユーザーのみ削除ボタンが表示される
- 確認ダイアログによる誤操作防止

## 備考

- 削除操作後、画面は自動的にリフレッシュされる
- スナックバーはタップで即座に閉じることが可能
- 国際化対応済み（L10()による多言語サポート）

---

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

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

### 推奨読解順序

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

まず、パーツモデルとAPI応答の構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | part.dart | `lib/inventree/part.dart` | InvenTreePartクラスの構造、imageプロパティの定義 |
| 1-2 | api.dart | `lib/api.dart` | APIResponseクラスの構造、successful()メソッドの定義 |

**読解のコツ**: Dartのクラス継承構造を意識し、InvenTreeModelからの派生を追跡する。

#### Step 2: エントリーポイントを理解する

削除処理の起点となるウィジェットを特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | part_image_widget.dart | `lib/widget/part/part_image_widget.dart` | _PartImageStateクラス、_deleteImageメソッド |

**主要処理フロー**:
1. **95-134行目**: `_deleteImage`メソッド全体
2. **97-115行目**: 確認ダイアログの表示
3. **117-121行目**: APIリクエストの実行
4. **123-124行目**: 成功時の通知表示
5. **132行目**: 画面リフレッシュ

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

スナックバー表示の実装詳細を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | snacks.dart | `lib/widget/snacks.dart` | showSnackIcon関数の実装 |

**主要処理フロー**:
- **11-81行目**: showSnackIcon関数全体
- **35-40行目**: success=trueの場合の処理（緑背景、チェックアイコン）
- **58-80行目**: SnackBarの構築と表示

#### Step 4: 国際化リソースを理解する

メッセージの国際化対応を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | l10.dart | `lib/l10.dart` | L10()関数の定義 |
| 4-2 | app_en.arb | `lib/l10n/app_en.arb` | deleteSuccessの英語定義 |

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

```
PartImageWidget (part_image_widget.dart)
    │
    ├─ _deleteImage() (line 95-134)
    │      │
    │      ├─ showDialog() - 確認ダイアログ
    │      │
    │      ├─ InvenTreeAPI().patch() (api.dart)
    │      │      └─ APIResponse
    │      │
    │      ├─ showSnackIcon() (snacks.dart line 11)
    │      │      └─ OneContext().showSnackBar()
    │      │
    │      └─ refresh() - 画面更新
    │
    └─ appBarActions() - 削除ボタンの配置
```

### データフロー図

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

ユーザー操作      ┌─────────────────┐
(削除ボタン) ───▶│ _deleteImage()  │
                 └────────┬────────┘
                          │
                          ▼
                 ┌─────────────────┐
                 │ 確認ダイアログ   │
                 └────────┬────────┘
                          │
                          ▼
                 ┌─────────────────┐     API Request
                 │ InvenTreeAPI    │────────────────▶ InvenTreeサーバー
                 │ .patch()        │◀────────────────
                 └────────┬────────┘     API Response
                          │
                          ▼
                 ┌─────────────────┐
                 │ showSnackIcon() │───▶ スナックバー表示
                 └────────┬────────┘
                          │
                          ▼
                 ┌─────────────────┐
                 │ refresh()       │───▶ 画面更新
                 └─────────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| part_image_widget.dart | `lib/widget/part/part_image_widget.dart` | ソース | パーツ画像ウィジェット、削除処理のエントリーポイント |
| snacks.dart | `lib/widget/snacks.dart` | ソース | スナックバー通知の表示関数 |
| api.dart | `lib/api.dart` | ソース | APIクライアント、PATCH リクエスト処理 |
| l10.dart | `lib/l10.dart` | ソース | 国際化ヘルパー関数 |
| app_en.arb | `lib/l10n/app_en.arb` | リソース | 英語メッセージ定義 |
| part.dart | `lib/inventree/part.dart` | ソース | パーツモデル定義 |
