0.0.6 • Published 4 years ago

cmexx-scanner v0.0.6

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

cmexx-scanner

Plugin para scaneamento de códigos de barras 2D pequenos, com utilização de inteligência artificial.

Install

npm install cmexx-scanner
npx cap sync

API

prepare()

prepare() => Promise<void>

hideBackground()

hideBackground() => Promise<void>

showBackground()

showBackground() => Promise<void>

startScan(...)

startScan(options?: ScanOptions | undefined) => Promise<ScanResult>
ParamType
optionsScanOptions

Returns: Promise<ScanResult>


stopScan(...)

stopScan(options?: StopScanOptions | undefined) => Promise<void>
ParamType
optionsStopScanOptions

checkPermission(...)

checkPermission(options?: CheckPermissionOptions | undefined) => Promise<CheckPermissionResult>
ParamType
optionsCheckPermissionOptions

Returns: Promise<CheckPermissionResult>


openAppSettings()

openAppSettings() => Promise<void>

Interfaces

ScanResult

PropTypeDescriptionSince
hasContentbooleanThis indicates whether or not the scan resulted in readable content. When stopping the scan with resolveScan set to true, for example, this parameter is set to false, because no actual content was scanned.1.0.0
contentstringThis holds the content of the barcode if available.1.0.0

ScanOptions

PropTypeDescriptionSince
targetedFormatsSupportedFormat[]This parameter can be used to make the scanner only recognize specific types of barcodes. If targetedFormats is not specified or left empty, all types of barcodes will be targeted.1.2.0

StopScanOptions

PropTypeDescriptionDefaultSince
resolveScanbooleanIf this is set to true, the startScan method will resolve. Additionally hasContent will be false. For more information see: https://github.com/capacitor-community/barcode-scanner/issues/17true2.1.0

CheckPermissionResult

PropTypeDescriptionSince
grantedbooleanWhen set to true, the ermission is granted.
deniedbooleanWhen set to true, the permission is denied and cannot be prompted for. The openAppSettings method should be used to let the user grant the permission.1.0.0
askedbooleanWhen this is set to true, the user was just prompted the permission. Ergo: a dialog, asking the user to grant the permission, was shown.1.0.0
neverAskedbooleanWhen this is set to true, the user has never been prompted the permission.1.0.0
restrictedbooleaniOS only When this is set to true, the permission cannot be requested for some reason.1.0.0
unknownbooleaniOS only When this is set to true, the permission status cannot be retrieved.1.0.0

CheckPermissionOptions

PropTypeDescriptionDefaultSince
forcebooleanIf this is set to true, the user will be prompted for the permission. The prompt will only show if the permission was not yet granted and also not denied completely yet. For more information see: https://github.com/capacitor-community/barcode-scanner#permissionsfalse1.0.0

Enums

SupportedFormat

MembersValueDescription
UPC_A'UPC_A'Android only, UPC_A is part of EAN_13 according to Apple docs
UPC_E'UPC_E'
UPC_EAN_EXTENSION'UPC_EAN_EXTENSION'Android only
EAN_8'EAN_8'
EAN_13'EAN_13'
CODE_39'CODE_39'
CODE_39_MOD_43'CODE_39_MOD_43'iOS only
CODE_93'CODE_93'
CODE_128'CODE_128'
CODABAR'CODABAR'Android only
ITF'ITF'
ITF_14'ITF_14'iOS only
AZTEC'AZTEC'
DATA_MATRIX'DATA_MATRIX'
MAXICODE'MAXICODE'Android only
PDF_417'PDF_417'
QR_CODE'QR_CODE'
RSS_14'RSS_14'Android only
RSS_EXPANDED'RSS_EXPANDED'Android only
0.0.5

4 years ago

0.0.4

4 years ago

0.0.6

4 years ago

0.0.3

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago