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

---

BRCameraErrorCode

Error codes used with errors in the BRCameraErrorDomain, reported via -[BRScanResultsDelegate didEncounterCameraError:]. These represent failures in the SDK's own camera setup/configuration logic, as opposed to errors surfaced directly by AVFoundation.

Declaration

typedef NS_ENUM(NSInteger, BRCameraErrorCode) {
    BRCameraErrorNoCameraAvailable,
    BRCameraErrorFailedToCreateInput,
    BRCameraErrorFailedToAddInput,
    BRCameraErrorFailedToAddOutput,
    BRCameraErrorSessionInterrupted,
    BRCameraErrorFailedToLockForConfiguration,
    BRCameraErrorDeviceDisconnected,
};

enum BRCameraErrorCode : Int, @unchecked Sendable

Cases

Case	Description
BRCameraErrorNoCameraAvailable	No usable camera device could be found on this device.
BRCameraErrorFailedToCreateInput	The SDK could not create a capture input for the camera.
BRCameraErrorFailedToAddInput	The capture session rejected the camera input.
BRCameraErrorFailedToAddOutput	The capture session rejected the video data output.
BRCameraErrorSessionInterrupted	The camera session was interrupted (for example, by a phone call or another app taking priority).
BRCameraErrorFailedToLockForConfiguration	The SDK could not lock the camera device to change its configuration (for example, to set focus or torch).
BRCameraErrorDeviceDisconnected	The active camera device was disconnected.

note

Not every error passed to didEncounterCameraError: uses this domain. When AVFoundation itself supplies the underlying error (for example, from a session runtime error or a photo capture failure), that error is passed through as-is with its original AVFoundationErrorDomain.

---

BRSurveyQuestionType

Declaration

typedef NS_ENUM(NSUInteger, BRSurveyQuestionType) {
    BRSurveyQuestionTypeMultipleChoice,
    BRSurveyQuestionTypeOpenEnded
};

enum BRSurveyQuestionType : UInt, @unchecked Sendable

Cases

Case	Description
BRSurveyQuestionTypeMultipleChoice	A multiple choice question.
BRSurveyQuestionTypeOpenEnded	An open-ended question.