iOS SDK  12.0.0
 All Classes Functions Enumerations Enumerator Groups Pages
Instance Methods | Class Methods | List of all members
FlurryParamBuilder Class Reference

FlurryParamBuilder is the interface to use to assemble your parameters for standard event. More...

#import <Flurry+Event.h>

Inherits NSObject.

Instance Methods

(nonnull NSDictionary
< NSString *, NSString * > *) 		- parameters
 Get the parameters map object for logging the standard events. More...
 
(nonnull FlurryParamBuilder *) - setString:forKey:
 set a string value for a user defined key More...
 
(nonnull FlurryParamBuilder *) - setString:forParam:
 set a string value for a flurry param key More...
 
(nonnull FlurryParamBuilder *) - setInteger:forKey:
 set an int value for a used defined key More...
 
(nonnull FlurryParamBuilder *) - setInteger:forParam:
 set an int value for a flurry param key More...
 
(nonnull FlurryParamBuilder *) - setLong:forKey:
 set a long value for a user defined key More...
 
(nonnull FlurryParamBuilder *) - setLong:forParam:
 set a long value for a flurry param key More...
 
(nonnull FlurryParamBuilder *) - setBoolean:forKey:
 set a boolean value for a user defined key More...
 
(nonnull FlurryParamBuilder *) - setBoolean:forParam:
 set a boolean value for a flurry param key More...
 
(nonnull FlurryParamBuilder *) - setDouble:forKey:
 set a double value for a user defined key More...
 
(nonnull FlurryParamBuilder *) - setDouble:forParam:
 set a double value for a flurry param key More...
 
(nonnull FlurryParamBuilder *) - removeObjectForKey:
 remove the value for a specified key (user-defined key or flurry param key) More...
 
(nonnull FlurryParamBuilder *) - setAll:
 set a standard event parameter by parsing a FlurryParamBuilder object More...
 

Class Methods

(FlurryStringParam *_Nonnull) + adType
 return the flurry-defined key for param - adType More...
 
(FlurryStringParam *_Nonnull) + levelName
 return the flurry-defined key for param - levelName More...
 
(FlurryIntegerParam *_Nonnull) + levelNumber
 return the flurry-defined key for param - levelNumber More...
 
(FlurryStringParam *_Nonnull) + contentName
 return the flurry-defined key for param - contentName More...
 
(FlurryStringParam *_Nonnull) + contentType
 return the flurry-defined key for param - contentType More...
 
(FlurryStringParam *_Nonnull) + contentId
 return the flurry-defined key for param - contentId More...
 
(FlurryStringParam *_Nonnull) + creditName
 return the flurry-defined key for param - creditName More...
 
(FlurryStringParam *_Nonnull) + creditType
 return the flurry-defined key for param - creditType More...
 
(FlurryStringParam *_Nonnull) + creditId
 return the flurry-defined key for param - creditId More...
 
(FlurryStringParam *_Nonnull) + currencyType
 return the flurry-defined key for param - currencyType (ISO code) More...
 
(FlurryBooleanParam *_Nonnull) + isCurrencySoft
 return the flurry-defined key for param - isCurrencySoft More...
 
(FlurryStringParam *_Nonnull) + itemName
 return the flurry-defined key for param - itemName More...
 
(FlurryStringParam *_Nonnull) + itemType
 return the flurry-defined key for param - itemType More...
 
(FlurryStringParam *_Nonnull) + itemId
 return the flurry-defined key for param - itemId More...
 
(FlurryIntegerParam *_Nonnull) + itemCount
 return the flurry-defined key for param - itemCount More...
 
(FlurryStringParam *_Nonnull) + itemCategory
 return the flurry-defined key for param - itemCategory More...
 
(FlurryStringParam *_Nonnull) + itemListType
 return the flurry-defined key for param - itemListType More...
 
(FlurryDoubleParam *_Nonnull) + price
 return the flurry-defined key for param - price More...
 
(FlurryDoubleParam *_Nonnull) + totalAmount
 return the flurry-defined key for param - totalAmount More...
 
(FlurryStringParam *_Nonnull) + achievementId
 return the flurry-defined key for param - achievementId More...
 
(FlurryIntegerParam *_Nonnull) + score
 return the flurry-defined key for param - score More...
 
(FlurryStringParam *_Nonnull) + rating
 return the flurry-defined key for param - rating More...
 
(FlurryStringParam *_Nonnull) + transactionId
 return the flurry-defined key for param - transactionId More...
 
(FlurryBooleanParam *_Nonnull) + success
 return the flurry-defined key for param - success More...
 
(FlurryStringParam *_Nonnull) + paymentType
 return the flurry-defined key for param - paymentType More...
 
(FlurryBooleanParam *_Nonnull) + isAnnualSubscription
 return the flurry-defined key for param - isAnnualSubscription More...
 
(FlurryStringParam *_Nonnull) + subscriptionCountry
 return the flurry-defined key for param - subscriptionCountry More...
 
(FlurryIntegerParam *_Nonnull) + trialDays
 return the flurry-defined key for param - trialDays More...
 
(FlurryStringParam *_Nonnull) + predictedLTV
 return the flurry-defined key for param - predictedLTV More...
 
(FlurryStringParam *_Nonnull) + groupName
 return the flurry-defined key for param - groupName More...
 
(FlurryIntegerParam *_Nonnull) + stepNumber
 return the flurry-defined key for param - stepNumber More...
 
(FlurryStringParam *_Nonnull) + tutorialName
 return the flurry-defined key for param - tutorialName More...
 
(FlurryStringParam *_Nonnull) + userId
 return the flurry-defined key for param - userId More...
 
(FlurryStringParam *_Nonnull) + method
 return the flurry-defined key for param - method More...
 
(FlurryStringParam *_Nonnull) + query
 return the flurry-defined key for param - query More...
 
(FlurryStringParam *_Nonnull) + searchType
 return the flurry-defined key for param - searchType More...
 
(FlurryStringParam *_Nonnull) + socialContentName
 return the flurry-defined key for param - socialContentName More...
 
(FlurryStringParam *_Nonnull) + socialContentId
 return the flurry-defined key for param - socialContentId More...
 
(FlurryStringParam *_Nonnull) + likeType
 return the flurry-defined key for param - likeType More...
 
(FlurryStringParam *_Nonnull) + mediaName
 return the flurry-defined key for param - mediaName More...
 
(FlurryStringParam *_Nonnull) + mediaType
 return the flurry-defined key for param - mediaType More...
 
(FlurryStringParam *_Nonnull) + mediaId
 return the flurry-defined key for param - mediaId More...
 
(FlurryIntegerParam *_Nonnull) + duration
 return the flurry-defined key for param - duration More...
 

Detailed Description

FlurryParamBuilder is the interface to use to assemble your parameters for standard event.

Since
11.3.0

In order for Flurry to log a standard event, you might want to put the standardized parameters as well as your own defined parameters together. There will be recommended standardized parameter keys and mandatory standardized parameter keys defined for each standard event name. For instance, to log FLURRY_EVENT_PURCHASED event, SDK suggests to include itemCount, totalAmount, itemId, success, itemName, itemType, currencyType and transactionId parameters, in which totalAmount is also a mandatory parameter that is indicated by the SDK. Since each type of standardized param key can only be mapped to its corresponding data value - string, integer, double, boolean, long, when you assemble your FlurryParamBuilder object with the standardized parameters, you will need to use the public APIs specified in FlurryParamBuilder interface to map them correctly.

Definition at line 445 of file Flurry+Event.h.

Method Documentation

+ (FlurryStringParam * _Nonnull) achievementId

return the flurry-defined key for param - achievementId

Since
11.3.0
+ (FlurryStringParam * _Nonnull) adType

return the flurry-defined key for param - adType

Since
11.3.0
+ (FlurryStringParam * _Nonnull) contentId

return the flurry-defined key for param - contentId

Since
11.3.0
+ (FlurryStringParam * _Nonnull) contentName

return the flurry-defined key for param - contentName

Since
11.3.0
+ (FlurryStringParam * _Nonnull) contentType

return the flurry-defined key for param - contentType

Since
11.3.0
+ (FlurryStringParam * _Nonnull) creditId

return the flurry-defined key for param - creditId

Since
11.3.0
+ (FlurryStringParam * _Nonnull) creditName

return the flurry-defined key for param - creditName

Since
11.3.0
+ (FlurryStringParam * _Nonnull) creditType

return the flurry-defined key for param - creditType

Since
11.3.0
+ (FlurryStringParam * _Nonnull) currencyType

return the flurry-defined key for param - currencyType (ISO code)

Since
11.3.0
+ (FlurryIntegerParam * _Nonnull) duration

return the flurry-defined key for param - duration

Since
11.3.0
+ (FlurryStringParam * _Nonnull) groupName

return the flurry-defined key for param - groupName

Since
11.3.0
+ (FlurryBooleanParam * _Nonnull) isAnnualSubscription

return the flurry-defined key for param - isAnnualSubscription

Since
11.3.0
+ (FlurryBooleanParam * _Nonnull) isCurrencySoft

return the flurry-defined key for param - isCurrencySoft

Since
11.3.0
+ (FlurryStringParam * _Nonnull) itemCategory

return the flurry-defined key for param - itemCategory

Since
11.3.0
+ (FlurryIntegerParam * _Nonnull) itemCount

return the flurry-defined key for param - itemCount

Since
11.3.0
+ (FlurryStringParam * _Nonnull) itemId

return the flurry-defined key for param - itemId

Since
11.3.0
+ (FlurryStringParam * _Nonnull) itemListType

return the flurry-defined key for param - itemListType

Since
11.3.0
+ (FlurryStringParam * _Nonnull) itemName

return the flurry-defined key for param - itemName

Since
11.3.0
+ (FlurryStringParam * _Nonnull) itemType

return the flurry-defined key for param - itemType

Since
11.3.0
+ (FlurryStringParam * _Nonnull) levelName

return the flurry-defined key for param - levelName

Since
11.3.0
+ (FlurryIntegerParam * _Nonnull) levelNumber

return the flurry-defined key for param - levelNumber

Since
11.3.0
+ (FlurryStringParam * _Nonnull) likeType

return the flurry-defined key for param - likeType

Since
11.3.0
+ (FlurryStringParam * _Nonnull) mediaId

return the flurry-defined key for param - mediaId

Since
11.3.0
+ (FlurryStringParam * _Nonnull) mediaName

return the flurry-defined key for param - mediaName

Since
11.3.0
+ (FlurryStringParam * _Nonnull) mediaType

return the flurry-defined key for param - mediaType

Since
11.3.0
+ (FlurryStringParam * _Nonnull) method

return the flurry-defined key for param - method

Since
11.3.0
- (nonnull NSDictionary<NSString *, NSString *> *) parameters

Get the parameters map object for logging the standard events.

Since
11.3.0
Returns
an NSDictionary object contains all set key-value pairs
+ (FlurryStringParam * _Nonnull) paymentType

return the flurry-defined key for param - paymentType

Since
11.3.0
+ (FlurryStringParam * _Nonnull) predictedLTV

return the flurry-defined key for param - predictedLTV

Since
11.3.0
+ (FlurryDoubleParam * _Nonnull) price

return the flurry-defined key for param - price

Since
11.3.0
+ (FlurryStringParam * _Nonnull) query

return the flurry-defined key for param - query

Since
11.3.0
+ (FlurryStringParam * _Nonnull) rating

return the flurry-defined key for param - rating

Since
11.3.0
- (nonnull FlurryParamBuilder *) removeObjectForKey:

remove the value for a specified key (user-defined key or flurry param key)

Since
11.3.0
- (void)someEvent{
FlurryParamBuilder *param = [[[[[[FlurryParamBuilder alloc] init]
setString:@"Game pro"
forParam:[FlurryParamBuilder levelName]]
setInteger:2 forKey:@"level"]
removeObjectForKey:[FlurryParamBuilder levelName]]
removeObjectForKey:@"level"];
}
Returns
FlurryParamBuilder object after removing the value
+ (FlurryIntegerParam * _Nonnull) score

return the flurry-defined key for param - score

Since
11.3.0
+ (FlurryStringParam * _Nonnull) searchType

return the flurry-defined key for param - searchType

Since
11.3.0
- (nonnull FlurryParamBuilder *) setAll:

set a standard event parameter by parsing a FlurryParamBuilder object

Since
11.3.0
Returns
FlurryParamBuilder object after setting all key-value pairs
- (nonnull FlurryParamBuilder *) setBoolean: (BOOL)  val

set a boolean value for a user defined key

Since
11.3.0
Returns
FlurryParamBuilder object after setting the boolean value
- (nonnull FlurryParamBuilder *) setBoolean: (BOOL)  val

set a boolean value for a flurry param key

Since
11.3.0
Returns
FlurryParamBuilder object after setting the boolean value
- (nonnull FlurryParamBuilder *) setDouble: (double)  val

set a double value for a user defined key

Since
11.3.0
Returns
FlurryParamBuilder object after setting the double value
- (nonnull FlurryParamBuilder *) setDouble: (double)  val

set a double value for a flurry param key

Since
11.3.0
Returns
FlurryParamBuilder object after setting the double value
- (nonnull FlurryParamBuilder *) setInteger: (int)  val

set an int value for a used defined key

Since
11.3.0
Returns
FlurryParamBuilder object after setting the int value
- (nonnull FlurryParamBuilder *) setInteger: (int)  val

set an int value for a flurry param key

Since
11.3.0
Returns
FlurryParamBuilder object after setting the int value
- (nonnull FlurryParamBuilder *) setLong: (long)  val

set a long value for a user defined key

Since
11.3.0
Returns
FlurryParamBuilder object after setting the long value
- (nonnull FlurryParamBuilder *) setLong: (long)  val

set a long value for a flurry param key

Since
11.3.0
Returns
FlurryParamBuilder object after setting the long value
- (nonnull FlurryParamBuilder *) setString: (nonnull NSString *)  val

set a string value for a user defined key

Since
11.3.0
Returns
FlurryParamBuilder object after setting the string value
- (nonnull FlurryParamBuilder *) setString: (nonnull NSString *)  val

set a string value for a flurry param key

Since
11.3.0
Returns
FlurryParamBuilder object after setting the string value
+ (FlurryStringParam * _Nonnull) socialContentId

return the flurry-defined key for param - socialContentId

Since
11.3.0
+ (FlurryStringParam * _Nonnull) socialContentName

return the flurry-defined key for param - socialContentName

Since
11.3.0
+ (FlurryIntegerParam * _Nonnull) stepNumber

return the flurry-defined key for param - stepNumber

Since
11.3.0
+ (FlurryStringParam * _Nonnull) subscriptionCountry

return the flurry-defined key for param - subscriptionCountry

Since
11.3.0
+ (FlurryBooleanParam * _Nonnull) success

return the flurry-defined key for param - success

Since
11.3.0
+ (FlurryDoubleParam * _Nonnull) totalAmount

return the flurry-defined key for param - totalAmount

Since
11.3.0
+ (FlurryStringParam * _Nonnull) transactionId

return the flurry-defined key for param - transactionId

Since
11.3.0
+ (FlurryIntegerParam * _Nonnull) trialDays

return the flurry-defined key for param - trialDays

Since
11.3.0
+ (FlurryStringParam * _Nonnull) tutorialName

return the flurry-defined key for param - tutorialName

Since
11.3.0
+ (FlurryStringParam * _Nonnull) userId

return the flurry-defined key for param - userId

Since
11.3.0
The documentation for this class was generated from the following file:
Copyright (c) 2013 Flurry Inc. All rights reserved.