Skip to main content
@capgo/capacitor-zebra-datawedge Device APIs Open source

Zebra DataWedge Capacitor plugin

Manage Zebra DataWedge profiles, notifications, queries, and scan triggers on Zebra Android devices

Install

bun add @capgo/capacitor-zebra-datawedge bunx cap sync
npm, pnpm or yarn
  • npm install @capgo/capacitor-zebra-datawedge
  • pnpm add @capgo/capacitor-zebra-datawedge
  • yarn add @capgo/capacitor-zebra-datawedge

Guide

How to use Zebra DataWedge in Capacitor

Test on device

Download the Capgo app, then scan the QR code.

Zebra DataWedge plugin preview QR code

Using @capgo/capacitor-zebra-datawedge

Capacitor plugin for Zebra DataWedge profile management, notifications, queries, and soft scanning on Zebra Android devices.

Install

bun add @capgo/capacitor-zebra-datawedge
bunx cap sync

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

import { ZebraDataWedge } from '@capgo/capacitor-zebra-datawedge';

API at a glance

Method Description
cloneProfile See the source definitions for current behavior.
createProfile See the source definitions for current behavior.
deleteProfile See the source definitions for current behavior.
importConfig See the source definitions for current behavior.
renameProfile See the source definitions for current behavior.
restoreConfig See the source definitions for current behavior.
setConfig See the source definitions for current behavior.
setDisabledAppList See the source definitions for current behavior.
setIgnoreDisabledProfiles See the source definitions for current behavior.
registerForNotification See the source definitions for current behavior.
unRegisterForNotification See the source definitions for current behavior.
enumerateScanners See the source definitions for current behavior.
getActiveProfile See the source definitions for current behavior.
getAssociatedApps See the source definitions for current behavior.
getConfig See the source definitions for current behavior.
getDatawedgeStatus See the source definitions for current behavior.
getDisabledAppList See the source definitions for current behavior.
getIgnoreDisabledProfiles See the source definitions for current behavior.
getProfilesList See the source definitions for current behavior.
getScannerStatus See the source definitions for current behavior.
getVersionInfo See the source definitions for current behavior.
disableDatawedge See the source definitions for current behavior.
disableScannerInput See the source definitions for current behavior.
enableDatawedge See the source definitions for current behavior.
enableScannerInput See the source definitions for current behavior.
enumerateTriggers See the source definitions for current behavior.
notify See the source definitions for current behavior.
resetDefaultProfile See the source definitions for current behavior.
setDefaultProfile See the source definitions for current behavior.
setReportingOptions See the source definitions for current behavior.
softRfidTrigger See the source definitions for current behavior.
softScanTrigger See the source definitions for current behavior.
switchScanner See the source definitions for current behavior.
switchScannerParams See the source definitions for current behavior.
switchToProfile See the source definitions for current behavior.

Examples

cloneProfile()

See the API reference for the current contract.

import { ZebraDataWedge } from '@capgo/capacitor-zebra-datawedge';

await ZebraDataWedge.cloneProfile({
  destProfileName: 'dest-profile',
  sourceProfileName: 'source-profile',
});

createProfile()

See the API reference for the current contract.

import { ZebraDataWedge } from '@capgo/capacitor-zebra-datawedge';

await ZebraDataWedge.createProfile({ profileName: 'profile' });

deleteProfile()

See the API reference for the current contract.

import { ZebraDataWedge } from '@capgo/capacitor-zebra-datawedge';

await ZebraDataWedge.deleteProfile({ profileNames: ['profile'] });

importConfig()

See the API reference for the current contract.

import { ZebraDataWedge } from '@capgo/capacitor-zebra-datawedge';

await ZebraDataWedge.importConfig({ folderPath: 'path/to/file' });

renameProfile()

See the API reference for the current contract.

import { ZebraDataWedge } from '@capgo/capacitor-zebra-datawedge';

await ZebraDataWedge.renameProfile({
  currentProfileName: 'current-profile',
  newProfileName: 'new-profile',
});

restoreConfig()

See the API reference for the current contract.

import { ZebraDataWedge } from '@capgo/capacitor-zebra-datawedge';

await ZebraDataWedge.restoreConfig();

The table above lists the 35 core methods. Listener and version helpers, and the full contract of each method, are documented in the GitHub repository.

Listen to events

addListener returns a handle. Call handle.remove() when the screen unmounts.

Full reference

Keep going from Using @capgo/capacitor-zebra-datawedge

If you are using Using @capgo/capacitor-zebra-datawedge to plan native plugin work, connect it with @capgo/capacitor-zebra-datawedge for the implementation detail in @capgo/capacitor-zebra-datawedge, Getting Started for the implementation detail in Getting Started, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins.

FAQ

Zebra DataWedge plugin FAQ

How do I install the Zebra DataWedge plugin in a Capacitor app?

Run "bun add @capgo/capacitor-zebra-datawedge" (or "npm install @capgo/capacitor-zebra-datawedge"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-zebra-datawedge" in your app code.

Does @capgo/capacitor-zebra-datawedge work with React, Vue and Angular?

Yes. Zebra DataWedge is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

Which Capacitor version does @capgo/capacitor-zebra-datawedge support?

Capgo plugins follow Capacitor's major version: use the plugin major version that matches your Capacitor major version (for example plugin v8 with Capacitor 8). The compatibility table in the GitHub README lists the maintained versions.

Is @capgo/capacitor-zebra-datawedge free and open source?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-zebra-datawedge/ and the package is free to install from npm. Bug reports and pull requests are welcome.

Can I update code that uses Zebra DataWedge without an App Store review?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

Ship Zebra DataWedge changes without waiting for app review

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Start with Capgo