BRPromotion

Objective-C

@interface BRPromotion : NSObject <BRSerializable>

Swift

class BRPromotion : NSObject, BRSerializable

Represents a promotion identified on the receipt

Properties

  • Identifies which promotion qualified

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *slug;

    Swift

    var slug: String! { get }
  • The reward value for this promotion

    Declaration

    Objective-C

    @property (nonatomic, readonly) float rewardValue;

    Swift

    var rewardValue: Float { get }
  • The reward currency for this promotion

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *rewardCurrency;

    Swift

    var rewardCurrency: String! { get }
  • Error code for failure to qualify

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger errorCode;

    Swift

    var errorCode: Int { get }
  • Error message for failure to qualify

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *errorMessage;

    Swift

    var errorMessage: String! { get }
  • If this promotion qualified, this property contains the indexes of the products in the BRScanResults.products array which caused this promotion to qualify

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<NSNumber *> *relatedProductIndexes;

    Swift

    var relatedProductIndexes: [NSNumber]! { get }
  • If this promotion qualified, this property contains an array of each instance of qualification, and each instance is an array containing the indexes of the products in the BRScanResults.products array which caused this promotion to qualify

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<BRPromotionQualification> *qualifications;

    Swift

    var qualifications: [[NSNumber]]! { get }