iOS SDK  12.0.0
 All Classes Functions Enumerations Enumerator Groups Pages
Flurry+Event.h
1 //
2 // Flurry+Event.h
3 // Flurry
4 //
5 // Copyright (c) 2021 Yahoo. All rights reserved.
6 //
7 // Methods in this header file are for use with Flurry Analytics
8 
9 #import <Foundation/Foundation.h>
10 #import "Flurry.h"
11 
12 typedef NS_ENUM (NSUInteger, FlurryStandardEventNameType) {
13  FlurryStringParamType = 0,
14  FlurryIntegerParamType,
15  FlurryDoubleParamType,
16  FlurryBooleanParamType,
17  FlurryLongParamType
18 };
19 
20 typedef NS_ENUM (NSUInteger, FlurryEvent) {
26  FLURRY_EVENT_AD_CLICK NS_SWIFT_NAME(adClick) = 0,
32  FLURRY_EVENT_AD_IMPRESSION NS_SWIFT_NAME(adImpression),
38  FLURRY_EVENT_AD_REWARDED NS_SWIFT_NAME(adRewarded),
44  FLURRY_EVENT_AD_SKIPPED NS_SWIFT_NAME(adSkipped),
50  FLURRY_EVENT_CREDITS_SPENT NS_SWIFT_NAME(creditsSpent),
56  FLURRY_EVENT_CREDITS_PURCHASED NS_SWIFT_NAME(creditsPurchased),
62  FLURRY_EVENT_CREDITS_EARNED NS_SWIFT_NAME(creditsEarned),
68  FLURRY_EVENT_ACHIEVEMENT_UNLOCKED NS_SWIFT_NAME(achievementUnlocked),
74  FLURRY_EVENT_LEVEL_COMPLETED NS_SWIFT_NAME(levelCompleted),
80  FLURRY_EVENT_LEVEL_FAILED NS_SWIFT_NAME(levelFailed),
86  FLURRY_EVENT_LEVEL_UP NS_SWIFT_NAME(levelUp),
92  FLURRY_EVENT_LEVEL_STARTED NS_SWIFT_NAME(levelStarted),
98  FLURRY_EVENT_LEVEL_SKIP NS_SWIFT_NAME(levelSkip),
104  FLURRY_EVENT_SCORE_POSTED NS_SWIFT_NAME(scorePosted),
110  FLURRY_EVENT_CONTENT_RATED NS_SWIFT_NAME(contentRated),
116  FLURRY_EVENT_CONTENT_VIEWED NS_SWIFT_NAME(contentViewed),
122  FLURRY_EVENT_CONTENT_SAVED NS_SWIFT_NAME(contentSaved),
128  FLURRY_EVENT_PRODUCT_CUSTOMIZED NS_SWIFT_NAME(productCustomized),
134  FLURRY_EVENT_APP_ACTIVATED NS_SWIFT_NAME(appActivated),
140  FLURRY_EVENT_APPLICATION_SUBMITTED NS_SWIFT_NAME(applicationSubmitted),
146  FLURRY_EVENT_ADD_ITEM_TO_CART NS_SWIFT_NAME(addItemToCart),
152  FLURRY_EVENT_ADD_ITEM_TO_WISH_LIST NS_SWIFT_NAME(addItemToWishList),
158  FLURRY_EVENT_COMPLETED_CHECKOUT NS_SWIFT_NAME(completedCheckout),
164  FLURRY_EVENT_PAYMENT_INFO_ADDED NS_SWIFT_NAME(paymentInfoAdded),
170  FLURRY_EVENT_ITEM_VIEWED NS_SWIFT_NAME(itemViewed),
176  FLURRY_EVENT_ITEM_LIST_VIEWED NS_SWIFT_NAME(itemListViewed),
182  FLURRY_EVENT_PURCHASED NS_SWIFT_NAME(purchased),
188  FLURRY_EVENT_PURCHASE_REFUNDED NS_SWIFT_NAME(purchaseRefunded),
194  FLURRY_EVENT_REMOVE_ITEM_FROM_CART NS_SWIFT_NAME(removeItemFromCart),
200  FLURRY_EVENT_CHECKOUT_INITIATED NS_SWIFT_NAME(checkoutInitiated),
206  FLURRY_EVENT_FUNDS_DONATED NS_SWIFT_NAME(fundsDonated),
212  FLURRY_EVENT_USER_SCHEDULED NS_SWIFT_NAME(userScheduled),
218  FLURRY_EVENT_OFFER_PRESENTED NS_SWIFT_NAME(offerPresented),
224  FLURRY_EVENT_SUBSCRIPTION_STARTED NS_SWIFT_NAME(subscriptionStarted),
231  FLURRY_EVENT_SUBSCRIPTION_ENDED NS_SWIFT_NAME(subscriptionEnded),
237  FLURRY_EVENT_GROUP_JOINED NS_SWIFT_NAME(groupJoined),
243  FLURRY_EVENT_GROUP_LEFT NS_SWIFT_NAME(groupLeft),
249  FLURRY_EVENT_TUTORIAL_STARTED NS_SWIFT_NAME(tutorialStarted),
255  FLURRY_EVENT_TUTORIAL_COMPLETED NS_SWIFT_NAME(tutorialCompleted),
261  FLURRY_EVENT_TUTORIAL_STEP_COMPLETED NS_SWIFT_NAME(tutorialStepCompleted),
267  FLURRY_EVENT_TUTORIAL_SKIPPED NS_SWIFT_NAME(tutorialSkipped),
273  FLURRY_EVENT_LOGIN NS_SWIFT_NAME(login),
279  FLURRY_EVENT_LOGOUT NS_SWIFT_NAME(logout),
286  FLURRY_EVENT_USER_REGISTERED NS_SWIFT_NAME(userRegistered),
292  FLURRY_EVENT_SEARCH_RESULT_VIEWED NS_SWIFT_NAME(searchResultViewed),
298  FLURRY_EVENT_KEYWORD_SEARCHED NS_SWIFT_NAME(keywordSearched),
304  FLURRY_EVENT_LOCATION_SEARCHED NS_SWIFT_NAME(locationSearched),
310  FLURRY_EVENT_INVITE NS_SWIFT_NAME(invite),
316  FLURRY_EVENT_SHARE NS_SWIFT_NAME(share),
322  FLURRY_EVENT_LIKE NS_SWIFT_NAME(like),
328  FLURRY_EVENT_COMMENT NS_SWIFT_NAME(comment),
334  FLURRY_EVENT_MEDIA_CAPTURED NS_SWIFT_NAME(mediaCaptured),
340  FLURRY_EVENT_MEDIA_STARTED NS_SWIFT_NAME(mediaStarted),
346  FLURRY_EVENT_MEDIA_STOPPED NS_SWIFT_NAME(mediaStopped),
352  FLURRY_EVENT_MEDIA_PAUSED NS_SWIFT_NAME(mediaPaused),
358  FLURRY_EVENT_PRIVACY_PROMPT_DISPLAYED NS_SWIFT_NAME(privacyPromptDisplayed),
364  FLURRY_EVENT_PRIVACY_OPT_IN NS_SWIFT_NAME(privacyOptIn),
370  FLURRY_EVENT_PRIVACY_OPT_OUT NS_SWIFT_NAME(privacyOptOut),
371 
372 };
373 
382 @interface FlurryParam : NSObject
383 
384 @end
391 @interface FlurryStringParam : FlurryParam
392 
393 @end
400 @interface FlurryIntegerParam : FlurryParam
401 
402 @end
409 @interface FlurryDoubleParam : FlurryParam
410 
411 @end
418 @interface FlurryLongParam : FlurryParam
419 
420 @end
427 @interface FlurryBooleanParam : FlurryParam
428 
429 @end
430 
445 @interface FlurryParamBuilder : NSObject
450 + (FlurryStringParam * _Nonnull) adType;
455 + (FlurryStringParam * _Nonnull) levelName;
460 + (FlurryIntegerParam * _Nonnull) levelNumber;
465 + (FlurryStringParam * _Nonnull) contentName;
470 + (FlurryStringParam * _Nonnull) contentType;
475 + (FlurryStringParam * _Nonnull) contentId;
480 + (FlurryStringParam * _Nonnull) creditName;
485 + (FlurryStringParam * _Nonnull) creditType;
490 + (FlurryStringParam * _Nonnull) creditId;
495 + (FlurryStringParam * _Nonnull) currencyType;
500 + (FlurryBooleanParam * _Nonnull) isCurrencySoft;
505 + (FlurryStringParam * _Nonnull) itemName;
510 + (FlurryStringParam * _Nonnull) itemType;
515 + (FlurryStringParam * _Nonnull) itemId;
520 + (FlurryIntegerParam * _Nonnull) itemCount;
525 + (FlurryStringParam * _Nonnull) itemCategory;
530 + (FlurryStringParam * _Nonnull) itemListType;
535 + (FlurryDoubleParam * _Nonnull) price;
540 + (FlurryDoubleParam * _Nonnull) totalAmount;
545 + (FlurryStringParam * _Nonnull) achievementId;
550 + (FlurryIntegerParam * _Nonnull) score;
555 + (FlurryStringParam * _Nonnull) rating;
560 + (FlurryStringParam * _Nonnull) transactionId;
565 + (FlurryBooleanParam * _Nonnull) success;
570 + (FlurryStringParam * _Nonnull) paymentType;
575 + (FlurryBooleanParam * _Nonnull) isAnnualSubscription;
580 + (FlurryStringParam * _Nonnull) subscriptionCountry;
585 + (FlurryIntegerParam * _Nonnull) trialDays;
590 + (FlurryStringParam * _Nonnull) predictedLTV;
595 + (FlurryStringParam * _Nonnull) groupName;
600 + (FlurryIntegerParam * _Nonnull) stepNumber;
605 + (FlurryStringParam * _Nonnull) tutorialName;
610 + (FlurryStringParam * _Nonnull) userId;
615 + (FlurryStringParam * _Nonnull) method;
620 + (FlurryStringParam * _Nonnull) query;
625 + (FlurryStringParam * _Nonnull) searchType;
630 + (FlurryStringParam * _Nonnull) socialContentName;
635 + (FlurryStringParam * _Nonnull) socialContentId;
640 + (FlurryStringParam * _Nonnull) likeType;
645 + (FlurryStringParam * _Nonnull) mediaName;
650 + (FlurryStringParam * _Nonnull) mediaType;
655 + (FlurryStringParam * _Nonnull) mediaId;
660 + (FlurryIntegerParam * _Nonnull) duration;
661 
668 - (nonnull NSDictionary<NSString *, NSString *> *)parameters;
675 - (nonnull FlurryParamBuilder *)setString:(nonnull NSString *)val
676  forKey:(nonnull NSString *)key
677 NS_SWIFT_NAME(set(stringVal:key:));
684 - (nonnull FlurryParamBuilder *)setString:(nonnull NSString *)val
685  forParam:(nonnull FlurryStringParam *)key
686 NS_SWIFT_NAME(set(stringVal:param:));
693 - (nonnull FlurryParamBuilder *)setInteger:(int)val
694  forKey:(nonnull NSString *)key
695 NS_SWIFT_NAME(set(integerVal:key:));
702 - (nonnull FlurryParamBuilder *)setInteger:(int)val
703  forParam:(nonnull FlurryIntegerParam *)key
704 NS_SWIFT_NAME(set(integerVal:param:));
711 - (nonnull FlurryParamBuilder *)setLong:(long)val
712  forKey:(nonnull NSString *)key
713 NS_SWIFT_NAME(set(longVal:key:));
720 - (nonnull FlurryParamBuilder *)setLong:(long)val
721  forParam:(nonnull FlurryLongParam *)key
722 NS_SWIFT_NAME(set(longVal:param:));
729 - (nonnull FlurryParamBuilder *)setBoolean:(BOOL)val
730  forKey:(nonnull NSString *)key
731 NS_SWIFT_NAME(set(booleanVal:key:));
738 - (nonnull FlurryParamBuilder *)setBoolean:(BOOL)val
739  forParam:(nonnull FlurryBooleanParam *)key
740 NS_SWIFT_NAME(set(booleanVal:param:));
747 - (nonnull FlurryParamBuilder *)setDouble:(double)val
748  forKey:(nonnull NSString *)key
749 NS_SWIFT_NAME(set(doubleVal:key:));
756 - (nonnull FlurryParamBuilder *)setDouble:(double)val
757  forParam:(nonnull FlurryDoubleParam *)key
758 NS_SWIFT_NAME(set(doubleVal:param:));
776 - (nonnull FlurryParamBuilder *)removeObjectForKey:(nonnull id)key
777 NS_SWIFT_NAME(remove(key:));
784 - (nonnull FlurryParamBuilder *)setAll:(nonnull FlurryParamBuilder *)param
785 NS_SWIFT_NAME(set(all:));
786 
787 @end
788 
789 @interface Flurry (Event)
790 
826 + (FlurryEventRecordStatus)logStandardEvent:(FlurryEvent)eventType
827  withParameters:(nullable FlurryParamBuilder *)parameters
828 NS_SWIFT_NAME(log(standardEvent:param:));
829 
830 
831 @end
832 
Copyright (c) 2013 Flurry Inc. All rights reserved.