# 通知設計書 43-ラベル印刷成功

## 概要

本ドキュメントは、InvenTreeモバイルアプリにおける「ラベル印刷成功」通知の設計仕様を定義するものである。ラベル印刷がプリンターに正常に送信された際、またはラベルファイルのダウンロードが開始された際に、ユーザーに視覚的なフィードバックを提供するスナックバー通知について記載する。

### 本通知の処理概要

本通知は、ラベル印刷ジョブが正常に完了したことをユーザーに通知するためのアプリ内スナックバー通知である。印刷結果に応じて2つのパターンがある：外部プリンターへの送信成功と、ラベルファイルのダウンロード開始。

**業務上の目的・背景**：在庫管理や物流業務において、ラベル印刷は頻繁に行われる重要な作業である。バーコードラベル、在庫ラベル、出荷ラベルなどの印刷が適切に実行されたことを確認することで、業務の正確性と効率性が担保される。ユーザーは印刷が成功したことを確認し、次の作業（ラベルの貼付など）に移行できる。

**通知の送信タイミング**：ラベル印刷API（POST `/api/label/print/`）のレスポンスで`complete`がtrueの場合に通知される。`output`フィールドにURLが含まれる場合はダウンロード通知、含まれない場合は外部プリンター送信完了通知となる。非同期印刷の場合は、ポーリングで完了を検知した時点で通知される。

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

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

**期待されるアクション**：ユーザーは印刷が完了したことを確認する。ダウンロードの場合は、ダウンロードされたファイルを開いて印刷を実行する。外部プリンターの場合は、プリンターからラベルが出力されるのを待つ。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（ポーリングあり） |
| 優先度 | 中 |
| リトライ | あり（最大60回、1秒間隔） |

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

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

## 通知テンプレート

### スナックバー通知（外部プリンター送信成功）

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

### 本文テンプレート（外部プリンター）

```
{L10().printLabelSuccess}
```

英語の場合: "Label sent to printer" または類似のメッセージ

### 本文テンプレート（ダウンロード）

```
{L10().downloading}
```

英語の場合: "Downloading..."

### 添付ファイル

なし（ダウンロードの場合、別途ファイルが端末にダウンロードされる）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| printLabelSuccess | 印刷成功メッセージ | L10()（国際化リソース） | Yes |
| downloading | ダウンロード中メッセージ | L10()（国際化リソース） | Yes（outputありの場合） |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API応答 | ラベル印刷APIの成功レスポンス | `complete`がtrue、`output`あり | ダウンロード通知を表示 |
| API応答 | ラベル印刷APIの成功レスポンス | `complete`がtrue、`output`なし | 外部プリンター送信完了を表示 |
| ポーリング | data-output APIの確認 | `complete`がtrue | 非同期印刷の完了を検知 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| errorsフィールドあり | エラーがある場合は印刷失敗通知が表示される |
| completeがfalse | 印刷処理中のため通知しない |
| repeatCountが60以上 | ポーリングタイムアウト |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[印刷実行] --> B[API POST label/print/]
    B --> C{レスポンス確認}
    C -->|complete=true, output有| D[showSnackIcon ダウンロード中]
    D --> E[downloadFile実行]
    C -->|complete=true, output無| F[showSnackIcon 印刷成功]
    C -->|complete=false| G[1秒待機]
    G --> H[data-output API確認]
    H --> I{ポーリング回数確認}
    I -->|60回未満| J{レスポンス確認}
    J -->|complete=true| K[成功通知へ]
    J -->|complete=false| G
    I -->|60回以上| L[タイムアウト]
    C -->|errors有| M[失敗通知]
    F --> N[終了]
    E --> N
    K --> C
    L --> N
    M --> N
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| LabelTemplate | ラベルテンプレート情報 | InvenTreeサーバー側 |
| Plugin | プリンタープラグイン情報 | InvenTreeサーバー側 |

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

#### LabelTemplate（サーバー側）

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| pk | テンプレートID | ユーザー選択 |
| model_type | ラベル種別 | フィルタ条件 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| DataOutput | INSERT | 印刷ジョブ情報の記録（サーバー側） |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 印刷エラー | errorsフィールドがある | 印刷失敗通知を表示 |
| タイムアウト | 60秒以上完了しない | 処理を中断 |
| ネットワークエラー | API通信失敗 | エラー通知を表示 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 最大60回（ポーリング） |
| リトライ間隔 | 1000ミリ秒 |
| リトライ対象エラー | complete=false（処理中）の場合 |

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 印刷操作は認証済みユーザーのみ実行可能
- ラベルテンプレートへのアクセス権限が必要
- ダウンロードされたファイルは端末のローカルストレージに保存される

## 備考

- 印刷プラグインによっては、動的な追加フィールドが必要になる場合がある
- デフォルトのプリンタープラグインとテンプレートは設定に保存される
- モダンラベル印刷API（apiVersion >= 201）が必要
- 国際化対応済み（L10()による多言語サポート）

---

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

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

### 推奨読解順序

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

ラベル印刷のレスポンス構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | labels.dart | `lib/labels.dart` | handlePrintingSuccess関数のレスポンスデータ構造 |

**読解のコツ**: レスポンスの`complete`、`output`、`errors`フィールドの使い分けを確認する。

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

ラベル印刷処理の起点を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | labels.dart | `lib/labels.dart` | selectAndPrintLabel関数（209-280行目） |

**主要処理フロー**:
1. **214-221行目**: サーバー接続とAPI対応確認
2. **224-241行目**: デフォルト設定の取得
3. **245-263行目**: 印刷フォームフィールドの構築
4. **268-279行目**: APIフォームの起動とonSuccess処理

#### Step 3: 成功時処理を理解する

印刷成功時の通知表示ロジックを確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | labels.dart | `lib/labels.dart` | handlePrintingSuccess関数（165-202行目） |

**主要処理フロー**:
- **170-175行目**: レスポンスデータの解析
- **177-185行目**: complete=true、output有の場合（ダウンロード）
- **183-185行目**: complete=true、output無の場合（プリンター送信成功）
- **188-201行目**: ポーリング処理

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

```
selectAndPrintLabel() (labels.dart line 209)
    │
    ├─ InvenTreeAPI().isConnected() - 接続確認
    │
    ├─ InvenTreeSettingsManager() - デフォルト設定取得
    │
    ├─ launchApiForm() - 印刷フォーム表示
    │      │
    │      └─ onSuccess callback
    │             │
    │             └─ handlePrintingSuccess() (line 165)
    │                    │
    │                    ├─ [complete=true, output有]
    │                    │      ├─ showSnackIcon(L10().downloading)
    │                    │      └─ InvenTreeAPI().downloadFile()
    │                    │
    │                    ├─ [complete=true, output無]
    │                    │      └─ showSnackIcon(L10().printLabelSuccess)
    │                    │
    │                    └─ [complete=false]
    │                           └─ Future.delayed (1秒)
    │                                  └─ InvenTreeAPI().get("data-output/$id/")
    │                                         └─ handlePrintingSuccess() (再帰)
    │
    └─ LabelFormWidgetState - フォーム状態管理
```

### データフロー図

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

ユーザー操作      ┌─────────────────┐
(印刷ボタン) ───▶│selectAndPrintLabel│
                 └────────┬────────┘
                          │
                          ▼
                 ┌─────────────────┐     API Request
                 │ launchApiForm   │────────────────▶ InvenTreeサーバー
                 │ (label/print/)  │◀────────────────  (label/print/ API)
                 └────────┬────────┘     API Response
                          │
                          ▼
                 ┌─────────────────┐
                 │handlePrintingSuccess│
                 └────────┬────────┘
                          │
            ┌─────────────┼─────────────┐
            ▼             ▼             ▼
    ┌───────────┐  ┌───────────┐  ┌───────────┐
    │output有   │  │output無   │  │complete=  │
    │           │  │           │  │false      │
    └─────┬─────┘  └─────┬─────┘  └─────┬─────┘
          │              │              │
          ▼              ▼              ▼
    ┌───────────┐  ┌───────────┐  ┌───────────┐
    │downloading│  │printLabel │  │ポーリング │───▶再帰
    │通知       │  │Success通知│  │(1秒後)   │
    └─────┬─────┘  └───────────┘  └───────────┘
          │
          ▼
    ┌───────────┐
    │downloadFile│───▶ ファイル保存
    └───────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| labels.dart | `lib/labels.dart` | ソース | ラベル印刷のメイン処理 |
| snacks.dart | `lib/widget/snacks.dart` | ソース | スナックバー通知の表示関数 |
| api.dart | `lib/api.dart` | ソース | APIクライアント、downloadFile関数 |
| api_form.dart | `lib/api_form.dart` | ソース | APIフォーム処理 |
| l10.dart | `lib/l10.dart` | ソース | 国際化ヘルパー関数 |
| preferences.dart | `lib/preferences.dart` | ソース | 設定管理（デフォルトプラグイン・テンプレート） |
