UARetailEventTemplate

@interface UARetailEventTemplate : NSObject

A UARetailEventTemplate represents a custom retail event template for the application.

  • The event’s value. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSDecimalNumber *eventValue;

    Swift

    var eventValue: NSDecimalNumber? { get set }
  • The event’s transaction ID. The transaction ID’s length must not exceed 255 characters or it will invalidate the event.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *transactionID;

    Swift

    var transactionID: String? { get set }
  • The event’s ID. The ID’s length must not exceed 255 characters or it will invalidate the event.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *identifier;

    Swift

    var identifier: String? { get set }
  • The event’s category. The category’s length must not exceed 255 characters or it will invalidate the event.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *category;

    Swift

    var category: String? { get set }
  • The event’s description. The description’s length must not exceed 255 characters or it will invalidate the event.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *eventDescription;

    Swift

    var eventDescription: String? { get set }
  • The event’s brand. The brand’s length must not exceed 255 characters or it will invalidate the event.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *brand;

    Swift

    var brand: String? { get set }
  • YES if the product is a new item, else NO.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL isNewItem;

    Swift

    var isNewItem: Bool { get set }
  • Factory method for creating a browsed event template.

    Declaration

    Objective-C

    + (nonnull instancetype)browsedTemplate;

    Swift

    class func browsed() -> Self
  • Factory method for creating a browsed event template with a value.

    Declaration

    Objective-C

    + (nonnull instancetype)browsedTemplateWithValueFromString:
        (nullable NSString *)eventValue;

    Swift

    class func browsedTemplateWithValue(from eventValue: String?) -> Self

    Parameters

    eventValue

    The value of the event as as string. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

  • Factory method for creating a browsed event template with a value.

    Declaration

    Objective-C

    + (nonnull instancetype)browsedTemplateWithValue:
        (nullable NSNumber *)eventValue;

    Swift

    class func browsedTemplate(withValue eventValue: NSNumber?) -> Self

    Parameters

    eventValue

    The value of the event. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

  • Factory method for creating an addedToCart event template.

    Declaration

    Objective-C

    + (nonnull instancetype)addedToCartTemplate;

    Swift

    class func addedToCart() -> Self
  • Factory method for creating an addedToCart event template with a value.

    Declaration

    Objective-C

    + (nonnull instancetype)addedToCartTemplateWithValueFromString:
        (nullable NSString *)eventValue;

    Swift

    class func addedToCartTemplateWithValue(from eventValue: String?) -> Self

    Parameters

    eventValue

    The value of the event as as string. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

  • Factory method for creating an addedToCart event template with a value.

    Declaration

    Objective-C

    + (nonnull instancetype)addedToCartTemplateWithValue:
        (nullable NSNumber *)eventValue;

    Swift

    class func addedToCartTemplate(withValue eventValue: NSNumber?) -> Self

    Parameters

    eventValue

    The value of the event. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

  • Factory method for creating a starredProduct event template

    Declaration

    Objective-C

    + (nonnull instancetype)starredProductTemplate;

    Swift

    class func starredProduct() -> Self
  • Factory method for creating a starredProduct event template with a value.

    Declaration

    Objective-C

    + (nonnull instancetype)starredProductTemplateWithValueFromString:
        (nullable NSString *)eventValue;

    Swift

    class func starredProductTemplateWithValue(from eventValue: String?) -> Self

    Parameters

    eventValue

    The value of the event as as string. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

  • Factory method for creating a starredProduct event template with a value.

    Declaration

    Objective-C

    + (nonnull instancetype)starredProductTemplateWithValue:
        (nullable NSNumber *)eventValue;

    Swift

    class func starredProductTemplate(withValue eventValue: NSNumber?) -> Self

    Parameters

    eventValue

    The value of the event. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

  • Factory method for creating a purchased event template.

    Declaration

    Objective-C

    + (nonnull instancetype)purchasedTemplate;

    Swift

    class func purchased() -> Self
  • Factory method for creating a purchased event template with a value.

    Declaration

    Objective-C

    + (nonnull instancetype)purchasedTemplateWithValueFromString:
        (nullable NSString *)eventValue;

    Swift

    class func purchasedTemplateWithValue(from eventValue: String?) -> Self

    Parameters

    eventValue

    The value of the event as as string. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

  • Factory method for creating a purchased event template with a value.

    Declaration

    Objective-C

    + (nonnull instancetype)purchasedTemplateWithValue:
        (nullable NSNumber *)eventValue;

    Swift

    class func purchasedTemplate(withValue eventValue: NSNumber?) -> Self

    Parameters

    eventValue

    The value of the event. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

  • Factory method for creating a sharedProduct template event.

    Declaration

    Objective-C

    + (nonnull instancetype)sharedProductTemplate;

    Swift

    class func sharedProduct() -> Self
  • Factory method for creating a sharedProduct event template with a value.

    Declaration

    Objective-C

    + (nonnull instancetype)sharedProductTemplateWithValueFromString:
        (nullable NSString *)eventValue;

    Swift

    class func sharedProductTemplateWithValue(from eventValue: String?) -> Self

    Parameters

    eventValue

    The value of the event as as string. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

  • Factory method for creating a sharedProduct event template with a value.

    Declaration

    Objective-C

    + (nonnull instancetype)sharedProductTemplateWithValue:
        (nullable NSNumber *)eventValue;

    Swift

    class func sharedProductTemplate(withValue eventValue: NSNumber?) -> Self

    Parameters

    eventValue

    The value of the event. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

  • Factory method for creating a sharedProduct event template. - parameter: source The source as an NSString. - parameter: medium The medium as an NSString.

    Declaration

    Objective-C

    + (nonnull instancetype)
        sharedProductTemplateWithSource:(nullable NSString *)source
                             withMedium:(nullable NSString *)medium;

    Swift

    class func sharedProductTemplate(withSource source: String?, withMedium medium: String?) -> Self

    Parameters

    source

    The source as an NSString.

    medium

    The medium as an NSString.

  • Factory method for creating a sharedProduct event template with a value.

    Declaration

    Objective-C

    + (nonnull instancetype)
        sharedProductTemplateWithValueFromString:(nullable NSString *)eventValue
                                      withSource:(nullable NSString *)source
                                      withMedium:(nullable NSString *)medium;

    Swift

    class func sharedProductTemplateWithValue(from eventValue: String?, withSource source: String?, withMedium medium: String?) -> Self

    Parameters

    eventValue

    The value of the event as as string. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

    source

    The source as an NSString.

    medium

    The medium as an NSString.

  • Factory method for creating a sharedProduct event template with a value.

    Declaration

    Objective-C

    + (nonnull instancetype)
        sharedProductTemplateWithValue:(nullable NSNumber *)eventValue
                            withSource:(nullable NSString *)source
                            withMedium:(nullable NSString *)medium;

    Swift

    class func sharedProductTemplate(withValue eventValue: NSNumber?, withSource source: String?, withMedium medium: String?) -> Self

    Parameters

    eventValue

    The value of the event. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

    source

    The source as an NSString.

    medium

    The medium as an NSString.

  • Creates the custom retail event.

    Declaration

    Objective-C

    - (nonnull UACustomEvent *)createEvent;

    Swift

    func createEvent() -> UACustomEvent