FBSDKAppEventName.h 5.0 KB

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