ORADataCollector Class Reference

Inherits from NSObject
Declared in ORADataCollector.h

Overview

ORADataCollector 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

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

+ (instancetype)sharedCollector

Return Value

The ORADataCollector singleton.

Declared In

ORADataCollector.h

Triggering Events

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

ORADataCollector.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

ORADataCollector.h

Creates and schedules an event for an advertisement being tapped.

- (NSDictionary *)triggerEventForAdClickName:(NSString *)adName eventMeta:(ORAEventMeta *)meta

Parameters

adName

Specifies the name of the advertisement.
meta

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

Return Value

A dictionary of the event that is created

See Also

Declared In

ORADataCollector.h

Creates and schedules an event for an ad impression

- (NSDictionary *)triggerEventForAdImpressionNames:(NSArray *)adNames eventMeta:(ORAEventMeta *)meta

Parameters

adNames

Specifies an array of string ad names that were shown.
meta

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

Return Value

A dictionary of the event that is created

See Also

Declared In

ORADataCollector.h

Creates and schedules an event for a search event

- (NSDictionary *)triggerEventForSearchPhrase:(NSString *)searchPhrase searchResult:(NSString *)searchResult eventMeta:(ORAEventMeta *)meta

Parameters

searchPhrase

Specifies the string the user searched for.
searchResult

Specifies the string of the search result.
meta

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

Return Value

A dictionary of the event that is created

See Also

Declared In

ORADataCollector.h

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

- (NSDictionary *)triggerEventForContentView:(ORAEventMeta *)meta contentGroup:(NSString *)contentGroup

Parameters

meta

Specifies a ORAEventMeta 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

ORADataCollector.h

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

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

Parameters

meta

Specifies a ORAEventMeta 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

ORADataCollector.h

Creates and schedules an event for a product

- (NSDictionary *)triggerEventForProduct:(ORAProductMeta *)productMeta contentGroup:(NSString *)contentGroup eventMeta:(ORAEventMeta *)meta

Parameters

productMeta

Specifies a ORAProductMeta object that stores parameter types associated with product event.
contentGroup

Specifies a group of related application views.
meta

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

Return Value

A dictionary of the event that is created

See Also

Declared In

ORADataCollector.h

Creates and schedules an event for a cart transaction

- (NSDictionary *)triggerEventForCartTransaction:(ORAProductMeta *)productMeta contentGroup:(NSString *)contentGroup eventMeta:(ORAEventMeta *)meta invoiceNumber:(NSString *)invoiceNumber

Parameters

productMeta

Specifies a ORAProductMeta object that stores parameter types associated with cart transaction event.
contentGroup

Specifies a group of related application views.
meta

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

Specifies an integer string to identify invoice attached to this event.

Return Value

A dictionary of the event that is created

See Also

Declared In

ORADataCollector.h

Creates and schedules an event for a media view

- (NSDictionary *)triggerEventForEventMedia:(ORAEventMedia *)media contentGroup:(NSString *)contentGroup eventMeta:(ORAEventMeta *)meta

Parameters

media

Specifies a ORAEventMedia object that stores parameter types associated with media events.
contentGroup

Specifies a group of related application views.
meta

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

Return Value

A dictionary of the event that is created

See Also

Declared In

ORADataCollector.h

Creates and schedules an event for a conversion, such as when a purchase or registration, occurs.

- (NSDictionary *)triggerEventForConversion:(NSString *)conversionName contentGroup:(NSString *)contentGroup eventMeta:(ORAEventMeta *)meta

Parameters

conversionName

Specifies the name used to identify a customer conversion.
contentGroup

Specifies a group of related application views.
meta

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

Return Value

A dictionary of the event that is created

See Also

Declared In

ORADataCollector.h

Creates and schedules an event for an arbitrary action, such as a button tap

- (NSDictionary *)triggerEventForAction:(ORAEventMeta *)meta

Parameters

meta

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

Return Value

A dictionary of the event that is created

Declared In

ORADataCollector.h

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

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

Parameters

meta

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

Return Value

A dictionary of the event that is created

Declared In

ORADataCollector.h

Creates and schedules a drag and drop event, such as drag and drop UI element between layouts/screens.

- (NSDictionary *)triggerEventForDragAndDrop:(ORAEventMeta *)meta

Parameters

meta

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

Return Value

A dictionary of the event that is created

Declared In

ORADataCollector.h

Creates and schedules a video load event

- (NSDictionary *)triggerEventForVideoLoad:(ORAVideoMeta *)videoMeta eventMeta:(ORAEventMeta *)meta

Parameters

videoMeta

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

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

Return Value

A dictionary of the event that is created

Declared In

ORADataCollector.h

Creates and schedules a video load meta event

- (NSDictionary *)triggerEventForVideoLoadMeta:(ORAVideoMeta *)videoMeta eventMeta:(ORAEventMeta *)meta

Parameters

videoMeta

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

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

Return Value

A dictionary of the event that is created

Declared In

ORADataCollector.h

Creates and schedules a video play event

- (NSDictionary *)triggerEventForVideoPlay:(ORAVideoMeta *)videoMeta eventMeta:(ORAEventMeta *)meta

Parameters

videoMeta

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

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

Return Value

A dictionary of the event that is created

Declared In

ORADataCollector.h

Creates and schedules a video resume event

- (NSDictionary *)triggerEventForVideoResume:(ORAVideoMeta *)videoMeta eventMeta:(ORAEventMeta *)meta

Parameters

videoMeta

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

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

Return Value

A dictionary of the event that is created

Declared In

ORADataCollector.h

Creates and schedules a video pause event

- (NSDictionary *)triggerEventForVideoPause:(ORAVideoMeta *)videoMeta eventMeta:(ORAEventMeta *)meta

Parameters

videoMeta

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

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

Return Value

A dictionary of the event that is created

Declared In

ORADataCollector.h

Creates and schedules a video quartile event

- (NSDictionary *)triggerEventForVideoQuartile:(ORAVideoMeta *)videoMeta eventMeta:(ORAEventMeta *)meta

Parameters

videoMeta

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

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

Return Value

A dictionary of the event that is created

Declared In

ORADataCollector.h

Creates and schedules a video volume change event

- (NSDictionary *)triggerEventForVideoVolumeChange:(ORAVideoMeta *)videoMeta eventMeta:(ORAEventMeta *)meta

Parameters

videoMeta

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

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

Return Value

A dictionary of the event that is created

Declared In

ORADataCollector.h

Creates and schedules a video seek event

- (NSDictionary *)triggerEventForVideoSeek:(ORAVideoMeta *)videoMeta eventMeta:(ORAEventMeta *)meta

Parameters

videoMeta

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

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

Return Value

A dictionary of the event that is created

Declared In

ORADataCollector.h

Creates and schedules a video beacon event

- (NSDictionary *)triggerEventForVideoBeacon:(ORAVideoMeta *)videoMeta eventMeta:(ORAEventMeta *)meta

Parameters

videoMeta

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

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

Return Value

A dictionary of the event that is created

Declared In

ORADataCollector.h

Creates and schedules a video completion event

- (NSDictionary *)triggerEventForVideoCompletion:(ORAVideoMeta *)videoMeta eventMeta:(ORAEventMeta *)meta

Parameters

videoMeta

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

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

Return Value

A dictionary of the event that is created

Declared In

ORADataCollector.h

Creates and schedules a video error event

- (NSDictionary *)triggerEventForVideoError:(ORAVideoMeta *)videoMeta eventMeta:(ORAEventMeta *)meta

Parameters

videoMeta

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

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

Return Value

A dictionary of the event that is created

Declared In

ORADataCollector.h

Read a watchkit sdk event in, and synchronously write it to the store

- (BOOL)saveWatchEvent:(NSDictionary *)dictionary

Parameters

dictionary

The dictionary potentially containing a watchkit event

Return Value

YES if the dictionary is a Event, NO if not

Declared In

ORADataCollector.h

General Methods

This method is used for maintaining a session within an embedded WebView. 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

ORADataCollector.h

This method is used for transferring URL with session parameters by manual calling when automatics is disabled.

- (void)transferSessionWithURL:(NSURL *)url

Parameters

url

The URL you wish to transfer

Declared In

ORADataCollector.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

ORADataCollector.h

Adds a single send operation onto the Data Collector's internal queue. Each send operation sends a batch of events to the collector's servers. Operations are executed in the order they are received.

- (void)scheduleSend

Declared In

ORADataCollector.h

Adds a send all operation onto the Data Collector's internal queue. This operation sends all events currently in the event store to the collector's servers. Operations are executed in the order they are received.

- (void)scheduleSendAll

Declared In

ORADataCollector.h

By default, the Data Collector will periodically send events to its data collection servers based on your configuration settings. This method temporarily disables that periodic sending. You can still manually send events using -scheduleSend and -scheduleSendAll while periodic sending is paused.

- (void)pauseEventTransmission

Declared In

ORADataCollector.h

By default, the Data Collector will periodically send events to its data collection servers based on your configuration settings. This method resumes that periodic sending, and also immediately schedules a send event.

- (void)resumeEventTransmission

Declared In

ORADataCollector.h

Returns the value for a given config key (or a user-defined key). See the Advanced Configuration Guide for a list of first party keys.

- (id)valueForConfigKey:(NSString *)key

Parameters

key

The key for the value you want returned

Return Value

The value, as an id. Depending on the key supplied, this may be a NSNumber, an NSString, or an NSURL*

Declared In

ORADataCollector.h

This method returns whether or not data collection is currently enabled. If disabled, no events will be logged, and no events currently in the event store will be sent to the data collector's servers.

- (BOOL)isEnabled

Return Value

Whether or not data collection is currently enabled.

Declared In

ORADataCollector.h

The count of events currently stored locally.

- (NSInteger)eventsCount

Return Value

The count of events currently stored locally.

Declared In

ORADataCollector.h

The video tracker object.

- (ORAVideoTracker *)videoTracker

Return Value

The video tracker

Declared In

ORADataCollector.h