ORACoreEventBuilder Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | ORACoreEventBuilder.h |
+ eventForApplication:terminateWithCustomParams:
Marks iOS application life cycle event of application terminated
+ (NSDictionary *)eventForApplication:(NSString *)appName terminateWithCustomParams:(NSDictionary *)customParams
Parameters
appName
|
name of app |
|---|---|
customParams
|
a dictionary of custom event to be attached |
Return Value
An event
Declared In
ORACoreEventBuilder.h
+ eventForApplication:withErrorMessage:customParams:
Create an event when there is an error in the application
+ (NSDictionary *)eventForApplication:(NSString *)appName withErrorMessage:(NSString *)errorMessage customParams:(NSDictionary *)customParams
Parameters
appName
|
name of application |
|---|---|
errorMessage
|
error message |
customParams
|
a dictionary of custom event to be attached on the returning events |
Return Value
An event
Declared In
ORACoreEventBuilder.h
+ eventForNotification:customParams:
Create an event when user clicks on notification
+ (NSDictionary *)eventForNotification:(NSString *)notificationMessage customParams:(NSDictionary *)customParams
Parameters
notificationMessage
|
Notification message |
|---|---|
customParams
|
A dictionary of custom event |
Return Value
An event
Declared In
ORACoreEventBuilder.h
+ eventForApplication:willEnterForegroundWithCustomParams:
Marks iOS application event of application entered into foreground
+ (NSDictionary *)eventForApplication:(NSString *)appName willEnterForegroundWithCustomParams:(NSDictionary *)customParams
Parameters
appName
|
name of app |
|---|---|
customParams
|
a dictionary of custom event to be attached |
Return Value
An event
Declared In
ORACoreEventBuilder.h
+ eventForApplication:startWithCustomParams:
Marks iOS application life cycle event of application start up
+ (NSDictionary *)eventForApplication:(NSString *)appName startWithCustomParams:(NSDictionary *)customParams
Parameters
appName
|
name of app |
|---|---|
customParams
|
a dictionary of custom event to be attached |
Return Value
An event
Declared In
ORACoreEventBuilder.h
+ eventForApplication:didEnterBackgroundWithCustomParams:
Marks iOS application life cycle event entered into background
+ (NSDictionary *)eventForApplication:(NSString *)appName didEnterBackgroundWithCustomParams:(NSDictionary *)customParams
Parameters
appName
|
name of app |
|---|---|
customParams
|
a dictionary of custom event to be attached |
Return Value
An event
Declared In
ORACoreEventBuilder.h
+ eventForViewDidAppear:withCustomParams:
Marks iOS life cycle event of view controller in transition from "Appearing" to "Appeared" state
+ (NSDictionary *)eventForViewDidAppear:(NSString *)controllerTitle withCustomParams:(NSDictionary *)customParams
Parameters
controllerTitle
|
Title of UI |
|---|---|
customParams
|
a dictionary of custom event to be attached |
Return Value
An event
Declared In
ORACoreEventBuilder.h
+ eventForViewDidDisappear:withCustomParams:
Marks iOS life cycle event of view controller in transition from "Appeared" to "Disappearing" state
+ (NSDictionary *)eventForViewDidDisappear:(NSString *)controllerTitle withCustomParams:(NSDictionary *)customParams
Parameters
controllerTitle
|
Title of UI |
|---|---|
customParams
|
a dictionary of custom event to be attached |
Return Value
An event
Declared In
ORACoreEventBuilder.h
+ eventForScreenView:withEventPath:eventDescription:eventType:contentGroup:customParams:
Creates an event for a screen view such as when a screen, article, or image is viewed.
+ (NSDictionary *)eventForScreenView:(NSString *)screenView withEventPath:(NSString *)eventPath eventDescription:(NSString *)eventDescription eventType:(NSString *)eventType contentGroup:(NSString *)contentGroup customParams:(NSDictionary *)customParams
Parameters
screenView
|
Description of current screen view |
|---|---|
eventPath
|
Event path |
eventDescription
|
Event description |
eventType
|
Event type |
contentGroup
|
Content group |
customParams
|
A custom event to be attached to this event |
Return Value
return value description
Declared In
ORACoreEventBuilder.h
+ eventForCustomEventWithEventPath:eventDescription:eventType:customParams:
Creates a custom event
+ (NSDictionary *)eventForCustomEventWithEventPath:(NSString *)eventPath eventDescription:(NSString *)eventDescription eventType:(NSString *)eventType customParams:(NSDictionary *)customParams
Parameters
eventPath
|
Event path |
|---|---|
eventDescription
|
Event description |
eventType
|
Event type |
customParams
|
An custom event to be added to this event |
Return Value
An event
Declared In
ORACoreEventBuilder.h