StarWebPrintExtManager.js
バーコードリーダやプリンタステータスの監視を、StarWebPRNTExtManager送信エレメント列やStarWebPRNTExtManager受信エレメント列を通して行います。
コンストラクタ
メソッド
プロパティ
プロパティ(/SendExtMessage)
* パス "/StarWebPRNT/SendExtMessage" にconnectすると通知されるようになります。
プロパティ(/SendDisplayExtMessage)
* パス "/StarWebPRNT/SendDisplayExtMessage" にconnectすると通知されるようになります。
機種別対応リスト
各機種のStar webPRNT機能がどのメソッド・プロパティをサポートするかを示します。
- LAN … プリンターのStar webPRNT機能
- LAN(HE) … IFBD-HE07X/08XのStar webPRNT機能
- LAN(HI) … IFBD-HI01X/02XのStar webPRNT機能(日本国内では販売していません。)
- BR … Star webPRNT Browser
機種別のインターフェイス対応表はこちらをご確認ください。
POSプリンター(mCollection/TSP100IV)
*1 プリンターファームウェア Ver.2.1以降にて対応しています。
*2 SSL通信には非対応です。Webアプリをhttpsで公開する場合、バーコードリーダー利用やプリンターステータスの監視を行うことはできません。
*3 HIDクラス(キーボードモード)に対応しています。(mC-Print2/3, mPOPはプリンターファームウェアVer.3.0以降が必要です)
ただし、市販のUSB HIDクラス(キーボードモード)機器すべての動作を保証するものではありません。市販品の中には正しく通信できない機器もあります。
当社ですべての機器の動作確認を行っているわけではありませんので、実際の導入前に実機による十分な動作検証を行ってください。
POSプリンター(レガシープリンター)
*1 TSP650IISK : 日本国内では販売しておりません。
*2 TSP650IISKは除く。
モバイルプリンター (ESC/POS)
*1 常にドロアークローズとして呼び出されます。
モバイルプリンター (StarPRNT)
*1 常にドロアークローズとして呼び出されます。
*2 iOS版のStar webPRNT Browserは対応しておりません。
StarWebPrintExtManager
StarWebPrintExtManagerオブジェクトを生成します。
構文
StarWebPrintExtManager(args);
名前付き引数
名称 | 説明 | 型 | 省略時 |
url | StarWebPRNTエンドポイントURL ※省略時はconnectメソッド、writeメソッドで指定すること | String | - |
pollingTimeout | claim管理用ポーリングのタイムアウト(ms単位) | Number | 30000 |
pollingInterval | claim管理用ポーリングの送信インターバル時間(ms単位) | Number | 200 |
戻り値
説明 | 型 |
StarWebPrintExtManagerオブジェクト | StarWebPrintExtManager |
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.connect({url:url});
}
// -->
</script>
connect
名前付き引数
名称 | 説明 | 型 | 省略時 |
url | StarWebPRNTエンドポイントURL ※省略時はStarWebPrintExtManagerコンストラクタで指定された値 | String | - |
pollingTimeout |
claim管理用ポーリングタイムアウト(ms単位) ※省略時は、StarWebPrintExtManagerコンストラクタで指定された値 | Number | - |
pollingInterval | claim管理用ポーリングの送信インターバル時間(ms単位) ※省略時は、StarWebPrintExtManagerコンストラクタで指定された値 | Number | - |
戻り値
説明 | 型 |
true … 成功 false … 失敗 | Boolean |
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.connect({url:url});
}
// -->
</script>
disconnect
名前付き引数
戻り値
説明 | 型 |
true … 成功 false … 失敗 | Boolean |
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onDisconnect(url) {
manager.disconnect();
}
// -->
</script>
write
名前付き引数
名称 | 説明 | 型 | 省略時 |
url | StarWebPRNTエンドポイントURL
※省略時はStarWebPrintExtManagerコンストラクタで指定された値
※connect済みの状態では、本引数は無視されます。 | String | 省略不可 |
request | StarWebPRNTExtManager送信エレメント列 | String | 省略不可 |
戻り値
説明 | 型 |
true … 成功 false … 失敗 | Boolean |
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onWrite(url, request) {
manager.write({url:url, request:request});
}
// -->
</script>
onReceive
名前付き引数
名称 | 説明 | 型 |
managerSuccess | プリンターとの通信結果
| String |
managerCode | 通信結果コード
- 0 … 正常終了
- 1010 … プリンター未接続状態
- 1200 … 周辺機器が未接続状態
- 2001 … プリンタービジー状態(他の端末機器がプリンター使用中:要再送)
- 3000 … Claim未取得状態
- 3001 … 非サポート
| Number |
managerClaim | Claim状態結果
- true … Claim取得状態
- false … Claim未取得状態
| Boolean |
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onReceive = function(response) {
var msg;
if (response.managerSuccess == 'true' && response.managerClaim == 'true') {
msg = 'Connected\n\n'
}
else {
msg = 'Not connected\n\n'
}
msg = '- onReceive -\n\n';
msg += 'ManagerSuccess : [ ' + response.managerSuccess + ' ]\n';
msg += 'ManagerCode : [ ' + response.managerCode + ' ]\n';
alert(msg);
}
manager.connect({url:url});
}
// -->
</script>
onError
名前付き引数
名称 | 説明 | 型 |
Status | XMLHttpRequestオブジェクトのstatusプロパティ ※XMLHttpRequest仕様参照 | Number |
responseText | XMLHttpRequestオブジェクトのresponseTextプロパティ ※XMLHttpRequest仕様参照 | String |
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onReceive = function(response) {
var msg;
if (response.managerSuccess == 'true' && response.managerClaim == 'true') {
msg = 'Connected\n\n'
}
else {
msg = 'Not connected\n\n'
}
msg = '- onReceive -\n\n';
msg += 'ManagerSuccess : [ ' + response.managerSuccess + ' ]\n';
msg += 'ManagerCode : [ ' + response.managerCode + ' ]\n';
alert(msg);
}
manager.onError = function(response) {
var msg;
msg = 'onError!' + '\n';
msg += ' Status:' + args.status + '\n';
msg += ' ResponseText:' + args.responseText;
alert(msg);
}
manager.connect({url:url});
}
// -->
</script>
onPrinterImpossible
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onPrinterImpossible = function() {
alert('onPrinterImpossible');
}
manager.connect({url:url});
}
// -->
</script>
onPrinterOnline
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onPrinterOnline = function() {
alert('onPrinterOnline');
}
manager.connect({url:url});
}
// -->
</script>
onPrinterOffline
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onPrinterOffline = function() {
alert('onPrinterOffline');
}
manager.connect({url:url});
}
// -->
</script>
onPrinterPaperReady
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onPrinterPaperReady = function() {
alert('onPrinterPaperReady');
}
manager.connect({url:url});
}
// -->
</script>
onPrinterPaperNearEmpty
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onPrinterPaperNearEmpty = function() {
alert('onPrinterPaperNearEmpty');
}
manager.connect({url:url});
}
// -->
</script>
onPrinterPaperEmpty
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onPrinterPaperEmpty = function() {
alert('onPrinterPaperEmpty');
}
manager.connect({url:url});
}
// -->
</script>
onPrinterCoverOpen
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onPrinterCoverOpen = function() {
alert('onPrinterCoverOpen');
}
manager.connect({url:url});
}
// -->
</script>
onPrinterCoverClose
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onPrinterCoverClose = function() {
alert('onPrinterCoverClose');
}
manager.connect({url:url});
}
// -->
</script>
onCashDrawerOpen
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onCashDrawerOpen = function() {
alert('onCashDrawerOpen');
}
manager.connect({url:url});
}
// -->
</script>
onCashDrawerClose
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onCashDrawerClose = function() {
alert('onCashDrawerClose');
}
manager.connect({url:url});
}
// -->
</script>
onBarcodeReaderImpossible
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onBarcodeReaderImpossible = function() {
alert('onBarcodeReaderImpossible');
}
manager.connect({url:url});
}
// -->
</script>
onBarcodeReaderConnect
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onBarcodeReaderConnect = function() {
alert('onBarcodeReaderConnect');
}
manager.connect({url:url});
}
// -->
</script>
onBarcodeReaderDisconnect
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onDisplayDisconnect = function() {
alert('onDisplayDisconnect');
}
manager.connect({url:url});
}
// -->
</script>
onBarcodeDataReceive
名前付き引数
名称 | 説明 | 型 |
data | バーコードデータ ※Base64形式 | String |
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onBarcodeDataReceive = function() {
alert('onBarcodeDataReceive');
}
manager.connect({url:url});
}
// -->
</script>
onAccessoryConnectSuccess
アクセサリー(Bluetooth)接続成功を通知します。
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onAccessoryConnectSuccess = function() {
alert('onAccessoryConnectSuccess');
}
manager.connect({url:url});
}
// -->
</script>
onAccessoryConnectFailure
アクセサリー(Bluetooth)接続失敗を通知します。
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onAccessoryConnectFailure = function() {
alert('onAccessoryConnectFailure');
}
manager.connect({url:url});
}
// -->
</script>
onAccessoryDisconnect
アクセサリー(Bluetooth)切断を通知します。
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onAccessoryDisconnect = function() {
alert('onAccessoryDisconnect');
}
manager.connect({url:url});
}
// -->
</script>
onStatusUpdate
名前付き引数
名称 | 説明 | 型 |
status | 自動ステータス(※)の3 バイト目~6 バイト目を16進数文字列化したもの
(例:”28000000”)
ステータス通知タイミング
※STAR Line Mode コマンド仕様書もしくはStarPRNT コマンド仕様書をご参照ください | String |
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onStatusUpdate = function() {
alert('onStatusUpdate');
}
manager.connect({url:url});
}
// -->
</script>
onDisplayImpossible
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onDisplayImpossible = function() {
alert('onDisplayImpossible');
}
manager.connect({url:url});
}
// -->
</script>
onDisplayConnect
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onDisplayConnect = function() {
alert('onDisplayConnect');
}
manager.connect({url:url});
}
// -->
</script>
onDisplayDisconnect
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onConnect(url) {
manager.onDisplayDisconnect = function() {
alert('onDisplayDisconnect');
}
manager.connect({url:url});
}
// -->
</script>
onWrite
名前付き引数
例
<script type='text/javascript' src='js/StarWebPrintTrader.js'></script>
<script type='text/javascript' src='js/StarWebPrintExtManager.js'></script>
<script type='text/javascript'>
<!--
var manager = new StarWebPrintExtManager();
function onWrite(url, request) {
manager.onWrite = function() {
alert('onWrite');
}
manager.write({url:url, request:request});
}
// -->
</script>