Apache Cordova Plugin for Mobile Print
This plugin provides the ability to use the CaptureID Printer Library to easily integrate Bluetooth printing into your app(s).
- Requirements
- Supported Cordova Platforms
- How does it work?
- Getting Started
- Plugin Usage
- API Reference
- PhoneGap Build
- Example Apps
Requirements
The CaptureID Printer plugin expires after a 3 month evaluation period. After this period you must request a valid license key. This license must be purchased separatly and is not included in this package. For additional Information of the CaptureID Licensing and how to get access to a valid license Key visit our Website under (https://www.captureid.de).
Supported Cordova Platforms
Cordova 8.0.0+ is fully supported, along with the following asociated platforms:
- Android (cordova-android 7.0.0+)
To check which versions of each Cordova platform you are currently using, you can run the following command and inspect the Installed platforms
list:
cordova platform ls
If you're running an older Android and/or iOS platform than is mentioned above, and would be open to upgrading, you can easily do so by running the following commands (omitting a platform if it isn't neccessary):
cordova platform update android
How does it work?
Getting Started
cordova plugin add cordova-plugin-cidprint@latest
now you are able to use the methods like
cordova.plugins.cidprint.<FUNKTION-NAME>(<SUCCESS-CALLBACK>, <ERROR-CALLBACK>, <PARAMETERS>);
Plugin Usage
With the CaptureID Printer plugin installed and configured, the only thing left is to add the necessary code to your app.
-
Call the provided functions and add the callbacks.
-
The callback parameter provides a JSON array with the following content:
- FunctionName: name of the calling function.
- error: error description in case of an error.
- message: user friendly message string mostly used in case of an error.
- boolValue: simple true or false result.
- objectValue: an object containing the result dependend on the called method.
API Reference
-
initCIDPrinterLib: initialize the CaptureID Printer Library. You have to call this method before you can use any other method from the library.
-
closeCIDPrinterLib: call this method on app shutdown or you have finished the usage of the library.
-
activateLicense: this method activates the CaptureID Printer Library.
-
enableBluetoothPrinting: enable/disable Bluetooth printing.
-
getPairedDevices: request a list of paired devices.
-
discoverDevices: start the device discovery process.
initCIDPrinterLib
initCIDPrinterLib(onSuccess?, onError?);
Version 0.1.0 Parameters:
-
onSuccess: Optional callback invoked if the plugin was successfully notified.
-
onError: Optional callback invoked in case of an error during notifying the plugin.
closeCIDPrinterLib
closeCIDPrinterLib(onSuccess?, onError?);
Version 0.1.0 Parameters:
-
onSuccess: Optional callback invoked if the plugin was successfully notified.
-
onError: Optional callback invoked in case of an error during notifying the plugin.
activateLicense
activateLicense(onSuccess?, onError?, key: string, customer: string);
Version 0.1.0 Parameters:
-
onSuccess: Optional callback invoked if the plugin was successfully notified.
-
onError: Optional callback invoked in case of an error during notifying the plugin.
-
key (string) - valid Licensekey.
-
customer (string) - valid CustomerId.
enableBluetoothPrinting
enableBluetoothPrinting(onSuccess?, onError?, enable: boolean);
Version 1.0.0 Parameters:
-
onSuccess: Optional callback invoked if the plugin was successfully notified.
-
onError: Optional callback invoked in case of an error during notifying the plugin.
-
enable (boolean) - Enables/disables the Printing via Bluetooth.
getPairedDevices
getPairedDevices(onSuccess?, onError?);
Version 0.1.0
Parameters:
-
onSuccess: Optional callback invoked if the plugin was successfully notified.
-
onError: Optional callback invoked in case of an error during notifying the plugin.
discoverDevices
discoverDevices(onSuccess?, onError?);
Version 0.1.0
Parameters:
-
onSuccess: Optional callback invoked if the plugin was successfully notified.
-
onError: Optional callback invoked in case of an error during notifying the plugin.
printData
printData(onSuccess?, onError?, data: string);
Version 0.1.0
Parameters:
-
onSuccess: Optional callback invoked if the plugin was successfully notified.
-
onError: Optional callback invoked in case of an error during notifying the plugin.
-
data (string) - valid data.
printLabelWithData
printLabelWithData(onSuccess?, onError?);
Version 0.1.0
Parameters:
-
onSuccess: Required callback invoked if the plugin was successfully notified.
-
onError: Optional callback invoked in case of an error during notifying the plugin.
printLabel
printLabel(onSuccess, onError?, property: String, value: any);
Version 0.1.0
Parameters:
-
onSuccess: Required callback invoked if the plugin was successfully notified.
-
onError: Optional callback invoked in case of an error during notifying the plugin.
connectToPreferredPrinter
connectToPreferredPrinter(onSuccess, onError?);
Version 0.1.0
Parameters:
-
onSuccess: Required callback invoked if the plugin was successfully notified.
-
onError: Optional callback invoked in case of an error during notifying the plugin.