Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions _typos.toml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ ITMS = "ITMS" # iTunes Music Store
SME = "SME" # Small and midsize enterprise
Hashi = "Hashi" # HashiCorp (brand name)
formatable = "formatable" # NFC event literal from upstream API
PLUGABLE = "PLUGABLE" # Zebra DataWedge enum literal from upstream API
jus = "jus" # Brazilian justice app package namespace
Programm = "Programm" # German app-store title term in TV-Programm
# Translation keys/identifiers - these should remain as-is
Expand Down
19 changes: 19 additions & 0 deletions apps/docs/src/content/docs/docs/plugins/age-signals/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,25 @@ Capacitor interface for retrieving Play Age Signals.
| `checkAgeSignals` | Request the current Play Age Signals for the active user. |
| `getPluginVersion` | Get the native Capacitor plugin version. |


## Reference Values

Use these error codes to decide whether to retry, prompt the user to update Google Play components, or treat the device as unsupported.

### Error Codes

| Value | Meaning |
| --- | --- |
| `API_NOT_AVAILABLE` | Play Age Signals API is not available, often because the Play Store is outdated. |
| `PLAY_STORE_NOT_FOUND` | Google Play Store is not installed on the device. |
| `NETWORK_ERROR` | Network connection failed while requesting the signal. |
| `PLAY_SERVICES_NOT_FOUND` | Google Play services are missing or unavailable. |
| `CANNOT_BIND_TO_SERVICE` | The plugin could not bind to the Play Store service. |
| `PLAY_STORE_VERSION_OUTDATED` | Google Play Store must be updated. |
| `PLAY_SERVICES_VERSION_OUTDATED` | Google Play services must be updated. |
| `CLIENT_TRANSIENT_ERROR` | Temporary client-side device error; retry may succeed. |
| `APP_NOT_OWNED` | The app was not installed through Google Play. |
| `INTERNAL_ERROR` | Unknown internal error from the API. |
## Source Of Truth

This reference is synced from `src/definitions.ts` in [capacitor-android-age-signals](https://github.com/Cap-go/capacitor-android-age-signals/).
Expand Down
16 changes: 16 additions & 0 deletions apps/docs/src/content/docs/docs/plugins/camera-preview/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,22 @@ The main interface for the CameraPreview plugin.
| `setExposureCompensation` | Sets the exposure compensation (EV bias). Value will be clamped to range. |
| `getPluginVersion` | Get the native Capacitor plugin version. |


## Reference Values

Use these values from `CameraLens.deviceType` or `LensInfo.deviceType` to choose the physical camera lens.

### Device Types

| Value | User will find |
| --- | --- |
| `ultraWide` | Ultra-wide camera lens. |
| `wideAngle` | Standard wide-angle camera lens. |
| `telephoto` | Telephoto camera lens. |
| `trueDepth` | TrueDepth front camera. |
| `dual` | Dual camera system. |
| `dualWide` | Dual wide camera system. |
| `triple` | Triple camera system. |
## Source Of Truth

This reference is synced from `src/definitions.ts` in [capacitor-camera-preview](https://github.com/Cap-go/capacitor-camera-preview/).
Expand Down
41 changes: 41 additions & 0 deletions apps/docs/src/content/docs/docs/plugins/file/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,47 @@ Capacitor File Plugin Implements file system operations similar to the Cordova F
| `checkPermissions` | Check the current permission status for file operations. On Android, this checks for external storage permissions. On iOS and web, this always returns 'granted' as no special permissions are needed. |
| `requestPermissions` | Request permissions for file operations. On Android, this requests external storage permissions needed for accessing files outside the app's private directories. On iOS and web, this always returns 'granted' as no special permissions are needed. |


## Reference Values

Use these values when choosing a storage location, writing encoded text, or handling file errors.

### Directories

| Value | User will find |
| --- | --- |
| `DOCUMENTS` | Persistent user-visible documents. On Android this maps to the app files directory. |
| `DATA` | Persistent private app data. |
| `LIBRARY` | Persistent app data that is not user-visible. On Android this maps to the app files directory. |
| `CACHE` | Temporary cache data that the OS may clear. |
| `EXTERNAL` | Android external storage root, such as an SD card or shared external storage. |
| `EXTERNAL_STORAGE` | Android external storage data directory. |
| `APPLICATION` | Read-only application bundle or assets directory. |

### Encodings

| Value | Use |
| --- | --- |
| `utf8` | UTF-8 text. |
| `ascii` | ASCII text. |
| `utf16` | UTF-16 text. |

### File Error Codes

| Value | Code | Meaning |
| --- | --- | --- |
| `NOT_FOUND_ERR` | `1` | File or directory was not found. |
| `SECURITY_ERR` | `2` | Operation was blocked by security rules or permissions. |
| `ABORT_ERR` | `3` | Operation was aborted. |
| `NOT_READABLE_ERR` | `4` | File or directory cannot be read. |
| `ENCODING_ERR` | `5` | Encoding is invalid or unsupported. |
| `NO_MODIFICATION_ALLOWED_ERR` | `6` | Target cannot be modified. |
| `INVALID_STATE_ERR` | `7` | Object is in an invalid state for the operation. |
| `SYNTAX_ERR` | `8` | Path or input syntax is invalid. |
| `INVALID_MODIFICATION_ERR` | `9` | Requested change is invalid for the target. |
| `QUOTA_EXCEEDED_ERR` | `10` | Storage quota was exceeded. |
| `TYPE_MISMATCH_ERR` | `11` | Value type does not match the expected type. |
| `PATH_EXISTS_ERR` | `12` | Target path already exists. |
## Source Of Truth

This reference is synced from `src/definitions.ts` in [capacitor-file](https://github.com/Cap-go/capacitor-file/).
Expand Down
13 changes: 13 additions & 0 deletions apps/docs/src/content/docs/docs/plugins/inappbrowser/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,19 @@ Use it when the page needs more than a simple external browser: OAuth and checko
| `setEnabledSafeBottomMargin` | Sets the enabled safe bottom margin of the webview at runtime. When `id` is omitted, targets the active webview. On Web, this method is a no-op and resolves without changing layout. |
| `openSecureWindow` | Opens a secure OAuth2 window. On web, return the redirected URL through a `BroadcastChannel`; on mobile, register a custom redirect URI in your app configuration. See the getting-started guide for the full HTML, Info.plist, and AndroidManifest examples. |


## Reference Values

Use these values with toolbar options when opening an in-app browser or WebView.

### Toolbar Types

| Value | User will find |
| --- | --- |
| `activity` | Simple toolbar with close and share controls. |
| `compact` | Simple toolbar with a close control. |
| `navigation` | Full navigation toolbar with back and forward controls. |
| `blank` | No toolbar. |
## Source Of Truth

This reference is synced from `src/definitions.ts` in [capacitor-inappbrowser](https://github.com/Cap-go/capacitor-inappbrowser/).
Expand Down
22 changes: 22 additions & 0 deletions apps/docs/src/content/docs/docs/plugins/native-biometric/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,28 @@ This plugin gives access to the native biometric apis for android and iOS.
| `isCredentialsSaved` | Checks if credentials are already saved for a given server. |
| `getPluginVersion` | Get the native Capacitor plugin version. |


## Reference Values

Use these values when handling `biometricError` results from `authenticate`.

### Biometric Auth Errors

| Value | Code | Platform | Meaning |
| --- | --- | --- | --- |
| `UNKNOWN_ERROR` | `0` | Android, iOS | Unknown error occurred. |
| `BIOMETRICS_UNAVAILABLE` | `1` | Android, iOS | Biometrics are unavailable because hardware is missing or unavailable. |
| `USER_LOCKOUT` | `2` | Android, iOS | User is locked out after too many failed attempts. |
| `BIOMETRICS_NOT_ENROLLED` | `3` | Android, iOS | No biometrics are enrolled on the device. |
| `USER_TEMPORARY_LOCKOUT` | `4` | Android | User is temporarily locked out, typically for 30 seconds. |
| `AUTHENTICATION_FAILED` | `10` | Android, iOS | Authentication failed. |
| `APP_CANCEL` | `11` | iOS | App canceled the authentication flow. |
| `INVALID_CONTEXT` | `12` | iOS | Authentication context is invalid. |
| `NOT_INTERACTIVE` | `13` | iOS | Authentication was not interactive. |
| `PASSCODE_NOT_SET` | `14` | Android, iOS | Device passcode, PIN, or fallback credential is not set. |
| `SYSTEM_CANCEL` | `15` | Android, iOS | System canceled authentication, for example after screen lock. |
| `USER_CANCEL` | `16` | Android, iOS | User canceled authentication. |
| `USER_FALLBACK` | `17` | Android, iOS | User chose fallback authentication. |
## Source Of Truth

This reference is synced from `src/definitions.ts` in [capacitor-native-biometric](https://github.com/Cap-go/capacitor-native-biometric/).
Expand Down
12 changes: 12 additions & 0 deletions apps/docs/src/content/docs/docs/plugins/stripe-terminal/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,18 @@ For in-person payments with Tap to Pay and physical readers, `@capgo/capacitor-s
| `connectReader` | Connect to a discovered reader. |
| `getPluginVersion` | Get the native Capacitor plugin version. |


## Reference Values

Use these values with `TapToPayUxConfiguration.darkMode` when configuring Tap to Pay.

### Tap To Pay Dark Mode

| Value | User will find |
| --- | --- |
| `SYSTEM` | Match the device system appearance. |
| `DARK` | Force the Tap to Pay flow into dark appearance. |
| `LIGHT` | Force the Tap to Pay flow into light appearance. |
## Source Of Truth

This reference is synced from `src/definitions.ts` in [capacitor-stripe-terminal](https://github.com/Cap-go/capacitor-stripe-terminal/).
Expand Down
102 changes: 102 additions & 0 deletions apps/docs/src/content/docs/docs/plugins/zebra-datawedge/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,108 @@ Capacitor plugin for Zebra DataWedge profile management, notifications, queries,
| `addListener` | See the source definitions for current behavior. |
| `addListener` | See the source definitions for current behavior. |


## Reference Values

Use these values when creating profiles, configuring plugins, listening for scanner state, or handling DataWedge result errors.

### Profile Config Modes

| Value | Use |
| --- | --- |
| `CREATE_IF_NOT_EXIST` | Create the profile only when it does not already exist. |
| `OVERWRITE` | Replace the existing profile configuration. |
| `REMOVE` | Remove the profile configuration. |
| `UPDATE` | Update the existing profile configuration. |

### Notification Types

| Value | User will receive |
| --- | --- |
| `CONFIGURATION_UPDATE` | DataWedge configuration update events. |
| `PROFILE_SWITCH` | Active profile switch events. |
| `SCANNER_STATUS` | Scanner connection and scan-state events. |

### DataWedge Plugins

| Value | Configures |
| --- | --- |
| `ADF` | Advanced Data Formatting rules. |
| `BARCODE` | Barcode scanner input. |
| `BDF` | Basic Data Formatting rules. |
| `DCP` | Data Capture Plus integration. |
| `EKB` | Enterprise Keyboard integration. |
| `INTENT` | Intent output delivery. |
| `IP` | IP output delivery. |
| `KEYSTROKE` | Keystroke output delivery. |
| `MSR` | Magnetic stripe reader input. |
| `RFID` | RFID input. |
| `SERIAL` | Serial input. |
| `TOKENS` | Token output formatting. |
| `VOICE` | Voice input. |

### Scanner Identifiers

| Value | Scanner target |
| --- | --- |
| `AUTO` | Let DataWedge choose the scanner automatically. |
| `BLUETOOTH_DS3678` | Bluetooth DS3678 scanner. |
| `BLUETOOTH_RS6000` | Bluetooth RS6000 scanner. |
| `BLUETOOTH_SSI` | Bluetooth SSI scanner. |
| `INTERNAL_CAMERA` | Internal camera scanner. |
| `INTERNAL_IMAGER` | Internal imager scanner. |
| `INTERNAL_LASER` | Internal laser scanner. |
| `PLUGABLE_SSI` | Pluggable SSI scanner. |
| `PLUGABLE_SSI_RS5000` | Pluggable SSI RS5000 scanner. |
| `SERIAL_SSI` | Serial SSI scanner. |
| `USB_SSI_DS3608` | USB SSI DS3608 scanner. |

### Scanner Status Values

| Value | Meaning |
| --- | --- |
| `CONNECTED` | Scanner is connected. |
| `DISABLED` | Scanner is disabled. |
| `DISCONNECTED` | Scanner is disconnected. |
| `IDLE` | Scanner is ready and idle. |
| `SCANNING` | Scanner is actively scanning. |
| `WAITING` | Scanner is waiting to scan. |

### DataWedge Error Codes

| Value | What user will find there |
| --- | --- |
| `APP_ALREADY_ASSOCIATED` | The app is already associated with the profile. |
| `APP_ALREADY_IN_DISABLED_LIST` | The app is already in the disabled app list. |
| `BUNDLE_EMPTY` | The supplied config bundle was empty. |
| `CANNOT_READ_FILE` | DataWedge could not read the supplied file. |
| `CONFIG_FILE_NOT_EXIST` | The referenced config file does not exist. |
| `DATAWEDGE_ALREADY_DISABLED` | DataWedge is already disabled. |
| `DATAWEDGE_ALREADY_ENABLED` | DataWedge is already enabled. |
| `DATAWEDGE_DISABLED` | DataWedge is disabled. |
| `DEVICE_NOT_CONNECTED` | The requested scanner device is not connected. |
| `DEVICE_NOT_SUPPORTED` | The requested scanner device is not supported. |
| `INPUT_NOT_ENABLED` | The requested input plugin is not enabled. |
| `INVALID_CONFIG_FILE` | The supplied config file is invalid. |
| `INVALID_FILE_NAME` | The supplied file name is invalid. |
| `INVALID_FOLDER_PATH` | The supplied folder path is invalid. |
| `OPERATION_NOT_ALLOWED` | DataWedge rejected the operation. |
| `PARAMETER_INVALID` | One or more parameters are invalid. |
| `PLUGIN_BUNDLE_INVALID` | The supplied plugin bundle is invalid. |
| `PLUGIN_DISABLED` | The requested plugin is disabled. |
| `PLUGIN_DISABLED_IN_CONFIG` | The requested plugin is disabled in this config. |
| `PLUGIN_NOT_SUPPORTED` | The requested plugin is not supported. |
| `PROFILE_ALREADY_EXISTS` | The target profile already exists. |
| `PROFILE_ALREADY_SET` | The target profile is already active. |
| `PROFILE_DISABLED` | The target profile is disabled. |
| `PROFILE_HAS_APP_ASSOCIATION` | The target profile still has app associations. |
| `PROFILE_NAME_EMPTY` | The profile name was empty. |
| `PROFILE_NOT_FOUND` | The target profile was not found. |
| `SCANNER_ALREADY_DISABLED` | The scanner is already disabled. |
| `SCANNER_ALREADY_ENABLED` | The scanner is already enabled. |
| `SCANNER_DISABLE_FAILED` | DataWedge failed to disable the scanner. |
| `SCANNER_ENABLE_FAILED` | DataWedge failed to enable the scanner. |
| `UNKNOWN` | DataWedge returned an unknown error. |
## Source Of Truth

This reference is synced from `src/definitions.ts` in [capacitor-zebra-datawedge](https://github.com/Cap-go/capacitor-zebra-datawedge/).
Expand Down