iOS SDK  12.0.0
 All Classes Functions Enumerations Enumerator Groups Pages
FlurrySessionBuilder Class Reference

Inherits NSObject.

Instance Methods

(FlurrySessionBuilder *) - withDataSaleOptOut:
 An api to send ccpa compliance data to Flurry on the user's choice to opt out or opt in to data sale to third parties. More...
 
(FlurrySessionBuilder *) - withAppVersion:
 Explicitly specifies the App Version that Flurry will use to group Analytics data. More...
 
(FlurrySessionBuilder *) - withSessionContinueSeconds:
 Set the timeout for expiring a Flurry session. More...
 
(FlurrySessionBuilder *) - withCrashReporting:
 Enable automatic collection of crash reports. More...
 
(FlurrySessionBuilder *) - withLogLevel:
 Generates debug logs to console. More...
 
(FlurrySessionBuilder *) - withShowErrorInLog:
 Displays an exception in the debug log if thrown during a Session. More...
 
(FlurrySessionBuilder *) - withConsent:
 Registers the consent information with the SDK. Consent information is used to determine if the gdpr laws are applicable. More...
 
(FlurrySessionBuilder *) - withIAPReportingEnabled:
 Enables implicit recording of Apple Store transactions. More...
 
(FlurrySessionBuilder *) - withIncludeBackgroundSessionsInMetrics:
 Enables opting out of background sessions being counted towards total sessions. More...
 
(FlurrySessionBuilder *) - withSessionOrigin:
 Set the Session Origin for the Flurry session. More...
 
(FlurrySessionBuilder *) - withSessionOriginVerion:
 Set the Session Origin Version for the Flurry session. More...
 
(FlurrySessionBuilder *) - withSessionOriginParameters:
 Set the Session OriginSets Paramters for the Flurry session. More...
 
(FlurrySessionBuilder *) - withSessionDeeplink:
 Set the Deeplink for the Flurry session. More...
 
(FlurrySessionBuilder *) - withSessionProperties:
 Set the Session properties for the Flurry session. More...
 

Detailed Description

Definition at line 30 of file FlurrySessionBuilder.h.

Method Documentation

- (FlurrySessionBuilder*) withAppVersion:

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

Since
7.7.0

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.
Parameters
valueThe custom version name.
- (FlurrySessionBuilder*) withConsent:

Registers the consent information with the SDK. Consent information is used to determine if the gdpr laws are applicable.

Since
8.5.0

Use this method to pass the consent information to the SDK

Note
This method must be called prior to invoking #startSession:
Parameters
consentThe consent information.
See Also
(- initWithGDPRScope:andConsentStrings: (FlurryConsent))
- (FlurrySessionBuilder*) withCrashReporting:

Enable automatic collection of crash reports.

Since
7.7.0

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

Parameters
valueYES to enable collection of crash reports.
- (FlurrySessionBuilder*) withDataSaleOptOut:

An api to send ccpa compliance data to Flurry on the user's choice to opt out or opt in to data sale to third parties.

Since
10.1.0
Parameters
valueboolean true if the user wants to opt out of data sale, the default value is false
- (FlurrySessionBuilder*) withIAPReportingEnabled:

Enables implicit recording of Apple Store transactions.

Since
7.9.0
Note
This method needs to be called before any transaction is finialized.
Parameters
valueYES to enable transaction logging with the default being NO.
- (FlurrySessionBuilder*) withIncludeBackgroundSessionsInMetrics:

Enables opting out of background sessions being counted towards total sessions.

Since
8.1.0-rc.1
Note
This method must be called prior to invoking #startSession:.
Parameters
valueNO to opt out of counting background sessions towards total sessions. The default value for the session is YES
- (FlurrySessionBuilder*) withLogLevel:

Generates debug logs to console.

Since
7.7.0

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

Note
The log level can be changed at any point in the execution of your application using the setLogLevel API defined in Flurry.h, see #setLogLevel for more info.
Parameters
valueLog level
- (FlurrySessionBuilder*) withSessionContinueSeconds:

Set the timeout for expiring a Flurry session.

Since
7.7.0

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.

Parameters
valueThe time in seconds to set the session timeout to.
- (FlurrySessionBuilder*) withSessionDeeplink:

Set the Deeplink for the Flurry session.

Since
10.0.0

This is an optional method that sets the deeplink which started the app and Flurry Session

Parameters
deeplinkThe session deeplink value.
- (FlurrySessionBuilder*) withSessionOrigin:

Set the Session Origin for the Flurry session.

Since
10.0.0

This is an optional method that sets the session origin

Parameters
originThe session origin value.
- (FlurrySessionBuilder*) withSessionOriginParameters:

Set the Session OriginSets Paramters for the Flurry session.

Since
10.0.0

This is an optional method that sets the session origin parameters for origin sets (max key value pairs = 10)

Parameters
parametersThe session origin parameters.
- (FlurrySessionBuilder*) withSessionOriginVerion:

Set the Session Origin Version for the Flurry session.

Since
10.0.0

This is an optional method that sets the session origin version

Parameters
versionThe session origin version value.
- (FlurrySessionBuilder*) withSessionProperties:

Set the Session properties for the Flurry session.

Since
10.0.0

This is an optional method that sets the session properties

Parameters
propertiesThe session paramaters.
- (FlurrySessionBuilder*) withShowErrorInLog:

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

Since
7.7.0

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 the log level to Debug or All for this method to display information to the console. The default setting for this method is NO.

Note
This method can be called at any point in the execution of your application and the setting will take effect for SDK activity after this call.
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
valueYES to show errors in debug logs, NO to omit errors in debug logs.

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