PhoneGap Plugin BarcodeScanner

Кроссплатформенный сканер штрихкодов для Cordova / PhoneGap

Следуя спецификации Cordova Plugin, работает с Plugman.

Установка

Требуется Phonegap 5.0+ (текущая стабильная версия — v3.0.0).

• phonegap plugin add phonegap-plugin-barcodescanner

Старые версии Phonegap могут устанавливать через устаревший идентификатор (устаревшая версия — v2.0.1):

• phonegap plugin add com.phonegap.plugins.barcodescanner

Также можно установить напрямую через URL репозитория (нестабильная версия):

• phonegap plugin add https://github.com/phonegap/phonegap-plugin-barcodescanner.git

Поддерживаемые платформы

— Android; — iOS; — Windows 8; — Windows Phone 8; — BlackBerry 10; — браузер.

Обратите внимание: исходный код проекта для Android включает в себя проект библиотеки Android. Plugman в настоящее время не поддерживает ссылки на проекты библиотек, поэтому он был предварительно собран как jar-библиотека. Любые обновления в проекте библиотеки должны быть зафиксированы вместе с обновлённым jar.

Использование плагина

Плагин создаёт объект cordova/plugin/BarcodeScanner с методом scan(success, fail).

В настоящее время поддерживаются следующие типы штрихкодов:

Android

• QR_CODE;
• DATA_MATRIX;
• UPC_E;
• UPC_A;
• EAN_8;
• EAN_13;
• CODE_128;
• CODE_39;
• CODE_93;
• CODABAR;
• ITF;
• RSS14;
• PDF417;
• RSS_EXPANDED.

iOS

• QR_CODE;
• DATA_MATRIX;
• UPC_E;
• UPC_A;
• EAN_8;
• EAN_13;
• CODE_128;
• CODE_39;
• ITF.

Windows 8

• UPC_A;
• UPC_E;
• EAN_8;
• EAN_13;
• CODE_39;
• CODE_93;
• CODE_128;
• ITF;
• CODABAR;
• MSI;
• RSS14;
• QR_CODE;
• DATA_MATRIX;
• AZTEC;
• PDF417.

Windows Phone 8

• UPC_A;
• UPC_E;
• EAN_8;
• EAN_13;
• CODE_39;
• CODE_93;
• CODE_128;
• ITF;
• CODABAR;
• MSI;
• RSS14;
• QR_CODE;
• DATA_MATRIX;
• AZTEC;
• PDF417.

BlackBerry 10

• UPC_A;
• UPC_E;
• EAN_8;
• EAN_13;
• CODE_39;
• CODE_128;
• ITF;
• DATA_MATRIX;
• AZTEC.

Функции success и fail являются обратными вызовами. Success передаётся объекту с данными, типом и отменёнными свойствами. Данные — это текстовое представление данных штрихкода, тип — обнаруженный тип штрихкода, а отменённое — отменил ли пользователь сканирование.

Полный пример может выглядеть так:

cordova.plugins.barcodeScanner.scan(
  function (result) {
      alert("We got a barcode\n" +
            "Result: " + result.text + "\n" +
            "Format: " + result.format + "\n" +
            "Cancelled: " + result.cancelled);
  }, 
  function (error) {
      alert("Scanning failed: " + error);
  }
);

Кодирование штрихкода

Плагин создаёт объект cordova.plugins.barcodeScanner с методом encode(type, data, success, fail).

Поддерживаемые типы кодирования:

• TEXT_TYPE;
• EMAIL_TYPE;
• PHONE_TYPE;
• SMS_TYPE.

Пример:

Полный пример:

cordova.plugins.barcodeScanner.encode(cordova.plugins.barcodeScanner.Encode.TEXT_TYPE, "http://www.nytimes.com", function(success) {
          alert("encode success: " + success);
        }, function(fail) {
          alert("encoding failed: " + fail);
        }
      );

Особенности Windows 8

Реализация для Windows 8 в настоящее время не поддерживает функцию кодирования.

Особенности Windows Phone 8

Реализация для Windows Phone 8 в настоящее время не поддерживает функцию кодирования.

Особенности BlackBerry 10

Реализация для BlackBerry 10 в настоящее время не поддерживает функцию кодирования. Отмена сканирования на BlackBerry 10 выполняется прикосновением к экрану.

Благодарности на Github

Так много — загляните в оригинальные репозитории iOS, Android и BlackBerry 10.

Лицензия

Лицензия MIT.

Авторские права (c) 2010 Мэтт Кейн.

Разрешение предоставляется бесплатно. Право на использование

Правообладатель передаёт любому лицу, получающему копию данного программного обеспечения и связанных с ним файлов документации («Программное обеспечение»), право свободно работать с Программным обеспечением без ограничений, включая, помимо прочего, права на использование, копирование, изменение, объединение, публикацию, распространение, сублицензирование и (или) продажу копий Программного обеспечения, а также право разрешать лицам, которым предоставлено Программное обеспечение, выполнять эти действия при соблюдении следующих условий:

Вышеупомянутое уведомление об авторских правах и данное разрешение должны быть включены во все копии или существенные части Программного обеспечения.

ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ, ПОМИМО ПРОЧЕГО, ГАРАНТИИ ТОВАРНОЙ ПРИГОДНОСТИ, СООТВЕТСТВИЯ КОНКРЕТНОЙ ЦЕЛИ И ОТСУТСТВИЯ НАРУШЕНИЙ ПРАВ ТРЕТЬИХ СТОРОН. НИ ПРИ КАКИХ ОБСТОЯТЕЛЬСТВАХ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ЗА ЛЮБЫЕ ПРЕТЕНЗИИ, УЩЕРБ ИЛИ ДРУГИЕ ОБЯЗАТЕЛЬСТВА, ВОЗНИКАЮЩИЕ В РЕЗУЛЬТАТЕ ДЕЙСТВИЙ ПО ДОГОВОРУ, ДЕЛИКТА ИЛИ ИНЫМ ОБРАЗОМ, СВЯЗАННЫЕ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ИЛИ ИНЫМИ ДЕЙСТВИЯМИ В ОТНОШЕНИИ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ.