Flurry Class Reference

Provides all available methods for defining and reporting Analytics from use of your app. More...

#import <Flurry.h>

Inherits NSObject.

Class Methods
(void)	+ startSession:
	Start a Flurry session for the project denoted by apiKey. More...
(void)	+ startSession:withOptions:
	Start a Flurry session for the project denoted by apiKey. More...
(BOOL)	+ activeSessionExists
	Returns true if a session currently exists and is active. More...
(NSString *)	+ getSessionID
	Returns the session ID of the current active session. More...
(void)	+ setDelegate:
	Set Flurry delegate for callback on session creation. More...
(void)	+ pauseBackgroundSession
	Pauses a Flurry session left running in background. More...
(void)	+ addSessionOrigin:withDeepLink:
	Adds an session origin and deep link attached to each session specified by sessionOriginName and deepLink. More...
(void)	+ addSessionOrigin:
	Adds an session origin attached to each session specified by sessionOriginName. More...
(void)	+ sessionProperties:
	Adds a custom parameterized session parameters parameters. More...
(void)	+ addOrigin:withVersion:
	Adds an SDK origin specified by originName and originVersion. More...
(void)	+ addOrigin:withVersion:withParameters:
	Adds a custom parameterized origin specified by originName with originVersion and parameters. More...
Pre-Session Calls
Optional sdk settings that should be called before start session.
(void)	+ setAppVersion:
	Explicitly specifies the App Version that Flurry will use to group Analytics data. More...
(NSString *)	+ getFlurryAgentVersion
	Retrieves the Flurry Agent Build Version. More...
(void)	+ setShowErrorInLogEnabled:
	Displays an exception in the debug log if thrown during a Session. More...
(void)	+ setDebugLogEnabled:
	Generates debug logs to console. More...
(void)	+ setLogLevel:
	Generates debug logs to console. More...
(void)	+ setSessionContinueSeconds:
	Set the timeout for expiring a Flurry session. More...
(void)	+ setCrashReportingEnabled:
	Enable automatic collection of crash reports. More...
Event and Error Logging
Methods for reporting custom events and errors during the session.
(FlurryEventRecordStatus)	+ logEvent:
	Records a custom event specified by eventName. More...
(FlurryEventRecordStatus)	+ logEvent:withParameters:
	Records a custom parameterized event specified by eventName with parameters. More...
(void)	+ logError:message:exception:
	Records an app exception. Commonly used to catch unhandled exceptions. More...
(void)	+ logError:message:error:
	Records an app error. More...
(FlurryEventRecordStatus)	+ logEvent:timed:
	Records a timed event specified by eventName. More...
(FlurryEventRecordStatus)	+ logEvent:withParameters:timed:
	Records a custom parameterized timed event specified by eventName with parameters. More...
(void)	+ endTimedEvent:withParameters:
	Ends a timed event specified by eventName and optionally updates parameters with parameters. More...
Page View Methods
Count page views.
(void)	+ logAllPageViews:
	see +(void)logAllPageViewsForTarget:target; for details More...
(void)	+ logAllPageViewsForTarget:
	Automatically track page views on a UINavigationController or UITabBarController. More...
(void)	+ stopLogPageViewsForTarget:
	Stops logging page views on previously observed with logAllPageViewsForTarget: UINavigationController or UITabBarController. More...
(void)	+ logPageView
	Explicitly track a page view during a session. More...
User Info
Methods to set user information.
(void)	+ setUserID:
	Assign a unique id for a user in your app. More...
(void)	+ setAge:
	Set your user's age in years. More...
(void)	+ setGender:
	Set your user's gender. More...
Location Reporting
Methods for setting location information.
(void)	+ setLatitude:longitude:horizontalAccuracy:verticalAccuracy:
	Set the location of the session. More...
Session Reporting Calls
Optional methods that can be called at any point to control session reporting.
(void)	+ setSessionReportsOnCloseEnabled:
	Set session to report when app closes. More...
(void)	+ setSessionReportsOnPauseEnabled:
	Set session to report when app is sent to the background. More...
(void)	+ setBackgroundSessionEnabled:
	Set session to support background execution. More...
(void)	+ setEventLoggingEnabled:
	Enable custom event logging. More...
(void)	+ setPulseEnabled:
	Enables Flurry Pulse. More...
(FlurryEventRecordStatus)	+ logEvent:syndicationID:parameters:
	Records a syndicated event specified by syndicationEvent. More...

Detailed Description

Provides all available methods for defining and reporting Analytics from use of your app.

Set of methods that allow developers to capture detailed, aggregate information regarding the use of their app by end users.

Note

This class provides methods necessary for correct function of Flurry.h. For information on how to use Flurry's Ads SDK to attract high-quality users and monetize your user base see <a href=https://developer.yahoo.com/flurry/docs/howtos">Support Center - Publishers.

Author

2009 - 2013 Flurry, Inc. All Rights Reserved.

Version

4.3.0

Definition at line 100 of file Flurry.h.

Method Documentation

+ (BOOL) activeSessionExists

Returns true if a session currently exists and is active.

Since

6.0.0

   - (BOOL) application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
// Optional Flurry startup methods
[Flurry activeSessionExists];
// ....
}

+ (void) addOrigin:		(NSString *)	originName
withVersion:		(NSString *)	originVersion

Adds an SDK origin specified by originName and originVersion.

Since

5.0.0

This method allows you to specify origin within your Flurry SDK wrapper. As a general rule you should capture all the origin info related to your wrapper for Flurry SDK after every session start.

See Also

+ addOrigin:withVersion:withParameters: for details on reporting origin info with parameters.

   - (void)interestingSDKWrapperLibraryfunction
{
    // ... after calling startSession
    [Flurry addOrigin:@"Interesting_Wrapper" withVersion:@"1.0.0"];
    // more code ...
}

Parameters

originName	Name of the origin.
originVersion	Version string of the origin wrapper

+ (void) addOrigin:		(NSString *)	originName
withVersion:		(NSString *)	originVersion
withParameters:		(NSDictionary *)	parameters

Adds a custom parameterized origin specified by originName with originVersion and parameters.

Since

5.0.0

This method overrides #addOrigin to allow you to associate parameters with an origin attribute. Parameters are valuable as they allow you to store characteristics of an origin.

Note

You should not pass private or confidential information about your origin info in a custom origin.
A maximum of 9 parameter names may be associated with any origin. Sending over 10 parameter names with a single origin will result in no parameters being logged for that origin.

   - (void)userPurchasedSomethingCool
{
NSDictionary *params =
   [NSDictionary dictionaryWithObjectsAndKeys:@"Origin Info Item", // Parameter Value
       @"Origin Info Item Key", // Parameter Name
       nil];
   // ... after calling startSession
   [Flurry addOrigin:@"Interesting_Wrapper" withVersion:@"1.0.0"];
   // more code ...
}

Parameters

originName	Name of the origin.
originVersion	Version string of the origin wrapper
parameters	An immutable copy of map containing Name-Value pairs of parameters.

+ (void) addSessionOrigin:

(NSString *)

sessionOriginName

Adds an session origin attached to each session specified by sessionOriginName.

Since

6.5.0

This method allows you to specify session origin for each session. This is different than addOrigin which is used for third party wrappers after every session start.

   - (void)interestingMethod
{
// ... after calling startSession
[Flurry addSessionOrigin:@"facebuk"];
// more code ...
}

Parameters

sessionOriginName

Name of the origin.

+ (void) addSessionOrigin:		(NSString *)	sessionOriginName
withDeepLink:		(NSString *)	deepLink

Adds an session origin and deep link attached to each session specified by sessionOriginName and deepLink.

Since

6.5.0

This method allows you to specify session origin and deep link for each session. This is different than addOrigin which is used for third party wrappers after every session start.

   - (void)interestingMethod
{
// ... after calling startSession
[Flurry addSessionOrigin:@"facebuk"];
// more code ...
}

Parameters

sessionOriginName	Name of the origin.
deepLink	Url of the deep Link.

+ (void) endTimedEvent:		(NSString *)	eventName
withParameters:		(NSDictionary *)	parameters

Ends a timed event specified by eventName and optionally updates parameters with parameters.

Since

2.8.4

This method ends an existing timed event. If parameters are provided, this will overwrite existing parameters with the same name or create new parameters if the name does not exist in the parameter map set by logEvent:withParameters:timed:.

Note

You should not pass private or confidential information about your users in a custom event.
If the app is backgrounded prior to ending a timed event, the Flurry SDK will automatically end the timer on the event.
endTimedEvent:withParameters: is ignored if called on a previously terminated event.

See Also

+ logEvent:withParameters:timed: for details on starting a timed event with parameters.

   - (void)startLevel 
{
NSDictionary *params =
[NSDictionary dictionaryWithObjectsAndKeys:@"100", // Parameter Value
@"Current Points", // Parameter Name
nil];

[Flurry logEvent:@"Level Played" withParameters:params timed:YES];
// Start user on level
}

- (void)endLevel 
{
// User gained additional 100 points in Level
NSDictionary *params =
[NSDictionary dictionaryWithObjectsAndKeys:@"200", // Parameter Value
@"Current Points", // Parameter Name
nil];
[Flurry endTimedEvent:@"Level Played" withParameters:params];
// User done with level
}

Parameters

eventName	Name of the event. For maximum effectiveness, we recommend using a naming scheme that can be easily understood by non-technical people in your business domain.
parameters	An immutable copy of map containing Name-Value pairs of parameters.

+ (NSString *) getFlurryAgentVersion

Retrieves the Flurry Agent Build Version.

Since

2.7

This is an optional method that retrieves the Flurry Agent Version the app is running under. It is most often used if reporting an unexpected behavior of the SDK to Flurry Support

Note

This method must be called prior to invoking startSession:.
FAQ for the iPhone SDK is located at Support Center - iPhone FAQ.

See Also

+ setLogLevel: for information on how to view debugging information on your console.

Returns

The agent version of the Flurry SDK.

+ (NSString*) getSessionID

Returns the session ID of the current active session.

Since

6.3.0

   - (BOOL) application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
// Optional Flurry startup methods
[Flurry getSessionID];
// ....
}

+ (void) logAllPageViews:

see +(void)logAllPageViewsForTarget:target; for details

Deprecated:

Since

2.7 This method does the same as +(void)logAllPageViewsForTarget:target method and is left for backward compatibility

+ (void) logAllPageViewsForTarget:

(id)

target

Automatically track page views on a UINavigationController or UITabBarController.

Since

4.3

This method increments the page view count for a session based on traversing a UINavigationController or UITabBarController. The page view count is only a counter for the number of transitions in your app. It does not associate a name with the page count. To associate a name with a count of occurences see logEvent:.

Note

If you need to release passed target, you should call counterpart method + (void)stopLogPageViewsForTarget:target before;

See Also

+ logPageView for details on explictly incrementing page view count.

  -(void) trackViewsFromTabBar:(UITabBarController*) tabBar 
{
[Flurry logAllPageViewsForTarget:tabBar];
}

Parameters

target

The navigation or tab bar controller.

+ (void) logError:		(NSString *)	errorID
message:		(NSString *)	message
error:		(NSError *)	error

Records an app error.

Since

2.7

This method captures an error for reporting to Flurry.

See Also

+ logError:message:exception: for details on capturing exceptions.

   - (void) webView:(UIWebView *)webView didFailLoadWithError:(NSError *)error 
{
[Flurry logError:@"WebView No Load" message:[error localizedDescription] error:error];
}

Parameters

errorID	Name of the error.
message	The message to associate with the error.
error	The error object to report.

+ (void) logError:		(NSString *)	errorID
message:		(NSString *)	message
exception:		(NSException *)	exception

Records an app exception. Commonly used to catch unhandled exceptions.

Since

2.7

This method captures an exception for reporting to Flurry. We recommend adding an uncaught exception listener to capture any exceptions that occur during usage that is not anticipated by your app.

See Also

+ logError:message:error: for details on capturing errors.

   - (void) uncaughtExceptionHandler(NSException *exception) 
{
[Flurry logError:@"Uncaught" message:@"Crash!" exception:exception];
}

- (void)applicationDidFinishLaunching:(UIApplication *)application 
{
NSSetUncaughtExceptionHandler(&uncaughtExceptionHandler);
[Flurry startSession:@"YOUR_API_KEY"];
// ....
}

Parameters

errorID	Name of the error.
message	The message to associate with the error.
exception	The exception object to report.

+ (FlurryEventRecordStatus) logEvent:

(NSString *)

eventName

Records a custom event specified by eventName.

Since

2.8.4

This method allows you to specify custom events within your app. As a general rule you should capture events related to user navigation within your app, any action around monetization, and other events as they are applicable to tracking progress towards your business goals.

Note

You should not pass private or confidential information about your users in a custom event.
Where applicable, you should make a concerted effort to use timed events with parameters (logEvent:withParameters:timed:) or events with parameters (logEvent:withParameters:). This provides valuable information around the time the user spends within an action (e.g. - time spent on a level or viewing a page) or characteristics of an action (e.g. - Buy Event that has a Parameter of Widget with Value Golden Sword).

See Also

+ logEvent:withParameters: for details on storing events with parameters.
+ logEvent:timed: for details on storing timed events.
+ logEvent:withParameters:timed: for details on storing timed events with parameters.
+ endTimedEvent:withParameters: for details on stopping a timed event and (optionally) updating parameters.

   - (void)interestingAppAction 
{
[Flurry logEvent:@"Interesting_Action"];
// Perform interesting action
}

Parameters

eventName

Name of the event. For maximum effectiveness, we recommend using a naming scheme that can be easily understood by non-technical people in your business domain.

Returns

enum FlurryEventRecordStatus for the recording status of the logged event.

+ (FlurryEventRecordStatus) logEvent:		(FlurrySyndicationEvent)	syndicationEvent
syndicationID:		(NSString *)	syndicationID
parameters:		(NSDictionary *)	parameters

Records a syndicated event specified by syndicationEvent.

Since

6.7.0

This method is excusively for use by the Tumblr App, calls from others app will be ignored.

- (void) reblogButtonHandler
{
[Flurry logEvent:Reblog syndicationID:@"123", parameters:nil];
// Perform
}

Parameters

syndicationEvent	syndication event.
syndicationID	syndication ID that is associated with the event
parameters	use this to pass in syndication parameters such as kSyndicationiOSDeepLink, kSyndicationAndroidDeepLink, kSyndicationWebLinkDeepLink

Returns

enum FlurryEventRecordStatus for the recording status of the logged event.

+ (FlurryEventRecordStatus) logEvent:		(NSString *)	eventName
timed:		(BOOL)	timed

Records a timed event specified by eventName.

Since

2.8.4

This method overrides #logEvent to allow you to capture the length of an event. This can be extremely valuable to understand the level of engagement with a particular action. For example, you can capture how long a user spends on a level or reading an article.

Note

You should not pass private or confidential information about your users in a custom event.
Where applicable, you should make a concerted effort to use parameters with your timed events (logEvent:withParameters:timed:). This provides valuable information around the characteristics of an action (e.g. - Buy Event that has a Parameter of Widget with Value Golden Sword).

See Also

+ logEvent:withParameters:timed: for details on storing timed events with parameters.
+ endTimedEvent:withParameters: for details on stopping a timed event and (optionally) updating parameters.

   - (void)startLevel 
{
[Flurry logEvent:@"Level Played" timed:YES];
// Start user on level
}

- (void)endLevel 
{
[Flurry endTimedEvent:@"Level Played" withParameters:nil];
// User done with level
}

Parameters

eventName	Name of the event. For maximum effectiveness, we recommend using a naming scheme that can be easily understood by non-technical people in your business domain.
timed	Specifies the event will be timed..

Returns

enum FlurryEventRecordStatus for the recording status of the logged event.

+ (FlurryEventRecordStatus) logEvent:		(NSString *)	eventName
withParameters:		(NSDictionary *)	parameters

Records a custom parameterized event specified by eventName with parameters.

Since

2.8.4

This method overrides #logEvent to allow you to associate parameters with an event. Parameters are extremely valuable as they allow you to store characteristics of an action. For example, if a user purchased an item it may be helpful to know what level that user was on. By setting this parameter you will be able to view a distribution of levels for the purcahsed event on the Flurrly Dev Portal.

Note

You should not pass private or confidential information about your users in a custom event.
A maximum of 10 parameter names may be associated with any event. Sending over 10 parameter names with a single event will result in no parameters being logged for that event. You may specify an infinite number of Parameter values. For example, a Search Box would have 1 parameter name (e.g. - Search Box) and many values, which would allow you to see what values users look for the most in your app.
Where applicable, you should make a concerted effort to use timed events with parameters (logEvent:withParameters:timed:). This provides valuable information around the time the user spends within an action (e.g. - time spent on a level or viewing a page).

See Also

+ logEvent:withParameters:timed: for details on storing timed events with parameters.
+ endTimedEvent:withParameters: for details on stopping a timed event and (optionally) updating parameters.

   - (void)userPurchasedSomethingCool 
{
NSDictionary *params =
[NSDictionary dictionaryWithObjectsAndKeys:@"Cool Item", // Parameter Value
@"Item Purchased", // Parameter Name
nil];
[Flurry logEvent:@"Something Cool Purchased" withParameters:params];
// Give user cool item
}

Parameters

eventName	Name of the event. For maximum effectiveness, we recommend using a naming scheme that can be easily understood by non-technical people in your business domain.
parameters	An immutable copy of map containing Name-Value pairs of parameters.

Returns

enum FlurryEventRecordStatus for the recording status of the logged event.

+ (FlurryEventRecordStatus) logEvent:		(NSString *)	eventName
withParameters:		(NSDictionary *)	parameters
timed:		(BOOL)	timed

Records a custom parameterized timed event specified by eventName with parameters.

Since

2.8.4

This method overrides #logEvent to allow you to capture the length of an event with parameters. This can be extremely valuable to understand the level of engagement with a particular action and the characteristics associated with that action. For example, you can capture how long a user spends on a level or reading an article. Parameters can be used to capture, for example, the author of an article or if something was purchased while on the level.

Note

You should not pass private or confidential information about your users in a custom event.

See Also

+ endTimedEvent:withParameters: for details on stopping a timed event and (optionally) updating parameters.

   - (void)startLevel 
{
NSDictionary *params =
[NSDictionary dictionaryWithObjectsAndKeys:@"100", // Parameter Value
@"Current Points", // Parameter Name
nil];

[Flurry logEvent:@"Level Played" withParameters:params timed:YES];
// Start user on level
}

- (void)endLevel 
{
// User gained additional 100 points in Level
NSDictionary *params =
[NSDictionary dictionaryWithObjectsAndKeys:@"200", // Parameter Value
@"Current Points", // Parameter Name
nil];
[Flurry endTimedEvent:@"Level Played" withParameters:params];
// User done with level
}

Parameters

eventName	Name of the event. For maximum effectiveness, we recommend using a naming scheme that can be easily understood by non-technical people in your business domain.
parameters	An immutable copy of map containing Name-Value pairs of parameters.
timed	Specifies the event will be timed..

Returns

enum FlurryEventRecordStatus for the recording status of the logged event.

+ (void) logPageView

Explicitly track a page view during a session.

Since

2.7

This method increments the page view count for a session when invoked. It does not associate a name with the page count. To associate a name with a count of occurences see logEvent:.

See Also

#logAllPageViews for details on automatically incrementing page view count based on user traversing navigation or tab bar controller.

   -(void) trackView 
{
[Flurry logPageView];
}

+ (void) pauseBackgroundSession

Pauses a Flurry session left running in background.

Since

4.2.2

This method should be used in case of setBackgroundSessionEnabled: set to YES. It can be called when application finished all background tasks (such as playing music) to pause session.

See Also

+ setBackgroundSessionEnabled: for details on setting a custom behaviour on resigning activity.

   - (void)allBackgroundTasksFinished
{
// ....
[Flurry pauseBackgroundSession];
// ....
}

+ (void) sessionProperties:

(NSDictionary *)

parameters

Adds a custom parameterized session parameters parameters.

Since

6.5.0

This method allows you to associate parameters with an session. Parameters are valuable as they allow you to store characteristics of an session.

Note

You should not pass private or confidential information about your origin info in a custom origin.
A maximum of 20 parameter names may be associated with any origin. Sending over 20 parameter names with a single origin will result in no parameters being logged for that origin.

Parameters

parameters

An immutable copy of map containing Name-Value pairs of parameters.

+ (void) setAge:

(int)

age

Set your user's age in years.

Since

2.7

Use this method to capture the age of your user. Only use this method if you collect this information explictly from your user (i.e. - there is no need to set a default value).

Note

The age is aggregated across all users of your app and not available on a per user basis.

Parameters

age	Reported age of user.

+ (void) setAppVersion:

(NSString *)

version

Explicitly specifies the App Version that Flurry will use to group Analytics data.

Since

2.7

This is an optional method that overrides the App Version Flurry uses for reporting. Flurry will use the CFBundleVersion in your info.plist file when this method is not invoked.

Note

There is a maximum of 605 versions allowed for a single app.
This method must be called prior to invoking startSession:.

Parameters

version

The custom version name.

+ (void) setBackgroundSessionEnabled:

(BOOL)

setBackgroundSessionEnabled

Set session to support background execution.

Since

4.2.2

Use this method to enable reporting of errors and events when application is running in backgorund (such applications have UIBackgroundModes in Info.plist). You should call pauseBackgroundSession when appropriate in background mode to pause the session (for example when played song completed in background)

Default value is NO

See Also

+ pauseBackgroundSession for details

Parameters

setBackgroundSessionEnabled

YES to enbale background support and continue log events and errors for running session.

+ (void) setCrashReportingEnabled:

(BOOL)

value

Enable automatic collection of crash reports.

Since

4.1

This is an optional method that collects crash reports when enabled. The default value is NO.

Note

This method must be called prior to invoking startSession:.

Parameters

value

YES to enable collection of crash reports.

+ (void) setDebugLogEnabled:

(BOOL)

value

Generates debug logs to console.

Since

2.7

This is an optional method that displays debug information related to the Flurry SDK. display information to the console. The default setting for this method is NO which sets the log level to FlurryLogLevelCriticalOnly. When set to YES the debug log level is set to FlurryLogLevelDebug

Note

This method must be called prior to invoking startSession:. If the method, setLogLevel is called later in the code, debug logging will be automatically enabled.

Parameters

value

YES to show debug logs, NO to omit debug logs.

+ (void) setDelegate:

(id< FlurryDelegate >)

delegate

Set Flurry delegate for callback on session creation.

Since

6.3.0

   - (BOOL) application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
// Optional Flurry startup methods
// If self implements protocol, FlurryDelegate
[Flurry setDelegate:self];
// ....
}

+ (void) setEventLoggingEnabled:

(BOOL)

value

Enable custom event logging.

Since

2.7

Use this method to allow the capture of custom events. The default value is YES.

Parameters

value

YES to enable event logging, NO to stop custom logging.

+ (void) setGender:

(NSString *)

gender

Set your user's gender.

Since

2.7

Use this method to capture the gender of your user. Only use this method if you collect this information explictly from your user (i.e. - there is no need to set a default value). Allowable values are "m" or @c @"f"

Note

The gender is aggregated across all users of your app and not available on a per user basis.

Parameters

gender

Reported gender of user.

+ (void) setLatitude:		(double)	latitude
longitude:		(double)	longitude
horizontalAccuracy:		(float)	horizontalAccuracy
verticalAccuracy:		(float)	verticalAccuracy

Set the location of the session.

Since

2.7

Use information from the CLLocationManager to specify the location of the session. Flurry does not automatically track this information or include the CLLocation framework.

Note

Only the last location entered is captured per session.
Regardless of accuracy specified, the Flurry SDK will only report location at city level or higher.
Location is aggregated across all users of your app and not available on a per user basis.
This information should only be captured if it is germaine to the use of your app.

CLLocationManager *locationManager = [[CLLocationManager alloc] init];
[locationManager startUpdatingLocation];

After starting the location manager, you can set the location with Flurry. You can implement CLLocationManagerDelegate to be aware of when the location is updated. Below is an example of how to use this method, after you have recieved a location update from the locationManager.

CLLocation *location = locationManager.location;
[Flurry  setLatitude:location.coordinate.latitude
           longitude:location.coordinate.longitude
  horizontalAccuracy:location.horizontalAccuracy
    verticalAccuracy:location.verticalAccuracy];

Parameters

latitude	The latitude.
longitude	The longitude.
horizontalAccuracy	The radius of uncertainty for the location in meters.
verticalAccuracy	The accuracy of the altitude value in meters.

+ (void) setLogLevel:

(FlurryLogLevel)

value

Generates debug logs to console.

Since

4.2.2

This is an optional method that displays debug information related to the Flurry SDK. display information to the console. The default setting for this method is FlurryLogLevelCritycalOnly.

Note

Its good practice to call this method prior to invoking startSession:. If debug logging is disabled earlier, this method will enable it.

Parameters

value

Log level

+ (void) setPulseEnabled:

(BOOL)

value

Enables Flurry Pulse.

Since

6.3.0

Note

: Please see https://developer.yahoo.com/flurry-pulse/ for more details

Parameters

value

YES to enable event logging, NO to stop custom logging.

+ (void) setSessionContinueSeconds:

(int)

seconds

Set the timeout for expiring a Flurry session.

Since

2.7

This is an optional method that sets the time the app may be in the background before starting a new session upon resume. The default value for the session timeout is 10 seconds in the background.

Note

This method must be called prior to invoking startSession:.

Parameters

seconds

The time in seconds to set the session timeout to.

+ (void) setSessionReportsOnCloseEnabled:

(BOOL)

sendSessionReportsOnClose

Set session to report when app closes.

Since

2.7

Use this method report session data when the app is closed. The default value is YES.

Note

This method is rarely invoked in iOS >= 3.2 due to the updated iOS lifecycle.

See Also

+ setSessionReportsOnPauseEnabled:

Parameters

sendSessionReportsOnClose

YES to send on close, NO to omit reporting on close.

+ (void) setSessionReportsOnPauseEnabled:

(BOOL)

setSessionReportsOnPauseEnabled

Set session to report when app is sent to the background.

Since

2.7

Use this method report session data when the app is paused. The default value is YES.

Parameters

setSessionReportsOnPauseEnabled

YES to send on pause, NO to omit reporting on pause.

+ (void) setShowErrorInLogEnabled:

(BOOL)

value

Displays an exception in the debug log if thrown during a Session.

Since

2.7

This is an optional method that augments the debug logs with exceptions that occur during the session. You must both capture exceptions to Flurry and set debug logging to enabled for this method to display information to the console. The default setting for this method is NO.

Note

This method must be called prior to invoking startSession:.

See Also

+ setLogLevel: for information on how to view debugging information on your console.
+ logError:message:exception: for details on logging exceptions.
+ logError:message:error: for details on logging errors.

Parameters

value

YES to show errors in debug logs, NO to omit errors in debug logs.

+ (void) setUserID:

(NSString *)

userID

Assign a unique id for a user in your app.

Since

2.7

Note

Please be sure not to use this method to pass any private or confidential information about the user.

Parameters

userID

The app id for a user.

+ (void) startSession:

(NSString *)

apiKey

Start a Flurry session for the project denoted by apiKey.

Since

2.6

This method serves as the entry point to Flurry Analytics collection. It must be called in the scope of applicationDidFinishLaunching. The session will continue for the period the app is in the foreground until your app is backgrounded for the time specified in setSessionContinueSeconds:. If the app is resumed in that period the session will continue, otherwise a new session will begin.

Crash reporting will not be enabled. See setCrashReportingEnabled: for more information.

Note

If testing on a simulator, please be sure to send App to background via home button. Flurry depends on the iOS lifecycle to be complete for full reporting.

See Also

+ setSessionContinueSeconds: for details on setting a custom session timeout.

   - (void)applicationDidFinishLaunching:(UIApplication *)application 
{
// Optional Flurry startup methods
[Flurry startSession:@"YOUR_API_KEY"];
// ....
}

Parameters

apiKey

The API key for this project.

+ (void) startSession:		(NSString *)	apiKey
withOptions:		(id)	options

Start a Flurry session for the project denoted by apiKey.

Since

4.0.8

This method serves as the entry point to Flurry Analytics collection. It must be called in the scope of applicationDidFinishLaunching passing in the launchOptions param. The session will continue for the period the app is in the foreground until your app is backgrounded for the time specified in setSessionContinueSeconds:. If the app is resumed in that period the session will continue, otherwise a new session will begin.

Note

If testing on a simulator, please be sure to send App to background via home button. Flurry depends on the iOS lifecycle to be complete for full reporting.

See Also

+ setSessionContinueSeconds: for details on setting a custom session timeout.

   - (BOOL) application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
// Optional Flurry startup methods
[Flurry startSession:@"YOUR_API_KEY" withOptions:launchOptions];
// ....
}

Parameters

apiKey	The API key for this project.
options	passed launchOptions from the applicatin's didFinishLaunchingWithOptions:(NSDictionary *)launchOptions

+ (void) stopLogPageViewsForTarget:

(id)

target

Stops logging page views on previously observed with logAllPageViewsForTarget: UINavigationController or UITabBarController.

Since

4.3

Call this method before instance of UINavigationController or UITabBarController observed with logAllPageViewsForTarget: is released.

  -(void) dealloc
{
[Flurry stopLogPageViewsForTarget:_tabBarController];
[_tabBarController release];
[super dealloc];
}

Parameters

target

The navigation or tab bar controller.

---

The documentation for this class was generated from the following file:

• /Users/vamsiprakhya/github/IOSSDK/AdUnityAgent/FlurrySDK/PublicAPIs/FlurryAPI/Flurry.h