Skip to main content

ZebraRuntime

Methods#

disableDatawedge#

Disable DataWedge on the device. https://techdocs.zebra.com/datawedge/latest/guide/api/enabledatawedge

Returns: void

disableScannerInput#

Disable the Scanner Input Plug-in in use by the current active profile. https://techdocs.zebra.com/datawedge/latest/guide/api/scannerinputplugin

Returns: Promise<void>

enableDatawedge#

Enable DataWedge on the device. https://techdocs.zebra.com/datawedge/latest/guide/api/enabledatawedge

Returns: void

enableScannerInput#

Enable the Scanner Input Plug-in in use by the current active profile. https://techdocs.zebra.com/datawedge/latest/guide/api/scannerinputplugin

Returns: Promise<void>

enumerateTriggers#

Retrieve supported trigger list of a device. https://techdocs.zebra.com/datawedge/latest/guide/api/enumeratetriggers

Returns: Promise<string[]>

notify#

Play notification sound(s) and/or display a colored LED after a scan from a connected Bluetooth scanner with RSM (Remote Scanner Management). https://techdocs.zebra.com/datawedge/latest/guide/api/notify

Parameters#

NameType
optionsDataWedgeNotifyOptions

Returns: Promise<void>

resetDefaultProfile#

Reset the default profile to Profile0, the built-in profile used with unassociated apps. https://techdocs.zebra.com/datawedge/latest/guide/api/resetdefaultprofile

Returns: Promise<void>

setDefaultProfile#

Set the specified profile as the default profile. https://techdocs.zebra.com/datawedge/latest/guide/api/setdefaultprofile

Parameters#

NameType
profileNamestring

Returns: Promise<void>

setReportingOptions#

Configure reporting options from importing databases and profiles. https://techdocs.zebra.com/datawedge/latest/guide/api/setreportingoptions

Parameters#

NameType
optionsReportingOptions

Returns: Promise<void>

softRfidTrigger#

Toggle a software RFID trigger. Make sure the Datawedge profile is configured properly to accept intent outputs and set the intent delivery to Broadcast Intent. https://techdocs.zebra.com/datawedge/latest/guide/api/softrfidtrigger

Returns: Promise<ZebraScanResult>

softScanTrigger#

Toggle a software scanning trigger. Make sure the Datawedge profile is configured properly to accept intent outputs and set the intent delivery to Broadcast Intent. https://techdocs.zebra.com/datawedge/latest/guide/api/softscantrigger

Parameters#

NameType
intentActionstring

Returns: Promise<ZebraScanResult>

switchScanner#

Switch to a specific scanner at runtime to enable an optimal scanning device for the app, requirement or situation. https://techdocs.zebra.com/datawedge/latest/guide/api/switchscanner

Parameters#

NameType
scanerIndexstring

Returns: Promise<void>

switchScannerParams#

https://techdocs.zebra.com/datawedge/latest/guide/api/switchscannerparams Temporarily update the settings of the active profile during runtime by passing one or more barcode, scanner and/or reader parameters as intent extras.

Parameters#

NameType
optionsSwitchScannerParamsOptions

Returns: Promise<void>

switchToProfile#

https://techdocs.zebra.com/datawedge/latest/guide/api/switchtoprofile Change the app association to the specified profile.

Parameters#

NameType
profileNamestring

Returns: Promise<void>