android/src/com/google/zxing/client/android/Intents.java

   1 /*
   2  * Copyright (C) 2008 ZXing authors
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package com.google.zxing.client.android;
  18
  19 /**
  20  * This class provides the constants to use when sending an Intent to Barcode Scanner.
  21  * These strings are effectively API and cannot be changed.
  22  *
  23  * @author dswitkin@google.com (Daniel Switkin)
  24  */
  25 public final class Intents {
  26   private Intents() {
  27   }
  28
  29   public static final class Scan {
  30     /**
  31      * Send this intent to open the Barcodes app in scanning mode, find a barcode, and return
  32      * the results.
  33      */
  34     public static final String ACTION = "com.google.zxing.client.android.SCAN";
  35
  36     /**
  37      * By default, sending Scan.ACTION will decode all barcodes that we understand. However it
  38      * may be useful to limit scanning to certain formats. Use Intent.putExtra(MODE, value) with
  39      * one of the values below ({@link #PRODUCT_MODE}, {@link #ONE_D_MODE}, {@link #QR_CODE_MODE}).
  40      * Optional.
  41      *
  42      * Setting this is effectively shorthnad for setting explicit formats with {@link #SCAN_FORMATS}.
  43      * It is overridden by that setting.
  44      */
  45     public static final String MODE = "SCAN_MODE";
  46
  47     /**
  48      * Comma-separated list of formats to scan for. The values must match the names of
  49      * {@link com.google.zxing.BarcodeFormat}s, such as {@link com.google.zxing.BarcodeFormat#EAN_13}.
  50      * Example: "EAN_13,EAN_8,QR_CODE"
  51      *
  52      * This overrides {@link #MODE}.
  53      */
  54     public static final String SCAN_FORMATS = "SCAN_FORMATS";
  55
  56     /**
  57      * Decode only UPC and EAN barcodes. This is the right choice for shopping apps which get
  58      * prices, reviews, etc. for products.
  59      */
  60     public static final String PRODUCT_MODE = "PRODUCT_MODE";
  61
  62     /**
  63      * Decode only 1D barcodes (currently UPC, EAN, Code 39, and Code 128).
  64      */
  65     public static final String ONE_D_MODE = "ONE_D_MODE";
  66
  67     /**
  68      * Decode only QR codes.
  69      */
  70     public static final String QR_CODE_MODE = "QR_CODE_MODE";
  71
  72     /**
  73      * If a barcode is found, Barcodes returns RESULT_OK to onActivityResult() of the app which
  74      * requested the scan via startSubActivity(). The barcodes contents can be retrieved with
  75      * intent.getStringExtra(RESULT). If the user presses Back, the result code will be
  76      * RESULT_CANCELED.
  77      */
  78     public static final String RESULT = "SCAN_RESULT";
  79
  80     /**
  81      * Call intent.getStringExtra(RESULT_FORMAT) to determine which barcode format was found.
  82      * See Contents.Format for possible values.
  83      */
  84     public static final String RESULT_FORMAT = "SCAN_RESULT_FORMAT";
  85
  86     /**
  87      * Setting this to false will not save scanned codes in the history.
  88      */
  89     public static final String SAVE_HISTORY = "SAVE_HISTORY";
  90
  91     private Scan() {
  92     }
  93   }
  94
  95   public static final class Encode {
  96     /**
  97      * Send this intent to encode a piece of data as a QR code and display it full screen, so
  98      * that another person can scan the barcode from your screen.
  99      */
 100     public static final String ACTION = "com.google.zxing.client.android.ENCODE";
 101
 102     /**
 103      * The data to encode. Use Intent.putExtra(DATA, data) where data is either a String or a
 104      * Bundle, depending on the type and format specified. Non-QR Code formats should
 105      * just use a String here. For QR Code, see Contents for details.
 106      */
 107     public static final String DATA = "ENCODE_DATA";
 108
 109     /**
 110      * The type of data being supplied if the format is QR Code. Use
 111      * Intent.putExtra(TYPE, type) with one of Contents.Type.
 112      */
 113     public static final String TYPE = "ENCODE_TYPE";
 114
 115     /**
 116      * The barcode format to be displayed. If this isn't specified or is blank,
 117      * it defaults to QR Code. Use Intent.putExtra(FORMAT, format), where
 118      * format is one of Contents.Format.
 119      */
 120     public static final String FORMAT = "com.google.zxing.client.android.ENCODE_FORMAT";
 121
 122     private Encode() {
 123     }
 124   }
 125
 126   public static final class SearchBookContents {
 127     /**
 128      * Use Google Book Search to search the contents of the book provided.
 129      */
 130     public static final String ACTION = "com.google.zxing.client.android.SEARCH_BOOK_CONTENTS";
 131
 132     /**
 133      * The book to search, identified by ISBN number.
 134      */
 135     public static final String ISBN = "ISBN";
 136
 137     /**
 138      * An optional field which is the text to search for.
 139      */
 140     public static final String QUERY = "QUERY";
 141
 142     private SearchBookContents() {
 143     }
 144   }
 145
 146   public static final class Share {
 147     /**
 148      * Give the user a choice of items to encode as a barcode, then render it as a QR Code and
 149      * display onscreen for a friend to scan with their phone.
 150      */
 151     public static final String ACTION = "com.google.zxing.client.android.SHARE";
 152
 153     private Share() {
 154     }
 155   }
 156 }