Skip to main content

Classes Reference

The following classes are available globally.

ClassDescription
BRAppearanceThemeCustomizes colors and icons in the SDK camera UI
BRCameraViewControllerBase camera controller — subclass to build custom scan UI
BRCouponA coupon or discount found on a receipt
BRFrameAttributesPer-frame image quality attributes from the camera feed
BRMissedEarningsBaseViewControllerBase view controller for the Missed Earnings correction flow
BRPaymentMethodOne payment method used in a transaction
BRProductA line item parsed from a receipt
BRProductAdditionalLineA supplementary line associated with a product
BRPromotionA promotion evaluated against a receipt
BRPromotionInfoRetailer and SKU details for a qualifying promotion
BRQualifiedProductA product that qualifies for a promotion
BRScanManagerSDK singleton — manages camera, license keys, and scan sessions
BRScanOptionsOptions passed into each scan session
BRScanResultsAll parsed data from a completed scan session
BRShipmentA shipment associated with an order
BRSurveyA survey the user qualifies for based on a receipt
BRSurveyAnswerOne answer option within a survey question
BRSurveyQuestionA question within a survey
BRSurveyResponseA user's response to a survey question
BRValueBase class for OCR-extracted values with a confidence score
BRStringValueA string value with OCR confidence score
BRFloatValueA float value with OCR confidence score
BRIntValueAn integer value with OCR confidence score