API ご利用の手引き

StarXpand SDK では、プリンターやPOS周辺機器を制御するための便利なAPIを用意しています。
お客様のアプリにStarIO10ライブラリを組み込み、各機能の説明ページを参考に、必要なAPIを組み合わせて呼び出してご利用ください。
機能別APIリファレンス一覧

また、StarIO10ライブラリのアプリへの組み込みについては、下記URLをご参照ください。
https://github.com/star-micronics/react-native-star-io10/blob/master/docs/README_JP.md#導入

プリンターを検索する

StarDeviceDiscoveryManagerを使って、非同期にプリンター検索を行います。
サンプルコードを使った説明はこちらを参照してください。

印刷を行う

Step1で印刷データを作り、Step2でプリンターに送信します。
各Stepで必要な機能を選択して、リンク先のサンプルコードを使った説明を参照してください。

キャッシュドロアーを使う

プリンターに接続されたキャッシュドロアーの開閉を行います。
サンプルコードを使った説明はこちらをご参照ください。

プリンターのステータスを取得する

プリンターのステータス（例：用紙有り／無し）を取得します。
ステータスの取得にはStarPrinterクラスのgetStatusメソッドを使用します。
SDKに含まれるサンプルも参考にしてください。

また、イベントベースのAPIも利用できます。 プリンターのステータスが変化したとき、PrinterDelegateクラスの各メソッドが呼び出されます。
SDKに含まれるサンプルも参考にしてください。

バーコードリーダーを使う

バーコードリーダーで読み取ったデータをイベントベースのAPIで取得します。
バーコードが読み取られたとき、InputDeviceDelegateクラスのonDataReceivedメソッドが呼び出され、バーコードデータが取得できます。
SDKに含まれるサンプルも参考にしてください。

カスタマーディスプレイを使う

カスタマーディスプレイの制御データを生成し、プリンターに送信します。
制御データの生成には、DisplayBuilderクラスを使用します。
制御データの送信は印刷を行う Step2を参考にしてください。

ブザーを使う

ブザーの制御データを生成し、プリンターに送信します。
制御データの生成にはBuzzerBuilderクラスを使用します。
制御データの送信は印刷を行う Step2を参考にしてください。

メロディースピーカーを使う

メロディースピーカーの制御データを生成し、プリンターに送信します。
制御データの生成にはMelodySpeakerBuilderクラスを使用します。
制御データの送信は印刷を行う Step2を参考にしてください。

周辺機器の接続状態を取得する

周辺機器の接続状態を、イベントベースのAPIで取得します。
入力機器（バーコードリーダー）の接続状態が変化したときはInputDeviceDelegateクラス、 カスタマーディスプレイの接続状態が変化したときはDisplayDelegateクラスの各メソッドが呼び出されます。
SDKに含まれるサンプルも参考にしてください。

ログを取得する

StarIO10ライブラリのAPI呼び出し情報や送信データのログを取得します。
ログの取得にはStarIO10Loggerクラスを使用します。

機能別APIリファレンス

通信 API

検索 API

イベント API

ログ API

エラーAPI

印刷データ／制御データ生成 API