API

method printImage(...)

printImage(options: BRLMPrintOptions) => Promise<void>

method search(...)

search(option: BRLMSearchOption) => Promise<void>

プリンターを検索します。見つからない場合は空配列を返します（エラーではありません）。

method isChannelAvailable(...)

isChannelAvailable(option: BRLMChannelResult) => Promise<isChannelAvailableResult>

最後に接続した <a href="#brlmchannelresult">BRLMChannelResult</a> を保存している場合、
現在利用可能かどうかを検証できます。

戻り値: <code>Promise<<a href="#ischannelavailableresult">isChannelAvailableResult</a>></code>

method cancelSearchWiFiPrinter()

cancelSearchWiFiPrinter() => Promise<void>

基本的にはタイムアウトするため、使う必要はありません。複数の connectType 検索を同時に実行し、いずれかを手動でタイムアウトさせたいときに使います。

method cancelSearchBluetoothPrinter()

cancelSearchBluetoothPrinter() => Promise<void>

基本的にはタイムアウトするため、使う必要はありません。複数の connectType 検索を同時に実行し、いずれかを手動でタイムアウトさせたいときに使います。

method addListener(BrotherPrintEventsEnum.onPrinterAvailable, ...)

addListener(eventName: BrotherPrintEventsEnum.onPrinterAvailable, listenerFunc: (printers: BRLMChannelResult) => void) => Promise<PluginListenerHandle>

デバイスに接続できるプリンターを見つけます。

戻り値: <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>

method addListener(BrotherPrintEventsEnum.onPrint, ...)

addListener(eventName: BrotherPrintEventsEnum.onPrint, listenerFunc: () => void) => Promise<PluginListenerHandle>

印刷成功イベント

戻り値: <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>

method addListener(BrotherPrintEventsEnum.onPrintFailedCommunication, ...)

addListener(eventName: BrotherPrintEventsEnum.onPrintFailedCommunication, listenerFunc: (info: ErrorInfo) => void) => Promise<PluginListenerHandle>

プリンターへの接続に失敗しました。
例: Bluetooth がオフ、プリンターがオフ、など。

戻り値: <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>

method addListener(BrotherPrintEventsEnum.onPrintError, ...)

addListener(eventName: BrotherPrintEventsEnum.onPrintError, listenerFunc: (info: ErrorInfo) => void) => Promise<PluginListenerHandle>

印刷に失敗しました。

戻り値: <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>

interface PluginListenerHandle

type alias BRLMPrintOptions

<code>{ encodedImage: string; /** * Should use enum <a href="#brlmprintermodelname">BRLMPrinterModelName</a> */ modelName: <a href="#brlmprintermodelname">BRLMPrinterModelName</a>; } & <a href="#partial">Partial</a><<a href="#brlmchannelresult">BRLMChannelResult</a>> & (<a href="#brlmprinterqlmodelsettings">BRLMPrinterQLModelSettings</a> | <a href="#brlmprintertdmodelsettings">BRLMPrinterTDModelSettings</a>)</code>

type alias Partial

T のすべてのプロパティをオプショナルにします

<code>{
[P in keyof T]?: T[P];
}</code>

type alias BRLMChannelResult

<code>{ port: <a href="#brlmprinterport">BRLMPrinterPort</a>; modelName: string; serialNumber: string; macAddress: string; nodeName: string; location: string; /** * This need to connect to the printer. * wifi: IP Address * bluetooth: macAddress * bluetoothLowEnergy: modelName for bluetoothLowEnergy */ channelInfo: string; }</code>

type alias BRLMPrinterQLModelSettings

<code>{ /** * Should use enum <a href="#brlmprinterlabelname">BRLMPrinterLabelName</a> */ labelName: <a href="#brlmprinterlabelname">BRLMPrinterLabelName</a>; } & <a href="#brlmprintersettings">BRLMPrinterSettings</a></code>

type alias BRLMPrinterSettings

これらはオプションです。設定しない場合、プリンターがデフォルト値を割り当てます。

<code>{ /** * The number of copies you print. / numberOfCopies?: <a href="#brlmprinternumberofcopies">BRLMPrinterNumberOfCopies</a>; /* * Whether the auto-cut is enabled or not. If true, your printer cut the paper each page. / autoCut?: <a href="#brlmprinterautocuttype">BRLMPrinterAutoCutType</a>; /* * A scale mode that specifies how your data is scaled in a print area of your printer. / scaleMode?: <a href="#brlmprinterscalemode">BRLMPrinterScaleMode</a>; /* * A scale value. This is effective when ScaleMode is ScaleValue. / scaleValue?: <a href="#brlmprinterscalevaluetype">BRLMPrinterScaleValueType</a>; /* * A way to rasterize your data. / halftone?: <a href="#brlmprinterhalftone">BRLMPrinterHalftone</a>; /* * A threshold value. This is effective when the Halftone is Threshold. / halftoneThreshold?: <a href="#brlmprinterhalftonethresholdtype">BRLMPrinterHalftoneThresholdType</a>; /* * An image rotation that specifies the angle in which your data is placed in the print area. Rotation direction is clockwise. / imageRotation?: <a href="#brlmprinterimagerotation">BRLMPrinterImageRotation</a>; /* * A vertical alignment that specifies how your data is placed in the printable area. / verticalAlignment?: <a href="#brlmprinterverticalalignment">BRLMPrinterVerticalAlignment</a>; /* * A horizontal alignment that specifies how your data is placed in the printable area. / horizontalAlignment?: <a href="#brlmprinterhorizontalalignment">BRLMPrinterHorizontalAlignment</a>; /* * A compress mode that specifies how to compress your data. * note: This is ios only. / compressMode?: <a href="#brlmprintercompressmode">BRLMPrinterCompressMode</a>; /* * A priority that is print speed or print quality. Whether or not this has an effect is depend on your printer. */ printQuality?: <a href="#brlmprinterprintquality">BRLMPrinterPrintQuality</a>; }</code>

type alias BRLMPrinterNumberOfCopies

<code>number</code>

type alias BRLMPrinterAutoCutType

<code>boolean</code>

type alias BRLMPrinterScaleValueType

<code>number</code>

type alias BRLMPrinterHalftoneThresholdType

<code>number</code>

type alias BRLMPrinterTDModelSettings

<code>{ /** * Should use enum BRLMPrinterCustomPaperType / paperType: <a href="#brlmprintercustompapertype">BRLMPrinterCustomPaperType</a>; /* * The width of the label. For example, the RD-U04J1 is 60.0 wide. / tapeWidth: number; /* * The length of the label. For example, the RD-U04J1 is 60.0 wide. / tapeLength: number; /* * It is the difference between a sticker and a mount. * For example, the RD-U04J1 is 1.0, 2.0, 1.0, 2.0 / marginTop: number; marginRight: number; marginBottom: number; marginLeft: number; /* * The spacing between seals. For example, the RD-U04J1 is 0.2. / gapLength: number; paperMarkPosition: number; paperMarkLength: number; /* * Should use enum BRLMPrinterCustomPaperUnit. * For example, the RD-U04J1 is mm. */ paperUnit: <a href="#brlmprintercustompaperunit">BRLMPrinterCustomPaperUnit</a>; }</code>

type alias BRLMSearchOption

<code>{ /** * 'usb' is android only, and now developing. / port: <a href="#brlmprinterport">BRLMPrinterPort</a>; /* * searchDuration is the time to end search for devices. * default is 15 seconds. * use only port is 'wifi' or 'bluetoothLowEnergy'. */ searchDuration: number; }</code>

type alias isChannelAvailableResult

<code>{ result: boolean; }</code>

type alias ErrorInfo

<code>{ message: string; code: number; }</code>

enum BRLMPrinterModelName

enum BRLMPrinterPort

enum BRLMPrinterLabelName

enum BRLMPrinterScaleMode

enum BRLMPrinterHalftone

enum BRLMPrinterImageRotation

enum BRLMPrinterVerticalAlignment

enum BRLMPrinterHorizontalAlignment

enum BRLMPrinterCompressMode

enum BRLMPrinterPrintQuality

enum BRLMPrinterCustomPaperType

enum BRLMPrinterCustomPaperUnit

enum BrotherPrintEventsEnum