{ "api": { "name": "BarcodeScannerPlugin", "slug": "barcodescannerplugin", "docs": "", "tags": [], "methods": [ { "name": "startScan", "signature": "(options?: StartScanOptions | undefined) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "StartScanOptions | undefined" } ], "returns": "Promise", "tags": [ { "name": "since", "text": "0.0.1" } ], "docs": "Start scanning for barcodes.", "complexTypes": [ "StartScanOptions" ], "slug": "startscan" }, { "name": "stopScan", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "0.0.1" } ], "docs": "Stop scanning for barcodes.", "complexTypes": [], "slug": "stopscan" }, { "name": "readBarcodesFromImage", "signature": "(options: ReadBarcodesFromImageOptions) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "ReadBarcodesFromImageOptions" } ], "returns": "Promise", "tags": [ { "name": "since", "text": "0.0.1" } ], "docs": "Read barcodes from an image.\n\nOnly available on Android and iOS.", "complexTypes": [ "ReadBarcodesFromImageResult", "ReadBarcodesFromImageOptions" ], "slug": "readbarcodesfromimage" }, { "name": "scan", "signature": "(options?: ScanOptions | undefined) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "ScanOptions | undefined" } ], "returns": "Promise", "tags": [ { "name": "since", "text": "0.0.1" }, { "name": "experimental", "text": "This method is experimental and may change in the future." } ], "docs": "Scan a barcode with a ready-to-use interface without WebView customization.\n\nOn **Android**, this method is only available on devices with Google Play Services\ninstalled. Therefore, no camera permission is required.\n\n**Attention:** Before using this method on *Android*, first check if the Google Barcode Scanner module is available\nby using `isGoogleBarcodeScannerModuleAvailable()`.\n\nOnly available on Android and iOS.", "complexTypes": [ "ScanResult", "ScanOptions" ], "slug": "scan" }, { "name": "isSupported", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "0.0.1" } ], "docs": "Returns whether or not the barcode scanner is supported.", "complexTypes": [ "IsSupportedResult" ], "slug": "issupported" }, { "name": "enableTorch", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "7.2.0" } ], "docs": "Enable camera's torch (flash) during a scan session.\n\nOnly available on Android and iOS.", "complexTypes": [], "slug": "enabletorch" }, { "name": "disableTorch", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "7.2.0" } ], "docs": "Disable camera's torch (flash) during a scan session.\n\nOnly available on Android and iOS.", "complexTypes": [], "slug": "disabletorch" }, { "name": "toggleTorch", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "7.2.0" } ], "docs": "Toggle camera's torch (flash) during a scan session.\n\nOnly available on Android and iOS.", "complexTypes": [], "slug": "toggletorch" }, { "name": "isTorchEnabled", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "7.2.0" } ], "docs": "Returns whether or not the camera's torch (flash) is enabled.\n\nOnly available on Android and iOS.", "complexTypes": [ "IsTorchEnabledResult" ], "slug": "istorchenabled" }, { "name": "isTorchAvailable", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "7.2.0" } ], "docs": "Returns whether or not the camera's torch (flash) is available.\n\nOnly available on Android and iOS.", "complexTypes": [ "IsTorchAvailableResult" ], "slug": "istorchavailable" }, { "name": "setZoomRatio", "signature": "(options: SetZoomRatioOptions) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "SetZoomRatioOptions" } ], "returns": "Promise", "tags": [ { "name": "since", "text": "5.4.0" } ], "docs": "Set the zoom ratio of the camera.\n\nOnly available on Android and iOS.", "complexTypes": [ "SetZoomRatioOptions" ], "slug": "setzoomratio" }, { "name": "getZoomRatio", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "5.4.0" } ], "docs": "Get the zoom ratio of the camera.\n\nOnly available on Android and iOS.", "complexTypes": [ "GetZoomRatioResult" ], "slug": "getzoomratio" }, { "name": "getMinZoomRatio", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "5.4.0" } ], "docs": "Get the minimum zoom ratio of the camera.\n\nOnly available on Android and iOS.", "complexTypes": [ "GetMinZoomRatioResult" ], "slug": "getminzoomratio" }, { "name": "getMaxZoomRatio", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "5.4.0" } ], "docs": "Get the maximum zoom ratio of the camera.\n\nOnly available on Android and iOS.", "complexTypes": [ "GetMaxZoomRatioResult" ], "slug": "getmaxzoomratio" }, { "name": "openSettings", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "0.0.1" } ], "docs": "Open the settings of the app so that the user can grant the camera permission.\n\nOnly available on Android and iOS.", "complexTypes": [], "slug": "opensettings" }, { "name": "isGoogleBarcodeScannerModuleAvailable", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "5.1.0" } ], "docs": "Check if the Google Barcode Scanner module is available.\n\nIf the Google Barcode Scanner module is not available, you can install it by using `installGoogleBarcodeScannerModule()`.\n\nOnly available on Android.", "complexTypes": [ "IsGoogleBarcodeScannerModuleAvailableResult" ], "slug": "isgooglebarcodescannermoduleavailable" }, { "name": "installGoogleBarcodeScannerModule", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "5.1.0" } ], "docs": "Install the Google Barcode Scanner module.\n\n**Attention**: This only starts the installation.\nThe `googleBarcodeScannerModuleInstallProgress` event listener will\nnotify you when the installation is complete.\n\nOnly available on Android.", "complexTypes": [], "slug": "installgooglebarcodescannermodule" }, { "name": "checkPermissions", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "0.0.1" } ], "docs": "Check camera permission.", "complexTypes": [ "PermissionStatus" ], "slug": "checkpermissions" }, { "name": "requestPermissions", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "0.0.1" } ], "docs": "Request camera permission.", "complexTypes": [ "PermissionStatus" ], "slug": "requestpermissions" }, { "name": "addListener", "signature": "(eventName: 'barcodesScanned', listenerFunc: (event: BarcodesScannedEvent) => void) => Promise", "parameters": [ { "name": "eventName", "docs": "", "type": "'barcodesScanned'" }, { "name": "listenerFunc", "docs": "", "type": "(event: BarcodesScannedEvent) => void" } ], "returns": "Promise", "tags": [ { "name": "since", "text": "6.2.0" } ], "docs": "Called when barcodes are scanned.", "complexTypes": [ "PluginListenerHandle", "BarcodesScannedEvent" ], "slug": "addlistenerbarcodesscanned-" }, { "name": "addListener", "signature": "(eventName: 'scanError', listenerFunc: (event: ScanErrorEvent) => void) => Promise", "parameters": [ { "name": "eventName", "docs": "", "type": "'scanError'" }, { "name": "listenerFunc", "docs": "", "type": "(event: ScanErrorEvent) => void" } ], "returns": "Promise", "tags": [ { "name": "since", "text": "0.0.1" } ], "docs": "Called when an error occurs during the scan.\n\nAvailable on Android and iOS.", "complexTypes": [ "PluginListenerHandle", "ScanErrorEvent" ], "slug": "addlistenerscanerror-" }, { "name": "addListener", "signature": "(eventName: 'googleBarcodeScannerModuleInstallProgress', listenerFunc: (event: GoogleBarcodeScannerModuleInstallProgressEvent) => void) => Promise", "parameters": [ { "name": "eventName", "docs": "", "type": "'googleBarcodeScannerModuleInstallProgress'" }, { "name": "listenerFunc", "docs": "", "type": "(event: GoogleBarcodeScannerModuleInstallProgressEvent) => void" } ], "returns": "Promise", "tags": [ { "name": "since", "text": "5.1.0" } ], "docs": "Called when the Google Barcode Scanner module is installed.\n\nAvailable on Android.", "complexTypes": [ "PluginListenerHandle", "GoogleBarcodeScannerModuleInstallProgressEvent" ], "slug": "addlistenergooglebarcodescannermoduleinstallprogress-" }, { "name": "removeAllListeners", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [ { "name": "since", "text": "0.0.1" } ], "docs": "Remove all listeners for this plugin.", "complexTypes": [], "slug": "removealllisteners" } ], "properties": [] }, "interfaces": [ { "name": "StartScanOptions", "slug": "startscanoptions", "docs": "", "tags": [ { "text": "0.0.1", "name": "since" } ], "methods": [], "properties": [ { "name": "formats", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Improve the speed of the barcode scanner by configuring\nthe barcode formats to scan for.\n\nOnly available on Android and iOS.", "complexTypes": [ "BarcodeFormat" ], "type": "BarcodeFormat[] | undefined" }, { "name": "lensFacing", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Configure the camera (front or back) to use.", "complexTypes": [ "LensFacing" ], "type": "LensFacing" }, { "name": "resolution", "tags": [ { "text": "7.0.0", "name": "since" }, { "text": "Resolution['1280x720']", "name": "default" } ], "docs": "Configure the resolution of the captured image that is used for barcode scanning.\n\nIf the resolution is not supported by the device, the closest supported resolution will be used.\n\nOnly available on Android and iOS.", "complexTypes": [ "Resolution" ], "type": "Resolution" }, { "name": "enableMultitaskingCameraAccess", "tags": [ { "text": "7.5.0", "name": "since" }, { "text": "false", "name": "default" } ], "docs": "Allow camera usage on iPad while in multitasking mode.\n\nOnly available on iOS (16.0+).", "complexTypes": [], "type": "boolean | undefined" }, { "name": "videoElement", "tags": [ { "text": "7.1.0", "name": "since" } ], "docs": "The HTML video element to use for the camera preview.\n\nOnly available on web.", "complexTypes": [ "HTMLVideoElement" ], "type": "HTMLVideoElement" } ] }, { "name": "ReadBarcodesFromImageResult", "slug": "readbarcodesfromimageresult", "docs": "", "tags": [ { "text": "0.0.1", "name": "since" } ], "methods": [], "properties": [ { "name": "barcodes", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "The detected barcodes.", "complexTypes": [ "Barcode" ], "type": "Barcode[]" } ] }, { "name": "Barcode", "slug": "barcode", "docs": "", "tags": [ { "text": "0.0.1", "name": "since" } ], "methods": [], "properties": [ { "name": "bytes", "tags": [ { "text": "0.0.1", "name": "since" }, { "text": "[67, 97, 112, 97, 99, 105, 116, 111, 114, 74, 83]", "name": "example" } ], "docs": "Raw bytes as it was encoded in the barcode.", "complexTypes": [], "type": "number[] | undefined" }, { "name": "calendarEvent", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Calendar event info.", "complexTypes": [ "BarcodeCalendarEvent" ], "type": "BarcodeCalendarEvent" }, { "name": "contactInfo", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Person's or organization's business card.", "complexTypes": [ "BarcodeContactInfo" ], "type": "BarcodeContactInfo" }, { "name": "cornerPoints", "tags": [ { "text": "0.0.1", "name": "since" }, { "text": "[[34, 33], [264, 32], [263, 263], [33, 263]]", "name": "example" }, { "text": "This property is experimental and may change in the future.", "name": "experimental" } ], "docs": "The four corner points of the barcode in clockwise\norder starting with top-left.\n\nThis property is currently only supported by the `startScan(...)` method.", "complexTypes": [], "type": "[[number, number], [number, number], [number, number], [number, number]] | undefined" }, { "name": "displayValue", "tags": [ { "text": "0.0.1", "name": "since" }, { "text": "\"CapacitorJS\"", "name": "example" } ], "docs": "The barcode value in a human readable format.", "complexTypes": [], "type": "string" }, { "name": "driverLicense", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Driver license or ID card.", "complexTypes": [ "BarcodeDriverLicense" ], "type": "BarcodeDriverLicense" }, { "name": "email", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "An email message from a 'MAILTO:'.", "complexTypes": [ "BarcodeEmail" ], "type": "BarcodeEmail" }, { "name": "format", "tags": [ { "text": "0.0.1", "name": "since" }, { "text": "\"QR_CODE\"", "name": "example" } ], "docs": "The barcode format.", "complexTypes": [ "BarcodeFormat" ], "type": "BarcodeFormat" }, { "name": "geoPoint", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "GPS coordinates from a 'GEO:'.", "complexTypes": [ "BarcodeGeoPoint" ], "type": "BarcodeGeoPoint" }, { "name": "phone", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Phone number info.", "complexTypes": [ "BarcodePhone" ], "type": "BarcodePhone" }, { "name": "rawValue", "tags": [ { "text": "0.0.1", "name": "since" }, { "text": "\"CapacitorJS\"", "name": "example" } ], "docs": "The barcode value in a machine readable format.\n\nThis value is only available when the barcode is encoded\nin the UTF-8 character set. Otherwise, the `bytes` property\nshould be used and this property will be an empty string.", "complexTypes": [], "type": "string" }, { "name": "sms", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "A sms message from a 'SMS:'.", "complexTypes": [ "BarcodeSms" ], "type": "BarcodeSms" }, { "name": "urlBookmark", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "A URL and title from a 'MEBKM:'.", "complexTypes": [ "BarcodeUrlBookmark" ], "type": "BarcodeUrlBookmark" }, { "name": "valueType", "tags": [ { "text": "0.0.1", "name": "since" }, { "text": "\"TEXT\"", "name": "example" } ], "docs": "The barcode value type.", "complexTypes": [ "BarcodeValueType" ], "type": "BarcodeValueType" }, { "name": "wifi", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "A wifi network parameters from a 'WIFI:'.", "complexTypes": [ "BarcodeWifi" ], "type": "BarcodeWifi" } ] }, { "name": "BarcodeCalendarEvent", "slug": "barcodecalendarevent", "docs": "", "tags": [ { "text": "7.0.0", "name": "since" } ], "methods": [], "properties": [ { "name": "description", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The event description.", "complexTypes": [], "type": "string | undefined" }, { "name": "end", "tags": [ { "text": "7.0.0", "name": "since" }, { "text": "\"2022-12-31T23:59:59.999Z\"", "name": "example" } ], "docs": "The event end date as ISO 8601 string.", "complexTypes": [], "type": "string | undefined" }, { "name": "location", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The event location.", "complexTypes": [], "type": "string | undefined" }, { "name": "organizer", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The event organizer.", "complexTypes": [], "type": "string | undefined" }, { "name": "start", "tags": [ { "text": "7.0.0", "name": "since" }, { "text": "\"2022-01-01T00:00:00.000Z\"", "name": "example" } ], "docs": "The event start date as ISO 8601 string.", "complexTypes": [], "type": "string | undefined" }, { "name": "status", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The event status.", "complexTypes": [], "type": "string | undefined" }, { "name": "summary", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The event summary.", "complexTypes": [], "type": "string | undefined" } ] }, { "name": "BarcodeContactInfo", "slug": "barcodecontactinfo", "docs": "", "tags": [ { "text": "7.0.0", "name": "since" } ], "methods": [], "properties": [ { "name": "addresses", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The contact's addresses.", "complexTypes": [ "Address" ], "type": "Address[] | undefined" }, { "name": "emails", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The contact's emails.", "complexTypes": [ "BarcodeEmail" ], "type": "BarcodeEmail[] | undefined" }, { "name": "personName", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The contact's name.", "complexTypes": [ "PersonName" ], "type": "PersonName" }, { "name": "organization", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The contact's organization.", "complexTypes": [], "type": "string | undefined" }, { "name": "phones", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The contact's phones.", "complexTypes": [ "BarcodePhone" ], "type": "BarcodePhone[] | undefined" }, { "name": "title", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The contact's title.", "complexTypes": [], "type": "string | undefined" }, { "name": "urls", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The contact's urls.", "complexTypes": [], "type": "string[] | undefined" } ] }, { "name": "Address", "slug": "address", "docs": "", "tags": [ { "text": "7.0.0", "name": "since" } ], "methods": [], "properties": [ { "name": "addressLines", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Formatted address, multiple lines when appropriate.", "complexTypes": [], "type": "string[] | undefined" }, { "name": "type", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Address type.", "complexTypes": [ "AddressType" ], "type": "AddressType" } ] }, { "name": "BarcodeEmail", "slug": "barcodeemail", "docs": "", "tags": [ { "text": "7.0.0", "name": "since" } ], "methods": [], "properties": [ { "name": "address", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The email address.", "complexTypes": [], "type": "string | undefined" }, { "name": "body", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The email body.", "complexTypes": [], "type": "string | undefined" }, { "name": "subject", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The email subject.", "complexTypes": [], "type": "string | undefined" }, { "name": "type", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The email address type.", "complexTypes": [ "EmailFormatType" ], "type": "EmailFormatType" } ] }, { "name": "PersonName", "slug": "personname", "docs": "", "tags": [ { "text": "7.0.0", "name": "since" } ], "methods": [], "properties": [ { "name": "first", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "First name.", "complexTypes": [], "type": "string | undefined" }, { "name": "formattedName", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The formatted name.", "complexTypes": [], "type": "string | undefined" }, { "name": "last", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Last name.", "complexTypes": [], "type": "string | undefined" }, { "name": "middle", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Middle name.", "complexTypes": [], "type": "string | undefined" }, { "name": "prefix", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Name prefix.", "complexTypes": [], "type": "string | undefined" }, { "name": "pronunciation", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Text string to be set as the kana name in the phonebook. Used for Japanese contacts.", "complexTypes": [], "type": "string | undefined" }, { "name": "suffix", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Name suffix.", "complexTypes": [], "type": "string | undefined" } ] }, { "name": "BarcodePhone", "slug": "barcodephone", "docs": "", "tags": [ { "text": "7.0.0", "name": "since" } ], "methods": [], "properties": [ { "name": "number", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The phone number.", "complexTypes": [], "type": "string | undefined" }, { "name": "type", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The phone number type.", "complexTypes": [ "PhoneFormatType" ], "type": "PhoneFormatType" } ] }, { "name": "BarcodeDriverLicense", "slug": "barcodedriverlicense", "docs": "", "tags": [ { "text": "7.0.0", "name": "since" } ], "methods": [], "properties": [ { "name": "addressCity", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "City of holder's address.", "complexTypes": [], "type": "string | undefined" }, { "name": "addressState", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "State of holder's address.", "complexTypes": [], "type": "string | undefined" }, { "name": "addressStreet", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Street of holder's address.", "complexTypes": [], "type": "string | undefined" }, { "name": "addressZip", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Postal code of holder's address.", "complexTypes": [], "type": "string | undefined" }, { "name": "birthDate", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Birthdate of the holder.", "complexTypes": [], "type": "string | undefined" }, { "name": "documentType", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "\"DL\" for driver's licenses, \"ID\" for ID cards.", "complexTypes": [], "type": "string | undefined" }, { "name": "expiryDate", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Expiration date of the license.", "complexTypes": [], "type": "string | undefined" }, { "name": "firstName", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Holder's first name.", "complexTypes": [], "type": "string | undefined" }, { "name": "gender", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Holder's gender.", "complexTypes": [], "type": "string | undefined" }, { "name": "issueDate", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Issue date of the license.", "complexTypes": [], "type": "string | undefined" }, { "name": "issuingCountry", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "ISO 3166-1 alpha-3 code in which DL/ID was issued.", "complexTypes": [], "type": "string | undefined" }, { "name": "lastName", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Holder's last name.", "complexTypes": [], "type": "string | undefined" }, { "name": "licenseNumber", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Driver license ID number.", "complexTypes": [], "type": "string | undefined" }, { "name": "middleName", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Holder's middle name.", "complexTypes": [], "type": "string | undefined" } ] }, { "name": "BarcodeGeoPoint", "slug": "barcodegeopoint", "docs": "", "tags": [ { "text": "7.0.0", "name": "since" } ], "methods": [], "properties": [ { "name": "latitude", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Latitude.", "complexTypes": [], "type": "number | undefined" }, { "name": "longitude", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Longitude.", "complexTypes": [], "type": "number | undefined" } ] }, { "name": "BarcodeSms", "slug": "barcodesms", "docs": "", "tags": [ { "text": "7.0.0", "name": "since" } ], "methods": [], "properties": [ { "name": "phoneNumber", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The phone number of the sms.", "complexTypes": [], "type": "string | undefined" }, { "name": "message", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The message content of the sms.", "complexTypes": [], "type": "string | undefined" } ] }, { "name": "BarcodeUrlBookmark", "slug": "barcodeurlbookmark", "docs": "", "tags": [ { "text": "7.0.0", "name": "since" } ], "methods": [], "properties": [ { "name": "url", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The URL of the bookmark.", "complexTypes": [], "type": "string | undefined" }, { "name": "title", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "The title of the bookmark.", "complexTypes": [], "type": "string | undefined" } ] }, { "name": "BarcodeWifi", "slug": "barcodewifi", "docs": "", "tags": [ { "text": "7.0.0", "name": "since" } ], "methods": [], "properties": [ { "name": "encryptionType", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Encryption type of the WI-FI.", "complexTypes": [ "WifiEncryptionType" ], "type": "WifiEncryptionType" }, { "name": "password", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "Password of the WI-FI.", "complexTypes": [], "type": "string | undefined" }, { "name": "ssid", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "SSID of the WI-FI.", "complexTypes": [], "type": "string | undefined" } ] }, { "name": "ReadBarcodesFromImageOptions", "slug": "readbarcodesfromimageoptions", "docs": "", "tags": [ { "text": "0.0.1", "name": "since" } ], "methods": [], "properties": [ { "name": "formats", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Improve the speed of the barcode scanner by configuring\nthe barcode formats to scan for.", "complexTypes": [ "BarcodeFormat" ], "type": "BarcodeFormat[] | undefined" }, { "name": "path", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "The local path to the image file.", "complexTypes": [], "type": "string" } ] }, { "name": "ScanResult", "slug": "scanresult", "docs": "", "tags": [ { "text": "0.0.1", "name": "since" } ], "methods": [], "properties": [ { "name": "barcodes", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "The detected barcodes.", "complexTypes": [ "Barcode" ], "type": "Barcode[]" } ] }, { "name": "ScanOptions", "slug": "scanoptions", "docs": "", "tags": [ { "text": "0.0.1", "name": "since" } ], "methods": [], "properties": [ { "name": "formats", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Improve the speed of the barcode scanner by configuring\nthe barcode formats to scan for.", "complexTypes": [ "BarcodeFormat" ], "type": "BarcodeFormat[] | undefined" }, { "name": "autoZoom", "tags": [ { "text": "7.4.0", "name": "since" } ], "docs": "Toggle the auto zoom feature.", "complexTypes": [], "type": "boolean | undefined" } ] }, { "name": "IsSupportedResult", "slug": "issupportedresult", "docs": "", "tags": [ { "text": "0.0.1", "name": "since" } ], "methods": [], "properties": [ { "name": "supported", "tags": [ { "text": "0.0.1", "name": "since" }, { "text": "true", "name": "example" } ], "docs": "Whether or not the barcode scanner is supported by checking if the device has a camera.", "complexTypes": [], "type": "boolean" } ] }, { "name": "IsTorchEnabledResult", "slug": "istorchenabledresult", "docs": "", "tags": [ { "text": "0.0.1", "name": "since" } ], "methods": [], "properties": [ { "name": "enabled", "tags": [ { "text": "0.0.1", "name": "since" }, { "text": "true", "name": "example" } ], "docs": "Whether or not the torch is enabled.", "complexTypes": [], "type": "boolean" } ] }, { "name": "IsTorchAvailableResult", "slug": "istorchavailableresult", "docs": "", "tags": [ { "text": "0.0.1", "name": "since" } ], "methods": [], "properties": [ { "name": "available", "tags": [ { "text": "0.0.1", "name": "since" }, { "text": "true", "name": "example" } ], "docs": "Whether or not the torch is available.", "complexTypes": [], "type": "boolean" } ] }, { "name": "SetZoomRatioOptions", "slug": "setzoomratiooptions", "docs": "", "tags": [ { "text": "5.4.0", "name": "since" } ], "methods": [], "properties": [ { "name": "zoomRatio", "tags": [ { "text": "5.4.0", "name": "since" } ], "docs": "The zoom ratio to set.", "complexTypes": [], "type": "number" } ] }, { "name": "GetZoomRatioResult", "slug": "getzoomratioresult", "docs": "", "tags": [ { "text": "5.4.0", "name": "since" } ], "methods": [], "properties": [ { "name": "zoomRatio", "tags": [ { "text": "5.4.0", "name": "since" } ], "docs": "The zoom ratio.", "complexTypes": [], "type": "number" } ] }, { "name": "GetMinZoomRatioResult", "slug": "getminzoomratioresult", "docs": "", "tags": [ { "text": "5.4.0", "name": "since" } ], "methods": [], "properties": [ { "name": "zoomRatio", "tags": [ { "text": "5.4.0", "name": "since" } ], "docs": "The minimum zoom ratio.", "complexTypes": [], "type": "number" } ] }, { "name": "GetMaxZoomRatioResult", "slug": "getmaxzoomratioresult", "docs": "", "tags": [ { "text": "5.4.0", "name": "since" } ], "methods": [], "properties": [ { "name": "zoomRatio", "tags": [ { "text": "5.4.0", "name": "since" } ], "docs": "The maximum zoom ratio.", "complexTypes": [], "type": "number" } ] }, { "name": "IsGoogleBarcodeScannerModuleAvailableResult", "slug": "isgooglebarcodescannermoduleavailableresult", "docs": "", "tags": [ { "text": "5.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "available", "tags": [ { "text": "5.1.0", "name": "since" } ], "docs": "Whether or not the Google Barcode Scanner module is available.", "complexTypes": [], "type": "boolean" } ] }, { "name": "PermissionStatus", "slug": "permissionstatus", "docs": "", "tags": [ { "text": "0.0.1", "name": "since" } ], "methods": [], "properties": [ { "name": "camera", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "", "complexTypes": [ "CameraPermissionState" ], "type": "CameraPermissionState" } ] }, { "name": "PluginListenerHandle", "slug": "pluginlistenerhandle", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "remove", "tags": [], "docs": "", "complexTypes": [], "type": "() => Promise" } ] }, { "name": "BarcodesScannedEvent", "slug": "barcodesscannedevent", "docs": "", "tags": [ { "text": "6.2.0", "name": "since" } ], "methods": [], "properties": [ { "name": "barcodes", "tags": [ { "text": "6.2.0", "name": "since" } ], "docs": "The detected barcodes.", "complexTypes": [ "Barcode" ], "type": "Barcode[]" } ] }, { "name": "ScanErrorEvent", "slug": "scanerrorevent", "docs": "", "tags": [ { "text": "0.0.1", "name": "since" } ], "methods": [], "properties": [ { "name": "message", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "The error message.", "complexTypes": [], "type": "string" } ] }, { "name": "GoogleBarcodeScannerModuleInstallProgressEvent", "slug": "googlebarcodescannermoduleinstallprogressevent", "docs": "", "tags": [ { "text": "5.1.0", "name": "since" } ], "methods": [], "properties": [ { "name": "state", "tags": [ { "text": "5.1.0", "name": "since" } ], "docs": "The current state of the installation.", "complexTypes": [ "GoogleBarcodeScannerModuleInstallState" ], "type": "GoogleBarcodeScannerModuleInstallState" }, { "name": "progress", "tags": [ { "text": "5.1.0", "name": "since" } ], "docs": "The progress of the installation in percent between 0 and 100.", "complexTypes": [], "type": "number | undefined" } ] } ], "enums": [ { "name": "BarcodeFormat", "slug": "barcodeformat", "members": [ { "name": "Aztec", "value": "'AZTEC'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Only available on Android and iOS." }, { "name": "Codabar", "value": "'CODABAR'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Only available on Android and iOS." }, { "name": "Code39", "value": "'CODE_39'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Only available on Android and iOS." }, { "name": "Code93", "value": "'CODE_93'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Only available on Android and iOS." }, { "name": "Code128", "value": "'CODE_128'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Only available on Android and iOS." }, { "name": "DataMatrix", "value": "'DATA_MATRIX'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Only available on Android and iOS." }, { "name": "Ean8", "value": "'EAN_8'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Only available on Android and iOS." }, { "name": "Ean13", "value": "'EAN_13'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Only available on Android and iOS." }, { "name": "Itf", "value": "'ITF'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Only available on Android and iOS." }, { "name": "Pdf417", "value": "'PDF_417'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Only available on Android and iOS." }, { "name": "QrCode", "value": "'QR_CODE'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Only available on Android and iOS." }, { "name": "UpcA", "value": "'UPC_A'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Only available on Android and iOS." }, { "name": "UpcE", "value": "'UPC_E'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "Only available on Android and iOS." } ] }, { "name": "LensFacing", "slug": "lensfacing", "members": [ { "name": "Front", "value": "'FRONT'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "" }, { "name": "Back", "value": "'BACK'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "" } ] }, { "name": "Resolution", "slug": "resolution", "members": [ { "name": "'640x480'", "value": "0", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" }, { "name": "'1280x720'", "value": "1", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" }, { "name": "'1920x1080'", "value": "2", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" }, { "name": "'3840x2160'", "value": "3", "tags": [ { "text": "7.2.0", "name": "since" } ], "docs": "" } ] }, { "name": "AddressType", "slug": "addresstype", "members": [ { "name": "HOME", "value": "0", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" }, { "name": "UNKNOWN", "value": "1", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" }, { "name": "WORK", "value": "2", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" } ] }, { "name": "EmailFormatType", "slug": "emailformattype", "members": [ { "name": "HOME", "value": "0", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" }, { "name": "UNKNOWN", "value": "1", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" }, { "name": "WORK", "value": "2", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" } ] }, { "name": "PhoneFormatType", "slug": "phoneformattype", "members": [ { "name": "FAX", "value": "0", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" }, { "name": "HOME", "value": "1", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" }, { "name": "MOBILE", "value": "2", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" }, { "name": "UNKNOWN", "value": "3", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" }, { "name": "WORK", "value": "4", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" } ] }, { "name": "BarcodeValueType", "slug": "barcodevaluetype", "members": [ { "name": "CalendarEvent", "value": "'CALENDAR_EVENT'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "" }, { "name": "ContactInfo", "value": "'CONTACT_INFO'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "" }, { "name": "DriversLicense", "value": "'DRIVERS_LICENSE'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "" }, { "name": "Email", "value": "'EMAIL'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "" }, { "name": "Geo", "value": "'GEO'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "" }, { "name": "Isbn", "value": "'ISBN'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "" }, { "name": "Phone", "value": "'PHONE'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "" }, { "name": "Product", "value": "'PRODUCT'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "" }, { "name": "Sms", "value": "'SMS'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "" }, { "name": "Text", "value": "'TEXT'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "" }, { "name": "Url", "value": "'URL'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "" }, { "name": "Wifi", "value": "'WIFI'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "" }, { "name": "Unknown", "value": "'UNKNOWN'", "tags": [ { "text": "0.0.1", "name": "since" } ], "docs": "" } ] }, { "name": "WifiEncryptionType", "slug": "wifiencryptiontype", "members": [ { "name": "OPEN", "value": "1", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" }, { "name": "WEP", "value": "2", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" }, { "name": "WPA", "value": "3", "tags": [ { "text": "7.0.0", "name": "since" } ], "docs": "" } ] }, { "name": "GoogleBarcodeScannerModuleInstallState", "slug": "googlebarcodescannermoduleinstallstate", "members": [ { "name": "UNKNOWN", "value": "0", "tags": [ { "text": "5.1.0", "name": "since" } ], "docs": "" }, { "name": "PENDING", "value": "1", "tags": [ { "text": "5.1.0", "name": "since" } ], "docs": "" }, { "name": "DOWNLOADING", "value": "2", "tags": [ { "text": "5.1.0", "name": "since" } ], "docs": "" }, { "name": "CANCELED", "value": "3", "tags": [ { "text": "5.1.0", "name": "since" } ], "docs": "" }, { "name": "COMPLETED", "value": "4", "tags": [ { "text": "5.1.0", "name": "since" } ], "docs": "" }, { "name": "FAILED", "value": "5", "tags": [ { "text": "5.1.0", "name": "since" } ], "docs": "" }, { "name": "INSTALLING", "value": "6", "tags": [ { "text": "5.1.0", "name": "since" } ], "docs": "" }, { "name": "DOWNLOAD_PAUSED", "value": "7", "tags": [ { "text": "5.1.0", "name": "since" } ], "docs": "" } ] } ], "typeAliases": [ { "name": "CameraPermissionState", "slug": "camerapermissionstate", "docs": "", "types": [ { "text": "PermissionState", "complexTypes": [ "PermissionState" ] }, { "text": "'limited'", "complexTypes": [] } ] }, { "name": "PermissionState", "slug": "permissionstate", "docs": "", "types": [ { "text": "'prompt'", "complexTypes": [] }, { "text": "'prompt-with-rationale'", "complexTypes": [] }, { "text": "'granted'", "complexTypes": [] }, { "text": "'denied'", "complexTypes": [] } ] } ], "pluginConfigs": [] }