ORACoreDataCollector Class Reference

Inherits from NSObject
Declared in ORACoreDataCollector.h

Overview

ORACoreDataCollector is the central class. Its central purpose is to log and send events to the collection servers. It's primarily accessed through its sharedCollector singleton. It should not be manually initialized.

Singleton

ORACoreDataCollector should not be initialized manually, but should instead be messaged through this singleton instance.

+ (instancetype)sharedCollector

Return Value

The ORACoreDataCollector singleton object.

Declared In

ORACoreDataCollector.h

General Methods

This method is used for maintaining a session within an embedded UIWebView. Before loading a new webview, use this method to append the current session information onto the URL you wish to load.

- (NSURL *)appendSessionParamsToUrl:(NSURL *)url

Parameters

url

The url you wish to append

Return Value

The final URL to load in your webview, with the current session information appended as a query string.

Declared In

ORACoreDataCollector.h

Opens the given URL in Safari after appending the current session information.

- (void)openURL:(NSURL *)url

Parameters

url

The url to open.

Declared In

ORACoreDataCollector.h

Triggering Events

Creates and schedules a custom event.

- (void)triggerEvent:(NSDictionary *)event

Parameters

event

A dictionary to pass as event

Declared In

ORACoreDataCollector.h

Creates a custom event and schedule immediately without locally storing the event data

- (void)triggerEventImmediately:(NSDictionary *)event

Parameters

event

A dictionary to pass as event

Declared In

ORACoreDataCollector.h

Creates and schedules an event for the application terminating. If automatic events are enabled, an event of this type will automatically be logged, if not, it can be manually logged with this method.

- (NSDictionary *)triggerEventForApplication:(NSString *)appName terminateWithCustomParams:(NSDictionary *)customParams

Parameters

appName

Specifies the name of your application
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

A dictionary of the event that is created

Declared In

ORACoreDataCollector.h

Creates and schedules an event for the application errors. If automatic events are enabled, an event of this type will automatically be logged, if not, it can be manually logged with this method.

- (NSDictionary *)triggerEventForApplication:(NSString *)appName withErrorMessage:(NSString *)errorMessage customParams:(NSDictionary *)customParams

Parameters

appName

Specifies the name of your application
errorMessage

Specifies the error message associated with the error.
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

A dictionary of the event that is created

Declared In

ORACoreDataCollector.h

Creates and schedules an event for a notification firing. This can be used for both local and remote notifications. If automatic events are enabled, an event of this type will automatically be logged, if not, it can be manually logged with this method.

- (NSDictionary *)triggerEventForNotification:(NSString *)notificationMessage withCustomParams:(NSDictionary *)customParams

Parameters

notificationMessage

Specifies the message presented in the notification
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

A dictionary of the event that is created

Declared In

ORACoreDataCollector.h

Creates and schedules an event for the application entering the foreground. If automatic events are enabled, an event of this type will automatically be logged, if not, it can be manually logged with this method.

- (NSDictionary *)triggerEventForApplication:(NSString *)appName willEnterForegroundWithCustomParams:(NSDictionary *)customParams

Parameters

appName

Specifies the name of your application
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

A dictionary of the event that is created

Declared In

ORACoreDataCollector.h

Creates and schedules an event for the application starting. If automatic events are enabled, an event of this type will automatically be logged, if not, it can be manually logged with this method.

- (NSDictionary *)triggerEventForApplication:(NSString *)appName startWithCustomParams:(NSDictionary *)customParams

Parameters

appName

Specifies the name of your application
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

A dictionary of the event that is created

Declared In

ORACoreDataCollector.h

Creates and schedules an event for the application entering the background. If automatic events are enabled, an event of this type will automatically be logged, if not, it can be manually logged with this method.

- (NSDictionary *)triggerEventForApplication:(NSString *)appName didEnterBackgroundWithCustomParams:(NSDictionary *)customParams

Parameters

appName

Specifies the name of your application
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

A dictionary of the event that is created

Declared In

ORACoreDataCollector.h

Creates and schedules an event for a view controller appearing. If automatic events are enabled, an event of this type will automatically be logged, if not, it can be manually logged with this method.

- (NSDictionary *)triggerEventForViewDidAppear:(NSString *)controllerTitle withCustomParams:(NSDictionary *)customParams

Parameters

controllerTitle

Specifies the title of the view controller
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

A dictionary of the event that is created

Declared In

ORACoreDataCollector.h

Creates and schedules an event for a view controller disappearing. If automatic events are enabled, an event of this type will automatically be logged, if not, it can be manually logged with this method.

- (NSDictionary *)triggerEventForViewDidDisappear:(NSString *)controllerTitle withCustomParams:(NSDictionary *)customParams

Parameters

controllerTitle

Specifies the title of the view controller
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

A dictionary of the event that is created

Declared In

ORACoreDataCollector.h

Creates and schedules an event for a screen view such as when a screen, article, or image is viewed.

- (NSDictionary *)triggerEventForScreenView:(ORACoreEventMeta *)meta contentGroup:(NSString *)contentGroup

Parameters

meta

Specifies a ORACoreEventMeta object that stores common parameter types attached to this event.
contentGroup

Specifies a group of related application views.

Return Value

A dictionary of the event that is created

See Also

Declared In

ORACoreDataCollector.h

Creates and schedules a custom event, used to encapsulate any event not covered by the convenience event types.

- (NSDictionary *)triggerEventForCustomEvent:(ORACoreEventMeta *)meta

Parameters

meta

Specifies a ORACoreEventMeta object that stores common parameter types attached to this event.

Return Value

A dictionary of the event that is created

Declared In

ORACoreDataCollector.h

Creates custom event, used to encapsulate UIApplicationState is UIApplicationStateActive or UIApplicationStateBackground .

- (BOOL)isAppInForeground

Return Value

A Boolean of UIApplicationState is created

Declared In

ORACoreDataCollector.h

Schedules events based on group for a listener

- (void)addEventListener:(ORAEventListener *)listener withModuleId:(NSString *)moduleId withName:(NSString *)listenerName withEventGroup:(NSArray *)groups andPriority:(NSInteger)priority

Parameters

listener

Need to specify a listener object
moduleId

Need to specify a unique module name
listenerName

Need to specify a unique listener name
groups

Specifies the groups event listener can subscribe to. Screen, Interaction and custom groups are available.
priority

Sets the priority for the listener.

Declared In

ORACoreDataCollector.h

Removes Event Listener based on listener name

- (void)removeEventListenerWithModuleId:(NSString *)moduleId listenerName:(NSString *)listenerName

Parameters

moduleId

Need to specify a unique module name
listenerName

Need to pass unique listener name

Declared In

ORACoreDataCollector.h