Titanium SDK # Modules.Barcode
Add-on Barcode module
3.1.0
3.2.0# Overview
# System Requirements
- Titanium SDK 5.5.1+
- Camera Permissions set in your tiapp.xml:
<ti:app>
<!-- ... -->
<ios>
<plist>
<dict>
<key>NSCameraUsageDescription</key>
<string>We need permission to access your device camera.</string>
</dict>
</plist>
</ios>
<!-- ... -->
</ti:app>
# Properties
# allowInstructions
3.1.0Whether or not to display helpful instructions or a changelog when the app is updated.
Default: true
# allowMenu
3.1.0Whether or not to allow the built-in ZXing menu to display.
Default: true
# allowRotation DEPRECATED
3.2.0DEPRECATED SINCE 2.0.0
Value that indicates if the barcode capture should analyze captured images in either portrait or landscape device orientation. (Warning: Analyzing both the captured image and the rotated version(s) of the image will increase the processing time of the capture.)
- true: Captured images will be analyzed in both portrait and landscape orientation.
- false [default]: Captured images will be analyzed using only the current device orientation.
Default: false
# apiName READONLY
3.2.0 3.2.0The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button
returns Ti.UI.Button.
# displayedMessage
3.1.0 3.2.0Controls the message that is displayed to the end user when they are capturing a barcode.
# lifecycleContainer
3.6.0The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.
# useFrontCamera
3.1.0 3.2.0Controls whether or not the front camera on the device will be used to capture barcodes. On Android, this requires API level 9 (Android OS 2.3) or higher. If no front camera is available, this will gracefully fall back to utilize whatever camera is available.
Default: false
# useLED
3.1.0 3.2.0Whether or not to use the LED when scanning barcodes (also known as the flashlight, torch, or some derivation thereof).
Default: false
# Methods
# applyProperties
3.1.0 3.2.0Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
Parameters
| Name | Type | Description |
|---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# cancel
3.1.0 3.2.0Cancels and closes the currently open capture window.
Returns
- Type
- void
# canShow DEPRECATED
3.2.0DEPRECATED SINCE 2.0.0
Whether the barcode scanner camera is allowed.
Returns
- Type
- Boolean
# capture
3.1.0 3.2.0Brings up the camera and begins the capture sequence for processing a barcode.
Parameters
| Name | Type | Description |
|---|---|---|
dictionary | BarcodeCaptureDict | optional |
Returns
- Type
- void
# parse
3.1.0 3.2.0Parses a blob image for barcodes.
Parameters
| Name | Type | Description |
|---|---|---|
dictionary | BarcodeParseDict | optional |
Returns
- Type
- void
# Events
# success
3.1.0 3.2.0Fired upon a successful barcode scan.
Properties
| Name | Type | Description |
|---|---|---|
| format | String | Number | The format of the barcode. Reported with a value of one of the Modules.Barcode.FORMAT_* constant if matching a known format. Otehrwise, may report a string value. |
| result | String | The raw contents of the barcode |
| code | Number | The activity result code from the scanning activity. Use the result constants defined in the Titanium.Android namespace |
| contentType | Number | The type of barcode content. Use the constants defined in this module to determine which. |
| data | Object | The parsed fields associated with the contentType. |
| bytes | Titanium.Buffer | The raw byte array contents of the barcode, when available |
| source | Object | Source object that fired the event. |
| type | String | Name of the event fired. |
| bubbles | Boolean | True if the event will try to bubble up if possible. |
| cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# error
3.1.0 3.2.0Sent when an error occurs.
Properties
| Name | Type | Description |
|---|---|---|
| message | String | The error message |
| code | Number | The activity result code from the scanning activity. Use the result constants defined in the Titanium.Android namespace |
| source | Object | Source object that fired the event. |
| type | String | Name of the event fired. |
| bubbles | Boolean | True if the event will try to bubble up if possible. |
| cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# cancel
3.1.0 3.2.0Sent when the scanning process is canceled.
Properties
| Name | Type | Description |
|---|---|---|
| message | String | The error message |
| code | Number | The activity result code from the scanning activity. Use the result constants defined in the Titanium.Android namespace |
| source | Object | Source object that fired the event. |
| type | String | Name of the event fired. |
| bubbles | Boolean | True if the event will try to bubble up if possible. |
| cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# Constants
# BOOKMARK
3.1.0 3.2.0Used in the success event to specify the assumed content type of the barcode.
# CALENDAR
3.1.0 3.2.0Used in the success event to specify the assumed content type of the barcode.
# CONTACT
3.1.0 3.2.0Used in the success event to specify the assumed content type of the barcode.
3.1.0 3.2.0Used in the success event to specify the assumed content type of the barcode.
# FORMAT_AZTEC
3.1.0 3.2.0Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_CODABAR
3.1.0 3.2.0Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_CODE_128
3.1.0 3.2.0Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_CODE_39
3.1.0 3.2.0Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_CODE_39_MOD_43 DEPRECATED
3.2.0DEPRECATED SINCE 5.0.0
Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_CODE_93
3.1.0 3.2.0Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_DATA_MATRIX
3.1.0 3.2.0Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_EAN_13
3.1.0 3.2.0Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_EAN_8
3.1.0 3.2.0Used in the capture and parse methods to specify accepted formats.
# FORMAT_INTERLEAVED_2_OF_5 DEPRECATED
3.1.0 3.2.0DEPRECATED SINCE 5.0.0
Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_ITF
3.1.0 3.2.0Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_MAXICODE
3.1.0 3.2.0Used in the capture and parse methods and the success event to specify accepted formats.
Please note that Maxicode support is considered Beta, and requires using the pureBarcode hint.
# FORMAT_NONE DEPRECATED
3.1.0 3.2.0DEPRECATED SINCE 5.0.0
Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_PDF_417
3.1.0 3.2.0Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_QR_CODE
3.1.0 3.2.0Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_RSS_14
3.1.0 3.2.0Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_RSS_EXPANDED
3.1.0 3.2.0Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_UPC_A
3.1.0 3.2.0Used in the capture and parse methods and the success event to specify accepted formats.
# FORMAT_UPC_E
3.1.0 3.2.0Used in the capture and parse methods and the success event to specify accepted formats.
# GEOLOCATION
3.1.0 3.2.0Used in the success event to specify the assumed content type of the barcode.
# SMS
3.1.0 3.2.0Used in the success event to specify the assumed content type of the barcode.
# TELEPHONE
3.1.0 3.2.0Used in the success event to specify the assumed content type of the barcode.
# TEXT
3.1.0 3.2.0Used in the success event to specify the assumed content type of the barcode.
# UNKNOWN
3.1.0 3.2.0Used in the success event to specify the assumed content type of the barcode.