# 通知設計書 12-バーコード割当成功

## 概要

本ドキュメントは、InvenTreeモバイルアプリにおける「バーコード割当成功」通知の設計仕様を定義する。この通知は、ユーザーがカスタムバーコードを在庫アイテムやパーツに正常に割り当てた際に表示される成功通知である。

### 本通知の処理概要

この通知は、バーコードスキャン機能においてユニークなバーコードをアイテムに紐付ける操作が成功した際のフィードバックとして機能する。

**業務上の目的・背景**：在庫管理において、カスタムバーコードをアイテムに割り当てることで、既存の社内バーコードシステムやサードパーティのラベルをInvenTreeシステムと統合できる。この通知により、ユーザーは割り当て操作が正常に完了したことを即座に確認でき、次の作業に進むことができる。

**通知の送信タイミング**：ユーザーが `UniqueBarcodeHandler` を使用してバーコードスキャンを実行し、`InvenTreeAPI().linkBarcode()` メソッドがtrueを返した時点で通知が生成される。具体的には、サーバーAPIがバーコードの登録を成功させた後にクライアント側で表示される。

**通知の受信者**：バーコードスキャン操作を実行した現在のアプリユーザー。通知はアプリ内スナックバーとして即座に表示される。

**通知内容の概要**：「Barcode assigned」というメッセージが表示され、バーコードの割り当てが成功したことをユーザーに伝える。成功音声フィードバックも同時に再生される可能性がある。

**期待されるアクション**：ユーザーは割り当てが完了したことを確認し、必要に応じて他のアイテムへのバーコード割り当てを続行するか、他の作業に移行する。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中 |
| リトライ | 無し |

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

現在の操作を実行しているアプリユーザーに対して即座に表示される。サーバーへの通知送信は行わず、クライアントサイドのみで処理される。

## 通知テンプレート

### スナックバー通知

| 項目 | 内容 |
|-----|------|
| 表示位置 | 画面下部 |
| 背景色 | lightGreen（成功時） |
| アイコン | circle_check |
| 表示時間 | 5秒 |

### 本文テンプレート

```
Barcode assigned
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | 固定メッセージ | L10().barcodeAssigned | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | バーコード割り当て実行 | linkBarcode APIがtrueを返却 | ユーザーがカスタムバーコードを割り当て、APIが成功を返した場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| バーコード割り当て失敗時 | APIがfalseを返却した場合は失敗通知が表示される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ユーザーがバーコード割り当てを選択] --> B[UniqueBarcodeHandlerでスキャン開始]
    B --> C[バーコードスキャン実行]
    C --> D[サーバーAPIにlinkBarcode送信]
    D --> E{APIレスポンス}
    E -->|成功 true| F[barcodeAssigned通知表示]
    E -->|失敗 false| G[barcodeNotAssigned通知表示]
    F --> H[showSnackIcon呼び出し success=true]
    H --> I[緑色スナックバー表示]
    I --> J[画面リフレッシュ]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし（クライアント側のみ） | - | サーバー側でバーコード登録が実行される |

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

クライアントアプリ側では直接データベースを参照しない。サーバーAPI経由でバーコードの登録が行われる。

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| サーバー側バーコードテーブル | INSERT/UPDATE | バーコードとアイテムの紐付けが登録される |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | 成功通知のため該当なし | - |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（成功通知のため不要） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

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

### 配信時間帯

24時間365日（アプリ使用時のみ）

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

- バーコードデータ自体には機密情報は含まれない
- 通知内容にはアイテムの詳細情報は含まれず、単純な成功メッセージのみ

## 備考

- 音声フィードバック設定が有効な場合、barcodeSuccessTone()による成功音が再生される可能性がある
- 国際化対応済み（L10()による多言語サポート）
- 成功後、state.refresh()により画面が自動更新され、新しいバーコード割り当て状態が反映される

---

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

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

### 推奨読解順序

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

バーコード割り当て処理に関連するデータ構造を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | app_en.arb | `lib/l10n/app_en.arb` | barcodeAssigned の定義（130行目） |

**読解のコツ**: ARBファイルはFlutterの国際化リソースファイル。キー名からメッセージの用途を理解できる。

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

処理の起点となるバーコードスキャン機能を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | barcode.dart | `lib/barcode/barcode.dart` | customBarcodeAction関数（394-439行目）がエントリーポイント |

**主要処理フロー**:
1. **394行目**: customBarcodeAction関数定義開始
2. **401-418行目**: バーコードが空の場合、UniqueBarcodeHandlerで新規割り当て処理
3. **410-411行目**: result=trueの場合、L10().barcodeAssigned でメッセージ表示

#### Step 3: ハンドラー層を理解する

バーコードマッチング成功時の処理フローを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | barcode.dart | `lib/barcode/barcode.dart` | UniqueBarcodeHandler クラス（345-392行目） |

**主要処理フロー**:
- **363-386行目**: onBarcodeMatched - バーコードマッチ時の処理
- **376行目**: barcodeSuccessTone() - 成功音の再生

#### Step 4: 通知表示層を理解する

スナックバー表示の実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | snacks.dart | `lib/widget/snacks.dart` | showSnackIcon関数（11-81行目） |

**主要処理フロー**:
- **35-37行目**: success=true時の緑色背景設定
- **39-41行目**: success=true かつ icon/onActionが未指定の場合、circle_checkアイコンを自動設定

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

```
customBarcodeAction (barcode.dart:394)
    │
    ├─ UniqueBarcodeHandler (barcode.dart:345)
    │      │
    │      └─ onBarcodeMatched (barcode.dart:363)
    │             │
    │             ├─ barcodeSuccessTone (tones.dart:7)
    │             └─ callback(barcode) (barcode.dart:383)
    │
    └─ InvenTreeAPI().linkBarcode (api.dart)
           │
           └─ showSnackIcon (snacks.dart:11)
                  └─ success=true → "Barcode assigned" (緑色)
```

### データフロー図

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

バーコード     ───▶ UniqueBarcodeHandler ───▶ サーバーAPI
スキャン             │                          │
                     │                          ▼
                     │                      linkBarcode()
                     │                          │
                     │                          ▼
                     │                     成功(true)
                     │                          │
                     │                          ▼
                     └─────────────────▶ barcodeSuccessTone()
                                               │
                                               ▼
                                         showSnackIcon
                                         "Barcode assigned"
                                         (緑色背景)
                                               │
                                               ▼
                                         state.refresh()
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| barcode.dart | `lib/barcode/barcode.dart` | ソース | バーコードハンドラーとアクション定義 |
| snacks.dart | `lib/widget/snacks.dart` | ソース | スナックバー表示ユーティリティ |
| handler.dart | `lib/barcode/handler.dart` | ソース | BarcodeHandler基底クラス |
| tones.dart | `lib/barcode/tones.dart` | ソース | バーコード音声フィードバック |
| app_en.arb | `lib/l10n/app_en.arb` | リソース | 英語ローカライゼーション |
| l10.dart | `lib/l10.dart` | ソース | ローカライゼーションヘルパー |
| api.dart | `lib/api.dart` | ソース | InvenTreeサーバーAPI通信 |
