capacitor-bixolon
v0.0.2
Published
Plugin for working natively with Bixolon POS controls.
Downloads
5
Readme
capacitor-bixolon
Plugin for working natively with Bixolon POS controls.
Install
npm install capacitor-bixolon
npx cap sync
API
getBluetoothDevices()
getNetworkDevices(...)
getUsbDevices(...)
isInitialized()
initialize()
addEntry(...)
getAllEntries()
getEntry(...)
modifyEntry(...)
removeAllEntries()
removeEntry(...)
save()
createControl(...)
disposeControl(...)
callControl(...)
addControlListener(...)
removeControlListener(...)
- Interfaces
- Type Aliases
- Enums
getBluetoothDevices()
getBluetoothDevices() => Promise<BluetoothDevicesResult>
Returns: Promise<BluetoothDevicesResult>
getNetworkDevices(...)
getNetworkDevices(options: GetNetworkDevicesOptions) => Promise<NetworkDevicesResult>
| Param | Type |
| ------------- | ----------------------------------------------------------------------------- |
| options
| GetNetworkDevicesOptions |
Returns: Promise<NetworkDevicesResult>
getUsbDevices(...)
getUsbDevices(options: GetUsbDevicesOptions) => Promise<UsbDevicesResult>
| Param | Type |
| ------------- | --------------------------------------------------------------------- |
| options
| GetUsbDevicesOptions |
Returns: Promise<UsbDevicesResult>
isInitialized()
isInitialized() => Promise<ValueResult<boolean>>
Returns: Promise<ValueResult<boolean>>
initialize()
initialize() => Promise<void>
addEntry(...)
addEntry(options: AddEntryOptions) => Promise<void>
| Param | Type |
| ------------- | ----------------------------------------------------------- |
| options
| AddEntryOptions |
getAllEntries()
getAllEntries() => Promise<GetAllEntriesResult>
Returns: Promise<GetAllEntriesResult>
getEntry(...)
getEntry(options: WithLogicalName) => Promise<GetEntryResult>
| Param | Type |
| ------------- | ----------------------------------------------------------- |
| options
| WithLogicalName |
Returns: Promise<GetEntryResult>
modifyEntry(...)
modifyEntry(options: ModifyEntryOptions) => Promise<ValueResult<boolean>>
| Param | Type |
| ------------- | ----------------------------------------------------------------- |
| options
| ModifyEntryOptions |
Returns: Promise<ValueResult<boolean>>
removeAllEntries()
removeAllEntries() => Promise<void>
removeEntry(...)
removeEntry(options: WithLogicalName) => Promise<ValueResult<boolean>>
| Param | Type |
| ------------- | ----------------------------------------------------------- |
| options
| WithLogicalName |
Returns: Promise<ValueResult<boolean>>
save()
save() => Promise<void>
createControl(...)
createControl(options: CreateControlOptions) => Promise<ValueResult<string>>
| Param | Type |
| ------------- | --------------------------------------------------------------------- |
| options
| CreateControlOptions |
Returns: Promise<ValueResult<string>>
disposeControl(...)
disposeControl(options: WithHashKey) => Promise<ValueResult<boolean>>
| Param | Type |
| ------------- | --------------------------------------------------- |
| options
| WithHashKey |
Returns: Promise<ValueResult<boolean>>
callControl(...)
callControl<T = any>(options: CallControlOptions) => Promise<ValueResult<T> | void>
| Param | Type |
| ------------- | ----------------------------------------------------------------- |
| options
| CallControlOptions |
Returns: Promise<void | ValueResult<T>>
addControlListener(...)
addControlListener(options: AddControlListenerOptions) => Promise<void>
| Param | Type |
| ------------- | ------------------------------------------------------------------------------- |
| options
| AddControlListenerOptions |
removeControlListener(...)
removeControlListener(options: RemoveControlListenerOptions) => Promise<void>
| Param | Type |
| ------------- | ------------------------------------------------------------------------------------- |
| options
| RemoveControlListenerOptions |
Interfaces
BluetoothDevicesResult
| Prop | Type |
| ------------- | ----------------------------------- |
| devices
| BluetoothDeviceEntry[] |
BluetoothDeviceEntry
| Prop | Type |
| --------------- | --------------------- |
| address
| string |
| alias
| string |
| name
| string |
| bondState
| number |
| type
| number |
| uuids
| string[] |
NetworkDevicesResult
| Prop | Type |
| ------------- | --------------------- |
| devices
| string[] |
GetNetworkDevicesOptions
| Prop | Type |
| ---------------------- | ---------------------------------------------------------------------- |
| action
| number |
| wifiSearchOption
| { lookupCount: number; interval: number; wire?: number; } |
UsbDevicesResult
| Prop | Type |
| ------------- | ----------------------------- |
| devices
| UsbDeviceEntry[] |
UsbDeviceEntry
| Prop | Type |
| ---------------------- | ------------------- |
| deviceName
| string |
| manufacturerName
| string |
| productName
| string |
| version
| string |
| serialNumber
| string |
| deviceId
| number |
| vendorId
| number |
| productId
| number |
| deviceClass
| number |
| deviceSubclass
| number |
| deviceProtocol
| number |
GetUsbDevicesOptions
| Prop | Type |
| ----------------------- | -------------------- |
| requestPermission
| boolean |
ValueResult
| Prop | Type |
| ----------- | -------------- |
| value
| T |
AddEntryOptions
| Prop | Type |
| -------------------- | ----------------------------------------------------------------------- |
| deviceCategory
| BixolonDeviceCategory |
| productName
| string |
| deviceBus
| BixolonDeviceBus |
| address
| string |
| secure
| boolean |
GetAllEntriesResult
| Prop | Type |
| ------------- | ---------------------------------- |
| entries
| EntryWithProperties[] |
EntryWithProperties
| Prop | Type |
| ---------------- | ------------------------------------------------------------ |
| properties
| Record<string, any> |
GetEntryResult
| Prop | Type |
| -------------------- | ------------------- |
| deviceCategory
| number |
| productName
| string |
| address
| string |
| deviceBus
| number |
WithLogicalName
| Prop | Type |
| ----------------- | ------------------- |
| logicalName
| string |
ModifyEntryOptions
| Prop | Type |
| --------------- | ------------------------------------------------------------- |
| deviceBus
| BixolonDeviceBus |
| address
| string |
| secure
| boolean |
CreateControlOptions
| Prop | Type |
| -------------------- | ----------------------------------------------------------------------- |
| deviceCategory
| BixolonDeviceCategory |
WithHashKey
| Prop | Type |
| ------------- | ------------------- |
| hashKey
| string |
CallControlOptions
| Prop | Type |
| ---------------- | ---------------------------------- |
| methodName
| string |
| args
| CallControlArgument[] |
HashNativeArgument
| Prop | Type |
| --------------- | ------------------- |
| hashKey
| string |
| classType
| string |
ComplexNativeArgument
| Prop | Type |
| --------------- | ----------------------------------------------------------- |
| value
| NativePrimitive |
| classType
| string |
ComplexNativeArrayArgument
| Prop | Type |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| value
| (NativePrimitive | ComplexNativeArgument)[] | null |
| componentClassType
| string |
| classType
| string |
AddControlListenerOptions
| Prop | Type |
| --------------------- | --------------------- |
| eventName
| string |
| eventProperties
| string[] |
RemoveControlListenerOptions
| Prop | Type |
| --------------- | ------------------- |
| eventName
| string |
Type Aliases
Record
Construct a type with a set of properties K of type T
{ [P in K]: T; }
CallControlArgument
NativeArgument | NativeArgument[]
NativeArgument
NativePrimitive | HashNativeArgument | ComplexNativeArgument | ComplexNativeArrayArgument
NativePrimitive
string | number | boolean | null
Enums
BixolonDeviceCategory
| Members | Value |
| ---------------------- | -------------- |
| CashDrawer
| 0 |
| MSR
| 1 |
| POSPrinter
| 2 |
| SmartCardRW
| 3 |
| LocalSmartCardRW
| 4 |
BixolonDeviceBus
| Members | Value |
| ----------------- | -------------- |
| Bluetooth
| 0 |
| Ethernet
| 1 |
| USB
| 2 |
| Wifi
| 3 |
| WifiDirect
| 4 |
| BluetoothLE
| 5 |