| commit | author | age | ||
| e0ec42 | 1 | /* |
| L | 2 | * Copyright (c) Meta Platforms, Inc. and affiliates. |
| 3 | * All rights reserved. | |
| 4 | * | |
| 5 | * This source code is licensed under the license found in the | |
| 6 | * LICENSE file in the root directory of this source tree. | |
| 7 | */ | |
| 8 | ||
| 9 | #import <Foundation/Foundation.h> | |
| 10 | ||
| 11 | /** | |
| 12 | @methodgroup Predefined event names for logging events common to many apps. Logging occurs through the `logEvent` family of methods on `FBSDKAppEvents`. | |
| 13 | Common event parameters are provided in the `FBSDKAppEventParameterName` constants. | |
| 14 | */ | |
| 15 | ||
| 16 | /// typedef for FBSDKAppEventName | |
| 17 | typedef NSString *FBSDKAppEventName NS_TYPED_EXTENSIBLE_ENUM NS_SWIFT_NAME(AppEvents.Name); | |
| 18 | ||
| 19 | // MARK: - General Purpose | |
| 20 | ||
| 21 | /// Log this event when the user clicks an ad. | |
| 22 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameAdClick; | |
| 23 | ||
| 24 | /// Log this event when the user views an ad. | |
| 25 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameAdImpression; | |
| 26 | ||
| 27 | /// Log this event when a user has completed registration with the app. | |
| 28 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameCompletedRegistration; | |
| 29 | ||
| 30 | /// Log this event when the user has completed a tutorial in the app. | |
| 31 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameCompletedTutorial; | |
| 32 | ||
| 33 | /// A telephone/SMS, email, chat or other type of contact between a customer and your business. | |
| 34 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameContact; | |
| 35 | ||
| 36 | /// The customization of products through a configuration tool or other application your business owns. | |
| 37 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameCustomizeProduct; | |
| 38 | ||
| 39 | /// The donation of funds to your organization or cause. | |
| 40 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameDonate; | |
| 41 | ||
| 42 | /// When a person finds one of your locations via web or application, with an intention to visit (example: find product at a local store). | |
| 43 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameFindLocation; | |
| 44 | ||
| 45 | /// Log this event when the user has rated an item in the app. The valueToSum passed to logEvent should be the numeric rating. | |
| 46 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameRated; | |
| 47 | ||
| 48 | /// The booking of an appointment to visit one of your locations. | |
| 49 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameSchedule; | |
| 50 | ||
| 51 | /// Log this event when a user has performed a search within the app. | |
| 52 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameSearched; | |
| 53 | ||
| 54 | /// The start of a free trial of a product or service you offer (example: trial subscription). | |
| 55 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameStartTrial; | |
| 56 | ||
| 57 | /// The submission of an application for a product, service or program you offer (example: credit card, educational program or job). | |
| 58 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameSubmitApplication; | |
| 59 | ||
| 60 | /// The start of a paid subscription for a product or service you offer. | |
| 61 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameSubscribe; | |
| 62 | ||
| 63 | /// Log this event when a user has viewed a form of content in the app. | |
| 64 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameViewedContent; | |
| 65 | ||
| 66 | // MARK: - E-Commerce | |
| 67 | ||
| 68 | /// Log this event when the user has entered their payment info. | |
| 69 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameAddedPaymentInfo; | |
| 70 | ||
| 71 | /// Log this event when the user has added an item to their cart. The valueToSum passed to logEvent should be the item's price. | |
| 72 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameAddedToCart; | |
| 73 | ||
| 74 | /// Log this event when the user has added an item to their wishlist. The valueToSum passed to logEvent should be the item's price. | |
| 75 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameAddedToWishlist; | |
| 76 | ||
| 77 | /// Log this event when the user has entered the checkout process. The valueToSum passed to logEvent should be the total price in the cart. | |
| 78 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameInitiatedCheckout; | |
| 79 | ||
| 80 | /// Log this event when the user has completed a transaction. The valueToSum passed to logEvent should be the total price of the transaction. | |
| 81 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNamePurchased; | |
| 82 | ||
| 83 | // MARK: - Gaming | |
| 84 | ||
| 85 | /// Log this event when the user has achieved a level in the app. | |
| 86 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameAchievedLevel; | |
| 87 | ||
| 88 | /// Log this event when the user has unlocked an achievement in the app. | |
| 89 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameUnlockedAchievement; | |
| 90 | ||
| 91 | /// Log this event when the user has spent app credits. The valueToSum passed to logEvent should be the number of credits spent. | |
| 92 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameSpentCredits; | |
| 93 | ||
| 94 | // MARK: - Internal | |
| 95 | ||
| 96 | /** | |
| 97 | Internal values exposed to facilitate transition to Swift. | |
| 98 | API Subject to change or removal without warning. Do not use. | |
| 99 | ||
| 100 | @warning INTERNAL - DO NOT USE | |
| 101 | */ | |
| 102 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameInitializeSDK; | |
| 103 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameBackgroundStatusAvailable; | |
| 104 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameBackgroundStatusDenied; | |
| 105 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameBackgroundStatusRestricted; | |
| 106 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameSDKSettingsChanged; | |
