Star webPRNT User's Manual

StarWebPRNTExtManager受信エレメント


名称説明Star webPRNT
Browser		Star webPRNT
対応Star
プリンター *1
<root>ルートエレメント○*2○
<success>通信結果エレメント○*2○
<code>通信結果コードエレメント○*2○
<claim>StarWebPRNTExtManagerのclaim状態エレメント○*2○
<claimid>StarWebPRNTExtManagerのclaim管理用IDエレメント○*2○
<eventcount>StarWebPRNTExtManagerのイベント発生数エレメント○*2○
<event>StarWebPRNTExtManagerのイベントエレメント○*2○
<action>StarWebPRNTExtManagerのイベント名称エレメント○*2○
<data>StarWebPRNTExtManagerのイベントのデータ情報エレメント○*2○
<number>StarWebPRNTExtManagerのイベント発生順エレメント○*2○

*1 IFBD-HI01X/02X使用プリンター（IFBD-HI01X/02Xは日本国内では販売していません）
  mC-Print2/mC-Print3 プリンターファームウェア Ver.2.1以降（SSL通信非対応）

*2 iOS版のStar webPRNT Browserをご使用の場合、SM-L200、SM-L300には対応していません。

 トップへ戻る

<root>

ルートエレメント

属性

名称説明省略時
---

値

説明
StarWebPRNTExtManager受信エレメント列
例
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>0</eventcount>
<root>
 トップへ戻る

<success>

通信結果エレメント

属性

名称説明省略時
---

値

説明
プリンターとの通信結果
  • true … 通信成功
  • false … 通信失敗
例
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>0</eventcount>
<root>
 トップへ戻る

<code>

通信結果コードエレメント

属性

名称説明省略時
---

値

説明
通信結果コード
  • 0 … 正常終了
  • 1010 … プリンター未接続状態
  • 2001 … プリンタービジー状態（他の端末機器がプリンター使用中：要再送）
  • 3000 … Claim未取得状態
  • 3001 … 非サポート
例
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>0</eventcount>
<root>
 トップへ戻る

<claim>

StarWebPRNTExtManagerのclaim状態エレメント

属性

名称説明省略時
---

値

説明
claim状態
  • true … claim取得状態
  • false … claim未取得状態
例
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>0</eventcount>
<root>
 トップへ戻る

<claimid>

StarWebPRNTExtManagerのclaim管理用IDエレメント

属性

名称説明省略時
---

値

説明
claim管理用のID
次回以降<extmanager>エレメントにてIDを付与すること。
※ StarWebPrintExtManager.jsでは自動付与される
例
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>0</eventcount>
<root>
 トップへ戻る

<eventcount>

StarWebPRNTExtManagerのイベント発生数エレメント

属性

名称説明省略時
---

値

説明
StarWebPRNTExtManagerのイベント発生数
例
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>1</eventcount>
    <event>
        <action>onPrinterOnline</action>
        <number>0</number>
    </event>
<root>
 トップへ戻る

<event>

StarWebPRNTExtManagerのイベントエレメント

属性

名称説明省略時
---

値

説明
発生した1つのeventの受信列
例
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>1</eventcount>
    <event>
        <action>onPrinterOnline</action>
        <number>0</number>
    </event>
<root>
 トップへ戻る

<action>

StarWebPRNTExtManagerのイベント名称エレメント

属性

名称説明省略時
---

値

説明
発生したイベントの名称
  • onReceive … 正常受信イベント
  • onError … 異常受信イベント
  • onPrinterImpossible … プリンター使用不能を通知
  • onPrinterOnline … プリンターオンラインを通知
  • onPrinterOffline … プリンターオフラインを通知
  • onPrinterPaperReady … プリンター用紙レディを通知
  • onPrinterPaperNearEmpty … プリンター用紙ニアエンプティを通知
  • onPrinterPaperEmpty … プリンター用紙エンプティを通知
  • onPrinterCoverOpen … プリンターカバーオープンを通知
  • onPrinterCoverClose … プリンターカバークローズを通知
  • onCashDrawerOpen … キャッシュドロアーオープンを通知
  • onCashDrawerClose … キャッシュドロアークローズを通知
  • onBarcodeReaderImpossible … バーコードリーダー使用不能を通知
  • onBarcodeReaderConnect … バーコードリーダー接続を通知
  • onBarcodeReaderDisconnect … バーコードリーダー切断を通知
  • onBarcodeDataReceive … バーコードデータ受信を通知
  • onAccessoryConnectSuccess … アクセサリー（Bluetooth）接続成功を通知
  • onAccessoryConnectFailure … アクセサリー（Bluetooth）接続失敗を通知
  • onAccessoryDisconnect … アクセサリー（Bluetooth）切断を通知
  • onStatusUpdate … ステータスアップデートを通知
例
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>1</eventcount>
    <event>
        <action>onPrinterOnline</action>
        <number>0</number>
    </event>
<root>
 トップへ戻る

<data>

StarWebPRNTExtManagerのイベントのデータ情報

属性

名称説明省略時
---

値

説明
onBarcodeDataReceiveイベントの場合
  • バーコードデータ情報（BASE64形式）

onStatusUpdateイベントの場合
  • ステータス情報
例
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>1</eventcount>
    <event>
        <action>onBarcodeDataReceive</action>
        <number>MjQ4NzQxNDA0MDYwMjMyOA0K</number>
    </event>
<root>
 トップへ戻る

<number>

StarWebPRNTExtManagerのイベント発生順エレメント

属性

名称説明省略時
---

値

説明
発生したイベント順序
  • 0 … 最初に発生したイベント
  • eventcountの値 - 1 … 最後に発生したイベント
例
<root>
    <success>true</success>
    <code>0</code>
    <claim>true</claim>
    <claimid>123456789</claimid>
    <eventcount>1</eventcount>
    <event>
        <action>onPrinterOnline</action>
        <number>0</number>
    </event>
<root>
 トップへ戻る