Skip to main content

Enumerations Reference

The following enumerations are available globally.

BRAppearanceColorKey​

Identifiers for every color the SDK can resolve from your BRAppearanceTheme.

Override -[BRAppearanceTheme colorForKey:] and return a UIColor, or nil to keep the built-in style for that element. Each case maps to one background, text color, or icon tint in the SDK's stock scan UI.

Declaration

enum BRAppearanceColorKey : NSInteger {}
enum BRAppearanceColorKey : Int, @unchecked Sendable

BRAppearanceIconKey​

Identifiers for every icon the SDK can resolve from your BRAppearanceTheme.

Override -[BRAppearanceTheme imageForKey:] and return a UIImage, or nil to keep the built-in asset. Each case lists the recommended image size in points; the stock control scales the image to fit its button if you supply a different size, so the listed size produces the cleanest result. Include @2x and @3x variants for Retina screens.

Declaration

enum BRAppearanceIconKey : NSInteger {}
enum BRAppearanceIconKey : Int, @unchecked Sendable

BRDistanceStatus​

Declaration

enum BRDistanceStatus : NSUInteger {}
enum BRDistanceStatus : UInt, @unchecked Sendable

BRWrongRetailerConfidence​

Declaration

enum BRWrongRetailerConfidence : NSUInteger {}
enum BRWrongRetailerConfidence : UInt, @unchecked Sendable

BRLightingCondition​

Declaration

enum BRLightingCondition : NSUInteger {}
enum BRLightingCondition : UInt, @unchecked Sendable

BRCameraType​

Declaration

enum BRCameraType : NSUInteger {}
enum BRCameraType : UInt, @unchecked Sendable

BRCouponType​

Declaration

enum BRCouponType : NSUInteger {}
enum BRCouponType : UInt, @unchecked Sendable

BRMissedEarningsLookupResult​

Declaration

enum BRMissedEarningsLookupResult : NSUInteger {}
enum BRMissedEarningsLookupResult : UInt, @unchecked Sendable

WFRetailerId​

If the retailer is known in advance, setting BRScanOptions.retailerId to one of these values can increase scanning accuracy.

Declaration

enum WFRetailerId : NSUInteger {}
enum WFRetailerId : UInt, @unchecked Sendable

BRMerchantSource​

Represents a single method of identifying the merchant on the receipt.

Declaration

enum BRMerchantSource : NSUInteger {}
enum BRMerchantSource : UInt, @unchecked Sendable

BRErrorCodes​

Declaration

enum BRErrorCodes : NSUInteger {}
enum BRErrorCodes : UInt, @unchecked Sendable

BRSurveyQuestionType​

Declaration

typedef NS_ENUM(NSUInteger, BRSurveyQuestionType) {
    BRSurveyQuestionTypeMultipleChoice,
    BRSurveyQuestionTypeOpenEnded
};
enum BRSurveyQuestionType : UInt, @unchecked Sendable

Cases​

CaseDescription
BRSurveyQuestionTypeMultipleChoiceA multiple choice question.
BRSurveyQuestionTypeOpenEndedAn open-ended question.