BranchEvent

@interface BranchEvent : NSObject

User actions and app events can be tracked with BranchEvent. BranchEvents can be attributed back to Branch sessions and campaigns in the Branch dashboard, giving you greater insight into effective campaigns and app use.

  • Undocumented

    Declaration

    Objective-C

    - (instancetype _Nonnull) initWithName:(NSString*_Nonnull)name NS_DESIGNATED_INITIALIZER;

    Swift

    init(name: String)
  • Undocumented

    Declaration

    Objective-C

    + (instancetype _Nonnull) standardEvent:(BranchStandardEvent _Nonnull)standardEvent;

    Swift

    class func standardEvent(_ standardEvent: BranchStandardEvent) -> Self
  • Undocumented

    Declaration

    Objective-C

    + (instancetype _Nonnull) standardEvent:(BranchStandardEvent _Nonnull)standardEvent
                                contentItem:(BranchUniversalObject* _Nonnull)contentItem;

    Swift

    class func standardEvent(_ standardEvent: BranchStandardEvent, contentItem: BranchUniversalObject) -> Self
  • Undocumented

    Declaration

    Objective-C

    + (instancetype _Nonnull) customEventWithName:(NSString*_Nonnull)name;

    Swift

    class func customEvent(withName name: String) -> Self
  • Undocumented

    Declaration

    Objective-C

    + (instancetype _Nonnull) customEventWithName:(NSString*_Nonnull)name
                                      contentItem:(BranchUniversalObject*_Nonnull)contentItem;

    Swift

    class func customEvent(withName name: String, contentItem: BranchUniversalObject) -> Self
  • Undocumented

    Declaration

    Objective-C

    - (instancetype _Nonnull) init __attribute((unavailable));
  • Undocumented

    Declaration

    Objective-C

    + (instancetype _Nonnull) new __attribute((unavailable));
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString*               eventName

    Swift

    var eventName: String { get }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString*_Nullable                transactionID

    Swift

    var transactionID: String? { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong) BNCCurrency _Nullable             currency

    Swift

    var currency: BNCCurrency? { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDecimalNumber*_Nullable         revenue

    Swift

    var revenue: NSDecimalNumber? { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDecimalNumber*_Nullable         shipping

    Swift

    var shipping: NSDecimalNumber? { get set }
  • tax

    Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDecimalNumber*_Nullable         tax

    Swift

    var tax: NSDecimalNumber? { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString*_Nullable                coupon

    Swift

    var coupon: String? { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString*_Nullable                affiliation

    Swift

    var affiliation: String? { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString*_Nullable                eventDescription

    Swift

    var eventDescription: String? { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString*_Nullable                searchQuery

    Swift

    var searchQuery: String? { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, copy) NSMutableArray<BranchUniversalObject*>*_Nonnull       contentItems

    Swift

    @NSCopying var contentItems: NSMutableArray { get set }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, copy) NSMutableDictionary<NSString*, NSString*> *_Nonnull   customData

    Swift

    @NSCopying var customData: NSMutableDictionary { get set }
  • Undocumented

    Declaration

    Objective-C

    - (NSDictionary *_Nonnull)dictionary;

    Swift

    func dictionary() -> [AnyHashable : Any]
  • Undocumented

    Declaration

    Objective-C

    - (NSString *_Nonnull)description;

    Swift

    func description() -> String
  • Undocumented

    Declaration

    Objective-C

    - (BOOL) isStandardEvent;

    Swift

    func isStandardEvent() -> Bool
  • Undocumented

    Declaration

    Objective-C

    + (nonnull NSArray<NSString *> *)standardEvents;

    Swift

    class func standardEvents() -> [String]