ORAEventMeta Class Reference

Inherits from NSObject
Declared in ORAEventSupport.h

Overview

ORAEventMeta is a wrapper class to store common parameter types attached to each event. For all but the most basic events, start by creating a new instance of ORAEventMeta, which will subsequently be attached to the event.

Specifies the hierarchical representation of an application view at the time of the event. For example, this parameter can specify an application path. You can leave this nil to use the default event path.

@property (nonatomic, copy) NSString *eventPath

Declared In

ORAEventSupport.h

Specifies the representation of an application view at the time of the event. For example, this parameter can specify the name of a screen. Should not be nil.

@property (nonatomic, copy) NSString *eventDescription

Declared In

ORAEventSupport.h

Specifies the type of event that occurred, such as a view or tap. Should not be nil.

@property (nonatomic, copy) NSString *eventType

Declared In

ORAEventSupport.h

Specifies any user-defined data to be included with the event. Must be a dictionary with strings as both the key and the value. For example, a user id string to tie events to a given user.

@property (nonatomic, copy) NSDictionary *customParams

Declared In

ORAEventSupport.h

Creates a meta object that stores information about an event

+ (instancetype)eventMetaForPath:(NSString *)eventPath description:(NSString *)eventDescription type:(NSString *)eventType customParams:(NSDictionary *)customParams

Parameters

eventPath

Specifies the hierarchical representation of an application view at the time of the event. For example, this parameter can specify an application path. Leave this nil to use the default event path.
eventDescription

Specifies the representation of an application view at the time of the event. For example, this parameter can specify the name of a screen. Should not be nil.
eventType

Specifies the type of event that occurred, such as a view or tap. Should not be nil.
customParams

Specifies any user-defined data to be included with the event. Must be a dictionary with strings as both the key and the value. For example, a user id string to tie events to a given user.

Return Value

The ORAEventMeta object describing your event

Declared In

ORAEventSupport.h

Creates a meta object that stores information about an event

- (instancetype)initWithEventPath:(NSString *)eventPath description:(NSString *)eventDescription type:(NSString *)eventType customParams:(NSDictionary *)customParams

Parameters

eventPath

Specifies the hierarchical representation of an application view at the time of the event. For example, this parameter can specify an application path. Leave this nil to use the default event path.
eventDescription

Specifies the representation of an application view at the time of the event. For example, this parameter can specify the name of a screen. Should not be nil.
eventType

Specifies the type of event that occurred, such as a view or tap. Should not be nil.
customParams

Specifies any user-defined data to be included with the event. Must be a dictionary with strings as both the key and the value. For example, a user id string to tie events to a given user.

Return Value

The ORAEventMeta object describing your event

Declared In

ORAEventSupport.h