Classes

The following classes are available globally.

  • Customizes colors and icons in the SDK’s stock scan UI (help sheet, onboarding, camera toolbar, and related surfaces).

    Subclass BRAppearanceTheme and override colorForKey: and / or imageForKey: to supply your own values, then assign an instance to BRScanOptions.appearance before you start a scan. Both methods use an opt-in model: return nil for any key you don’t want to customize and the SDK keeps its built-in value. The base implementation returns nil for every key, so an unmodified BRAppearanceTheme is equivalent to leaving BRScanOptions.appearance set to nil.

    The SDK queries the theme each time the relevant control is configured, so values may be read more than once per scan session and should be cheap to produce. You can swap themes between scans (for example, to react to light / dark mode) by assigning a new instance.

    Example (Objective-C):

      @interface MyAppearanceTheme : BRAppearanceTheme
  @end

  @implementation MyAppearanceTheme
  - (UIColor *)colorForKey:(BRAppearanceColorKey)key {
      if (key == BRAppearanceColorKeyHelpModalCloseButtonBackground) {
          return UIColor.systemBlueColor;
      }
      return nil;
  }
  @end

  BRScanOptions *options = [BRScanOptions new];
  options.appearance = [MyAppearanceTheme new];

    Example (Swift):

      final class MyAppearanceTheme: BRAppearanceTheme {
      override func color(for key: BRAppearanceColorKey) -> UIColor? {
          key == .helpModalCloseButtonBackground ? .systemBlue : nil
      }
  }

  let options = BRScanOptions()
  options.appearance = MyAppearanceTheme()
    See more

    Declaration

    Objective-C

    @interface BRAppearanceTheme : NSObject

    Swift

    class BRAppearanceTheme : NSObject
    Show on GitHub

  • Base camera controller class. Subclass to build your own UI on top of the fullscreen camera view

    See more

    Declaration

    Objective-C

    @interface BRCameraViewController : UIViewController

    Swift

    class BRCameraViewController : UIViewController
    Show on GitHub

  • Describes one coupon or discount on a receipt

    See more

    Declaration

    Objective-C

    @interface BRCoupon : NSObject <BRSerializable>

    Swift

    class BRCoupon : NSObject, BRSerializable
    Show on GitHub
  • See more

    Declaration

    Objective-C

    @interface BRFrameAttributes : NSObject

    Swift

    class BRFrameAttributes : NSObject
    Show on GitHub
  • See more

    Declaration

    Objective-C

    @interface BRMissedEarningsBaseViewController : UIViewController

/**
 *  This property restricts the region in which barcode will be detected. The parametesr are specified as percentages of the view size. The default value is `(0.0, 0.0, 1.0, 1.0)`
 */
@property (nonatomic) CGRect scanningRegion;

/**
 *  Due to differences in barcode lengths, specifying the country code helps determine the correct barcode length the SDK should detect
 */
@property (nonatomic, strong) NSString *countryCode;

/**
 * Override this method to be notified when a barcode is detected. Supports 12 digit and 6 digit UPC's.
 */
- (void)didDetectBarcode:(NSString*)barcode;

/**
 * Perform server lookup of this UPC
 *
 * @param completion This callback is invoked when the lookup completes (or fails)
 *      * `BRMissedEarningsLookupResult lookupResult` - The status of the lookup indicating whether the supplied UPC participates in the program, does not participate, was not found, or if the lookup failed
 *      * `NSDictionary *productInfo` - If the UPC was found, this dictionary contains information about the product. The keys are: `productName`, `brand`, `image_url`, and `brand_participates`, which is a boolean indicating whether this product's brand is part of the program. This helps identify scenarios where some products in a brand participate in the program, but the provided UPC does not. Additionally a `message` key which can contain a custom message for a given product
 */
- (void)lookupUPC:(NSString*)upc withCompletion:(void(^)(BRMissedEarningsLookupResult lookupResult, NSDictionary *productInfo))completion;

/**
 *  Toggle the status of the torch
 *
 *  @param torchOn      Whether to turn the torch on or off
 */
- (void)setTorch:(BOOL)torchOn;

/**
 * When a barcode is found, the capture session is automatically paused. Invoke this method to restart the capture session afterwards.
 */
- (void)restartCaptureSession;

@end

    Swift

    class BRMissedEarningsBaseViewController : UIViewController
    Show on GitHub

  • Described a payment method and the amount charged to that payment method

    See more

    Declaration

    Objective-C

    @interface BRPaymentMethod : NSObject <BRSerializable>

    Swift

    class BRPaymentMethod : NSObject, BRSerializable
    Show on GitHub

  • Describes one product on a receipt

    See more

    Declaration

    Objective-C

    @interface BRProduct : NSObject <BRSerializable>

    Swift

    class BRProduct : NSObject, BRSerializable
    Show on GitHub

  • Represents an additional line of text attached to a product

    See more

    Declaration

    Objective-C

    @interface BRProductAdditionalLine : NSObject <BRSerializable>

    Swift

    class BRProductAdditionalLine : NSObject, BRSerializable
    Show on GitHub

  • Represents a promotion identified on the receipt

    See more

    Declaration

    Objective-C

    @interface BRPromotion : NSObject <BRSerializable>

    Swift

    class BRPromotion : NSObject, BRSerializable
    Show on GitHub

  • Represents information about a promotion retrieved for the current user

    See more

    Declaration

    Objective-C

    @interface BRPromotionInfo : NSObject <BRSerializable>

    Swift

    class BRPromotionInfo : NSObject, BRSerializable
    Show on GitHub
  • See more

    Declaration

    Objective-C

    @interface BRQualifiedProduct : NSObject<BRSerializable>

@property (nonatomic, readonly) NSInteger productIndex;
@property (strong, nonatomic, readonly) NSArray<NSString*> *productGroups;

@end

    Swift

    class BRQualifiedProduct : NSObject, BRSerializable
    Show on GitHub

  • This is the main interface for initiating scanning sessions

    See more

    Declaration

    Objective-C

    @interface BRScanManager : NSObject

    Swift

    class BRScanManager : NSObject
    Show on GitHub

  • Create an instance of this class to specify the scanning options for a session

    See more

    Declaration

    Objective-C

    @interface BRScanOptions : NSObject

    Swift

    class BRScanOptions : NSObject
    Show on GitHub

  • This class holds the scan results for a particular scanning session

    See more

    Declaration

    Objective-C

    @interface BRScanResults : NSObject <BRSerializable>

    Swift

    class BRScanResults : NSObject, BRSerializable
    Show on GitHub

  • Represents one shipment in an Amazon order

    See more

    Declaration

    Objective-C

    @interface BRShipment : NSObject <BRSerializable>

    Swift

    class BRShipment : NSObject, BRSerializable
    Show on GitHub

  • Represents a survey consisting of a series of multiple choice or open ended questions

    See more

    Declaration

    Objective-C

    @interface BRSurvey : NSObject

    Swift

    class BRSurvey : NSObject
    Show on GitHub

  • Represents a multiple choice answer to a survey question

    See more

    Declaration

    Objective-C

    @interface BRSurveyAnswer : NSObject

    Swift

    class BRSurveyAnswer : NSObject
    Show on GitHub

  • Represents a survey question, which is either multiple choice or open-ended

    See more

    Declaration

    Objective-C

    @interface BRSurveyQuestion : NSObject

    Swift

    class BRSurveyQuestion : NSObject
    Show on GitHub

  • Represents a user response to a survey question

    See more

    Declaration

    Objective-C

    @interface BRSurveyResponse : NSObject

    Swift

    class BRSurveyResponse : NSObject
    Show on GitHub

  • Parent class to hold a value and a confidence

    See more

    Declaration

    Objective-C

    @interface BRValue : NSObject <BRSerializable>

    Swift

    class BRValue : NSObject, BRSerializable
    Show on GitHub

  • Child class for all string values

    See more

    Declaration

    Objective-C

    @interface BRStringValue : BRValue

    Swift

    class BRStringValue : BRValue
    Show on GitHub

  • Child class for all float values

    See more

    Declaration

    Objective-C

    @interface BRFloatValue : BRValue

    Swift

    class BRFloatValue : BRValue
    Show on GitHub

  • Child class for all int values

    See more

    Declaration

    Objective-C

    @interface BRIntValue : BRValue

    Swift

    class BRIntValue : BRValue
    Show on GitHub