Julian Steenbakker
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';
),
);
}
```
\ No newline at end of file
```
### Scan result
You can use the following properties of the Barcode, which gets
passed to the `onDetect` function.
| Property name | Type | Description
|---------------|----------------|--------------------
| image | Uint8List? | only if returnImage was set to true
| format | BarcodeFormat |
| rawBytes | Uint8List? | binary scan result
| rawValue | String? | Value if barcode is in UTF-8 format
| displayValue | String? |
| type | BarcodeType |
| calendarEvent | CalendarEvent? |
| contactInfo | ContactInfo? |
| driverLicense | DriverLicense? |
| email | Email? |
| geoPoint | GeoPoint? |
| phone | Phone? |
| sms | SMS? |
| url | UrlBookmark? |
| wifi | WiFi? | WiFi Access-Point details
... ...