Committed by
GitHub
Merge pull request #308 from brandsimon/sbr/document_barcode_properties
docs: Document barcode properties
Showing
1 changed file
with
24 additions
and
1 deletions
| @@ -206,4 +206,27 @@ import 'package:mobile_scanner/mobile_scanner.dart'; | @@ -206,4 +206,27 @@ import 'package:mobile_scanner/mobile_scanner.dart'; | ||
| 206 | ), | 206 | ), |
| 207 | ); | 207 | ); |
| 208 | } | 208 | } |
| 209 | -``` | ||
| 209 | +``` | ||
| 210 | + | ||
| 211 | +### Scan result | ||
| 212 | + | ||
| 213 | +You can use the following properties of the Barcode, which gets | ||
| 214 | +passed to the `onDetect` function. | ||
| 215 | + | ||
| 216 | +| Property name | Type | Description | ||
| 217 | +|---------------|----------------|-------------------- | ||
| 218 | +| image | Uint8List? | only if returnImage was set to true | ||
| 219 | +| format | BarcodeFormat | | ||
| 220 | +| rawBytes | Uint8List? | binary scan result | ||
| 221 | +| rawValue | String? | Value if barcode is in UTF-8 format | ||
| 222 | +| displayValue | String? | | ||
| 223 | +| type | BarcodeType | | ||
| 224 | +| calendarEvent | CalendarEvent? | | ||
| 225 | +| contactInfo | ContactInfo? | | ||
| 226 | +| driverLicense | DriverLicense? | | ||
| 227 | +| email | Email? | | ||
| 228 | +| geoPoint | GeoPoint? | | ||
| 229 | +| phone | Phone? | | ||
| 230 | +| sms | SMS? | | ||
| 231 | +| url | UrlBookmark? | | ||
| 232 | +| wifi | WiFi? | WiFi Access-Point details |
-
Please register or login to post a comment