| commit | author | age | ||
| 2e29a3 | 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 | ||
| e0ec42 | 21 | /// Log this event when the user clicks an ad. |
| 2e29a3 | 22 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameAdClick; |
| L | 23 | |
| e0ec42 | 24 | /// Log this event when the user views an ad. |
| 2e29a3 | 25 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameAdImpression; |
| L | 26 | |
| e0ec42 | 27 | /// Log this event when a user has completed registration with the app. |
| 2e29a3 | 28 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameCompletedRegistration; |
| L | 29 | |
| e0ec42 | 30 | /// Log this event when the user has completed a tutorial in the app. |
| 2e29a3 | 31 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameCompletedTutorial; |
| L | 32 | |
| e0ec42 | 33 | /// A telephone/SMS, email, chat or other type of contact between a customer and your business. |
| 2e29a3 | 34 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameContact; |
| L | 35 | |
| e0ec42 | 36 | /// The customization of products through a configuration tool or other application your business owns. |
| 2e29a3 | 37 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameCustomizeProduct; |
| L | 38 | |
| e0ec42 | 39 | /// The donation of funds to your organization or cause. |
| 2e29a3 | 40 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameDonate; |
| L | 41 | |
| e0ec42 | 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). |
| 2e29a3 | 43 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameFindLocation; |
| L | 44 | |
| e0ec42 | 45 | /// Log this event when the user has rated an item in the app. The valueToSum passed to logEvent should be the numeric rating. |
| 2e29a3 | 46 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameRated; |
| L | 47 | |
| e0ec42 | 48 | /// The booking of an appointment to visit one of your locations. |
| 2e29a3 | 49 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameSchedule; |
| L | 50 | |
| e0ec42 | 51 | /// Log this event when a user has performed a search within the app. |
| 2e29a3 | 52 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameSearched; |
| L | 53 | |
| e0ec42 | 54 | /// The start of a free trial of a product or service you offer (example: trial subscription). |
| 2e29a3 | 55 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameStartTrial; |
| L | 56 | |
| e0ec42 | 57 | /// The submission of an application for a product, service or program you offer (example: credit card, educational program or job). |
| 2e29a3 | 58 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameSubmitApplication; |
| L | 59 | |
| e0ec42 | 60 | /// The start of a paid subscription for a product or service you offer. |
| 2e29a3 | 61 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameSubscribe; |
| L | 62 | |
| e0ec42 | 63 | /// Log this event when a user has viewed a form of content in the app. |
| 2e29a3 | 64 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameViewedContent; |
| L | 65 | |
| 66 | // MARK: - E-Commerce | |
| 67 | ||
| e0ec42 | 68 | /// Log this event when the user has entered their payment info. |
| 2e29a3 | 69 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameAddedPaymentInfo; |
| L | 70 | |
| e0ec42 | 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. |
| 2e29a3 | 72 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameAddedToCart; |
| L | 73 | |
| e0ec42 | 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. |
| 2e29a3 | 75 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameAddedToWishlist; |
| L | 76 | |
| e0ec42 | 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. |
| 2e29a3 | 78 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameInitiatedCheckout; |
| L | 79 | |
| e0ec42 | 80 | /// Log this event when the user has completed a transaction. The valueToSum passed to logEvent should be the total price of the transaction. |
| 2e29a3 | 81 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNamePurchased; |
| L | 82 | |
| 83 | // MARK: - Gaming | |
| 84 | ||
| e0ec42 | 85 | /// Log this event when the user has achieved a level in the app. |
| 2e29a3 | 86 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameAchievedLevel; |
| L | 87 | |
| e0ec42 | 88 | /// Log this event when the user has unlocked an achievement in the app. |
| 2e29a3 | 89 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameUnlockedAchievement; |
| L | 90 | |
| e0ec42 | 91 | /// Log this event when the user has spent app credits. The valueToSum passed to logEvent should be the number of credits spent. |
| 2e29a3 | 92 | FOUNDATION_EXPORT FBSDKAppEventName const FBSDKAppEventNameSpentCredits; |
| e0ec42 | 93 | |
| L | 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; | |
