iOS SDK Version

Constants

The following constants are available globally.
  • Notification indicating that the currentAccessToken has changed.
    the userInfo dictionary of the notification will contain keys FBSDKAccessTokenChangeOldKey and FBSDKAccessTokenChangeNewKey.

    Declaration

    Objective-C
    externNS_SWIFT_NAME(AccessTokenDidChange)constNSNotificationNameFBSDKAccessTokenDidChangeNotification
    Swift
    staticletAccessTokenDidChange:NSNotification.Name
  • A key in the notification’s userInfo that will be set if and only if the user ID changed between the old and new tokens.
    Token refreshes can occur automatically with the SDK which do not change the user. If you’re only interested in user changes (such as logging out), you should check for the existence of this key. The value is a NSNumber with a boolValue.
    On a fresh start of the app where the SDK reads in the cached value of an access token, this key will also exist since the access token is moving from a null state (no user) to a non-null state (user).

    Declaration

    Objective-C
    externNS_SWIFT_NAME(AccessTokenDidChangeUserIDKey)NSString*constFBSDKAccessTokenDidChangeUserIDKey
    Swift
    letAccessTokenDidChangeUserIDKey:String
  • Undocumented

    Declaration

    Objective-C
    FOUNDATION_EXPORTNSString*constFBSDKAccessTokenChangeOldKey
    Swift
    letAccessTokenChangeOldKey:String
  • Undocumented

    Declaration

    Objective-C
    FOUNDATION_EXPORTNSString*constFBSDKAccessTokenChangeNewKey
    Swift
    letAccessTokenChangeNewKey:String
  • Undocumented

    Declaration

    Objective-C
    FOUNDATION_EXPORTNSString*constFBSDKAccessTokenDidExpireKey
    Swift
    letAccessTokenDidExpireKey:String
  • The name of the notification posted by FBSDKMeasurementEvent

    Declaration

    Objective-C
    externNS_SWIFT_NAME(MeasurementEvent)constNSNotificationNameFBSDKMeasurementEventNotification
    Swift
    staticletMeasurementEvent:NSNotification.Name
  • Defines keys in the userInfo object for the notification named FBSDKMeasurementEventNotificationName The string field for the name of the event

    Declaration

    Objective-C
    externNS_SWIFT_NAME(MeasurementEventNameKey)NSString*constFBSDKMeasurementEventNameKey
    Swift
    letMeasurementEventNameKey:String
  • The dictionary field for the arguments of the event

    Declaration

    Objective-C
    externNS_SWIFT_NAME(MeasurementEventArgsKey)NSString*constFBSDKMeasurementEventArgsKey
    Swift
    letMeasurementEventArgsKey:String
  • Events raised by FBSDKMeasurementEvent for Applink The name of the event posted when [FBSDKURL URLWithURL:] is called successfully. This represents the successful parsing of an app link URL.

    Declaration

    Objective-C
    externNS_SWIFT_NAME(AppLinkParseEventName)NSString*constFBSDKAppLinkParseEventName
    Swift
    letAppLinkParseEventName:String
  • The name of the event posted when [FBSDKURL URLWithInboundURL:] is called successfully. This represents parsing an inbound app link URL from a different application

    Declaration

    Objective-C
    externNS_SWIFT_NAME(AppLinkNavigateInEventName)NSString*constFBSDKAppLinkNavigateInEventName
    Swift
    letAppLinkNavigateInEventName:String
  • The event raised when the user navigates from your app to other apps

    Declaration

    Objective-C
    externNS_SWIFT_NAME(AppLinkNavigateOutEventName)NSString*constFBSDKAppLinkNavigateOutEventName
    Swift
    letAppLinkNavigateOutEventName:String
  • The event raised when the user navigates out from your app and back to the referrer app. e.g when the user leaves your app after tapping the back-to-referrer navigation bar

    Declaration

    Objective-C
    externNS_SWIFT_NAME(AppLinkNavigateBackToReferrerEventName)NSString*constFBSDKAppLinkNavigateBackToReferrerEventName
    Swift
    letAppLinkNavigateBackToReferrerEventName:String
  • Notification indicating that the currentProfile has changed.
    the userInfo dictionary of the notification will contain keys FBSDKProfileChangeOldKey and FBSDKProfileChangeNewKey.

    Declaration

    Objective-C
    externNS_SWIFT_NAME(ProfileDidChange)constNSNotificationNameFBSDKProfileDidChangeNotification
    Swift
    staticletProfileDidChange:NSNotification.Name
  • Undocumented

    Declaration

    Objective-C
    FOUNDATION_EXPORTNSString*constFBSDKProfileChangeOldKey
    Swift
    letProfileChangeOldKey:String
  • Undocumented

    Declaration

    Objective-C
    FOUNDATION_EXPORTNSString*constFBSDKProfileChangeNewKey
    Swift
    letProfileChangeNewKey:String
  • Include access token in logging.

    Declaration

    Objective-C
    externFBSDKLoggingBehavior_NonnullFBSDKLoggingBehaviorAccessTokens
    Swift
    staticletaccessTokens:LoggingBehavior
  • Log performance characteristics

    Declaration

    Objective-C
    externFBSDKLoggingBehavior_NonnullFBSDKLoggingBehaviorPerformanceCharacteristics
    Swift
    staticletperformanceCharacteristics:LoggingBehavior
  • Log FBSDKAppEvents interactions

    Declaration

    Objective-C
    externFBSDKLoggingBehavior_NonnullFBSDKLoggingBehaviorAppEvents
    Swift
    staticletappEvents:LoggingBehavior
  • Log Informational occurrences

    Declaration

    Objective-C
    externFBSDKLoggingBehavior_NonnullFBSDKLoggingBehaviorInformational
    Swift
    staticletinformational:LoggingBehavior
  • Log cache errors.

    Declaration

    Objective-C
    externFBSDKLoggingBehavior_NonnullFBSDKLoggingBehaviorCacheErrors
    Swift
    staticletcacheErrors:LoggingBehavior
  • Log errors from SDK UI controls

    Declaration

    Objective-C
    externFBSDKLoggingBehavior_NonnullFBSDKLoggingBehaviorUIControlErrors
    Swift
    staticletuiControlErrors:LoggingBehavior
  • Log debug warnings from API response, i.e. when friends fields requested, but user_friends permission isn’t granted.

    Declaration

    Objective-C
    externFBSDKLoggingBehavior_NonnullFBSDKLoggingBehaviorGraphAPIDebugWarning
    Swift
    staticletgraphAPIDebugWarning:LoggingBehavior
  • Log warnings from API response, i.e. when requested feature will be deprecated in next version of API. Info is the lowest level of severity, using it will result in logging all previously mentioned levels.

    Declaration

    Objective-C
    externFBSDKLoggingBehavior_NonnullFBSDKLoggingBehaviorGraphAPIDebugInfo
    Swift
    staticletgraphAPIDebugInfo:LoggingBehavior
  • Log errors from SDK network requests

    Declaration

    Objective-C
    externFBSDKLoggingBehavior_NonnullFBSDKLoggingBehaviorNetworkRequests
    Swift
    staticletnetworkRequests:LoggingBehavior
  • Log errors likely to be preventable by the developer. This is in the default set of enabled logging behaviors.

    Declaration

    Objective-C
    externFBSDKLoggingBehavior_NonnullFBSDKLoggingBehaviorDeveloperErrors
    Swift
    staticletdeveloperErrors:LoggingBehavior
  • The error domain for all errors from FBSDKShareKit.
    Error codes from the SDK in the range 200-299 are reserved for this domain.

    Declaration

    Objective-C
    externNS_SWIFT_NAME(ShareErrorDomain)constNSErrorDomainFBSDKShareErrorDomain
    Swift
    letShareErrorDomain:String
  • NSNotificationCenter name indicating a result of a failed log flush attempt. The posted object will be an NSError instance.

    Declaration

    Objective-C
    externNS_SWIFT_NAME(AppEventsLoggingResult)constNSNotificationNameFBSDKAppEventsLoggingResultNotification
    Swift
    staticletAppEventsLoggingResult:NSNotification.Name
  • optional plist key (“FacebookLoggingOverrideAppID”) for setting loggingOverrideAppID

    Declaration

    Objective-C
    externNS_SWIFT_NAME(AppEventsOverrideAppIDBundleKey)NSString*constFBSDKAppEventsOverrideAppIDBundleKey
    Swift
    letAppEventsOverrideAppIDBundleKey:String
  • Log this event when the user has achieved a level in the app.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameAchievedLevel
    Swift
    staticletachievedLevel:AppEvents.Name
  • Log this event when the user has entered their payment info.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameAddedPaymentInfo
    Swift
    staticletaddedPaymentInfo:AppEvents.Name
  • Log this event when the user has added an item to their cart. The valueToSum passed to logEvent should be the item’s price.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameAddedToCart
    Swift
    staticletaddedToCart:AppEvents.Name
  • Log this event when the user has added an item to their wishlist. The valueToSum passed to logEvent should be the item’s price.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameAddedToWishlist
    Swift
    staticletaddedToWishlist:AppEvents.Name
  • Log this event when a user has completed registration with the app.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameCompletedRegistration
    Swift
    staticletcompletedRegistration:AppEvents.Name
  • Log this event when the user has completed a tutorial in the app.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameCompletedTutorial
    Swift
    staticletcompletedTutorial:AppEvents.Name
  • Log this event when the user has entered the checkout process. The valueToSum passed to logEvent should be the total price in the cart.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameInitiatedCheckout
    Swift
    staticletinitiatedCheckout:AppEvents.Name
  • Log this event when the user has completed a transaction. The valueToSum passed to logEvent should be the total price of the transaction.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNamePurchased
    Swift
    staticletpurchased:AppEvents.Name
  • Log this event when the user has rated an item in the app. The valueToSum passed to logEvent should be the numeric rating.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameRated
    Swift
    staticletrated:AppEvents.Name
  • Log this event when a user has performed a search within the app.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameSearched
    Swift
    staticletsearched:AppEvents.Name
  • Log this event when the user has spent app credits. The valueToSum passed to logEvent should be the number of credits spent.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameSpentCredits
    Swift
    staticletspentCredits:AppEvents.Name
  • Log this event when the user has unlocked an achievement in the app.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameUnlockedAchievement
    Swift
    staticletunlockedAchievement:AppEvents.Name
  • Log this event when a user has viewed a form of content in the app.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameViewedContent
    Swift
    staticletviewedContent:AppEvents.Name
  • A telephone/SMS, email, chat or other type of contact between a customer and your business.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameContact
    Swift
    staticletcontact:AppEvents.Name
  • The customization of products through a configuration tool or other application your business owns.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameCustomizeProduct
    Swift
    staticletcustomizeProduct:AppEvents.Name
  • The donation of funds to your organization or cause.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameDonate
    Swift
    staticletdonate:AppEvents.Name
  • When a person finds one of your locations via web or application, with an intention to visit (example: find product at a local store).

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameFindLocation
    Swift
    staticletfindLocation:AppEvents.Name
  • The booking of an appointment to visit one of your locations.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameSchedule
    Swift
    staticletschedule:AppEvents.Name
  • The start of a free trial of a product or service you offer (example: trial subscription).

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameStartTrial
    Swift
    staticletstartTrial:AppEvents.Name
  • The submission of an application for a product, service or program you offer (example: credit card, educational program or job).

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameSubmitApplication
    Swift
    staticletsubmitApplication:AppEvents.Name
  • The start of a paid subscription for a product or service you offer.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameSubscribe
    Swift
    staticletsubscribe:AppEvents.Name
  • Log this event when the user views an ad.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameAdImpression
    Swift
    staticletadImpression:AppEvents.Name
  • Log this event when the user clicks an ad.

    Declaration

    Objective-C
    externFBSDKAppEventName_NonnullFBSDKAppEventNameAdClick
    Swift
    staticletadClick:AppEvents.Name
  • Parameter key used to specify data for the one or more pieces of content being logged about. Data should be a JSON encoded string. Example: “[{\"id\”: \“1234\”, \“quantity\”: 2, \“item_price\”: 5.99}, {\“id\”: \“5678\”, \“quantity\”: 1, \“item_price\”: 9.99}]“

    Declaration

    Objective-C
    externFBSDKAppEventParameterName_NonnullFBSDKAppEventParameterNameContent
    Swift
    staticletcontent:AppEvents.ParameterName
  • Parameter key used to specify an ID for the specific piece of content being logged about. Could be an EAN, article identifier, etc., depending on the nature of the app.

    Declaration

    Objective-C
    externFBSDKAppEventParameterName_NonnullFBSDKAppEventParameterNameContentID
    Swift
    staticletcontentID:AppEvents.ParameterName
  • Parameter key used to specify a generic content type/family for the logged event, e.g. “music”, “photo”, “video”. Options to use will vary based upon what the app is all about.

    Declaration

    Objective-C
    externFBSDKAppEventParameterName_NonnullFBSDKAppEventParameterNameContentType
    Swift
    staticletcontentType:AppEvents.ParameterName
  • Parameter key used to specify currency used with logged event. E.g. “USD”, “EUR”, “GBP”. See ISO-4217 for specific values. One reference for these is http://en.wikipedia.org/wiki/ISO_4217.

    Declaration

    Objective-C
    externFBSDKAppEventParameterName_NonnullFBSDKAppEventParameterNameCurrency
    Swift
    staticletcurrency:AppEvents.ParameterName
  • Parameter key used to specify a description appropriate to the event being logged. E.g., the name of the achievement unlocked in the FBAppEventNameAchievementUnlocked event.

    Declaration

    Objective-C
    externFBSDKAppEventParameterName_NonnullFBSDKAppEventParameterNameDescription
    Swift
    staticletdescription:AppEvents.ParameterName
  • Parameter key used to specify the level achieved in a FBAppEventNameAchieved event.

    Declaration

    Objective-C
    externFBSDKAppEventParameterName_NonnullFBSDKAppEventParameterNameLevel
    Swift
    staticletlevel:AppEvents.ParameterName
  • Parameter key used to specify the maximum rating available for the FBAppEventNameRate event. E.g., “5” or “10”.

    Declaration

    Objective-C
    externFBSDKAppEventParameterName_NonnullFBSDKAppEventParameterNameMaxRatingValue
    Swift
    staticletmaxRatingValue:AppEvents.ParameterName
  • Parameter key used to specify how many items are being processed for an FBAppEventNameInitiatedCheckout or FBAppEventNamePurchased event.

    Declaration

    Objective-C
    externFBSDKAppEventParameterName_NonnullFBSDKAppEventParameterNameNumItems
    Swift
    staticletnumItems:AppEvents.ParameterName
  • Parameter key used to specify whether payment info is available for the FBAppEventNameInitiatedCheckout event. FBSDKAppEventParameterValueYes and FBSDKAppEventParameterValueNo are good canonical values to use for this parameter.

    Declaration

    Objective-C
    externFBSDKAppEventParameterName_NonnullFBSDKAppEventParameterNamePaymentInfoAvailable
    Swift
    staticletpaymentInfoAvailable:AppEvents.ParameterName
  • Parameter key used to specify method user has used to register for the app, e.g., “Facebook”, “email”, “Twitter”, etc

    Declaration

    Objective-C
    externFBSDKAppEventParameterName_NonnullFBSDKAppEventParameterNameRegistrationMethod
    Swift
    staticletregistrationMethod:AppEvents.ParameterName
  • Parameter key used to specify the string provided by the user for a search operation.

    Declaration

    Objective-C
    externFBSDKAppEventParameterName_NonnullFBSDKAppEventParameterNameSearchString
    Swift
    staticletsearchString:AppEvents.ParameterName
  • Parameter key used to specify whether the activity being logged about was successful or not. FBSDKAppEventParameterValueYes and FBSDKAppEventParameterValueNo are good canonical values to use for this parameter.

    Declaration

    Objective-C
    externFBSDKAppEventParameterName_NonnullFBSDKAppEventParameterNameSuccess
    Swift
    staticletsuccess:AppEvents.ParameterName
  • Parameter key used to specify the product item’s category.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductCategory
    Swift
    staticletcategory:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s custom label 0.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductCustomLabel0
    Swift
    staticletcustomLabel0:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s custom label 1.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductCustomLabel1
    Swift
    staticletcustomLabel1:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s custom label 2.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductCustomLabel2
    Swift
    staticletcustomLabel2:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s custom label 3.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductCustomLabel3
    Swift
    staticletcustomLabel3:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s custom label 4.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductCustomLabel4
    Swift
    staticletcustomLabel4:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s AppLink app URL for iOS.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductAppLinkIOSUrl
    Swift
    staticletappLinkIOSUrl:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s AppLink app ID for iOS App Store.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductAppLinkIOSAppStoreID
    Swift
    staticletappLinkIOSAppStoreID:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s AppLink app name for iOS.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductAppLinkIOSAppName
    Swift
    staticletappLinkIOSAppName:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s AppLink app URL for iPhone.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductAppLinkIPhoneUrl
    Swift
    staticletappLinkIPhoneUrl:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s AppLink app ID for iPhone App Store.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductAppLinkIPhoneAppStoreID
    Swift
    staticletappLinkIPhoneAppStoreID:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s AppLink app name for iPhone.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductAppLinkIPhoneAppName
    Swift
    staticletappLinkIPhoneAppName:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s AppLink app URL for iPad.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductAppLinkIPadUrl
    Swift
    staticletappLinkIPadUrl:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s AppLink app ID for iPad App Store.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductAppLinkIPadAppStoreID
    Swift
    staticletappLinkIPadAppStoreID:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s AppLink app name for iPad.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductAppLinkIPadAppName
    Swift
    staticletappLinkIPadAppName:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s AppLink app URL for Android.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductAppLinkAndroidUrl
    Swift
    staticletappLinkAndroidUrl:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s AppLink fully-qualified package name for intent generation.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductAppLinkAndroidPackage
    Swift
    staticletappLinkAndroidPackage:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s AppLink app name for Android.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductAppLinkAndroidAppName
    Swift
    staticletappLinkAndroidAppName:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s AppLink app URL for Windows Phone.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductAppLinkWindowsPhoneUrl
    Swift
    staticletappLinkWindowsPhoneUrl:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s AppLink app ID, as a GUID, for App Store.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductAppLinkWindowsPhoneAppID
    Swift
    staticletappLinkWindowsPhoneAppID:AppEvents.ParameterProduct
  • Parameter key used to specify the product item’s AppLink app name for Windows Phone.

    Declaration

    Objective-C
    externFBSDKAppEventParameterProduct_NonnullFBSDKAppEventParameterProductAppLinkWindowsPhoneAppName
    Swift
    staticletappLinkWindowsPhoneAppName:AppEvents.ParameterProduct
  • Yes-valued parameter value to be used with parameter keys that need a Yes/No value

    Declaration

    Objective-C
    externFBSDKAppEventParameterValue_NonnullFBSDKAppEventParameterValueYes
    Swift
    staticletyes:AppEvents.ParameterValue
  • No-valued parameter value to be used with parameter keys that need a Yes/No value

    Declaration

    Objective-C
    externFBSDKAppEventParameterValue_NonnullFBSDKAppEventParameterValueNo
    Swift
    staticletno:AppEvents.ParameterValue
  • Parameter key used to specify the type of ad in an FBSDKAppEventNameAdImpression
    • or FBSDKAppEventNameAdClick event.
    • E.g. “banner”, “interstitial”, “rewarded_video”, “native”

    Declaration

    Objective-C
    externFBSDKAppEventParameterName_NonnullFBSDKAppEventParameterNameAdType
    Swift
    staticletadType:AppEvents.ParameterName
  • Parameter key used to specify the unique ID for all events within a subscription
    • in an FBSDKAppEventNameSubscribe or FBSDKAppEventNameStartTrial event.

    Declaration

    Objective-C
    externFBSDKAppEventParameterName_NonnullFBSDKAppEventParameterNameOrderID
    Swift
    staticletorderID:AppEvents.ParameterName
  • Parameter key used to specify user’s email.

    Declaration

    Objective-C
    externFBSDKAppEventUserDataType_NonnullFBSDKAppEventEmail
    Swift
    staticletemail:AppEvents.UserDataType
  • Parameter key used to specify user’s first name.

    Declaration

    Objective-C
    externFBSDKAppEventUserDataType_NonnullFBSDKAppEventFirstName
    Swift
    staticletfirstName:AppEvents.UserDataType
  • Parameter key used to specify user’s last name.

    Declaration

    Objective-C
    externFBSDKAppEventUserDataType_NonnullFBSDKAppEventLastName
    Swift
    staticletlastName:AppEvents.UserDataType
  • Parameter key used to specify user’s phone.

    Declaration

    Objective-C
    externFBSDKAppEventUserDataType_NonnullFBSDKAppEventPhone
    Swift
    staticletphone:AppEvents.UserDataType
  • Parameter key used to specify user’s date of birth.

    Declaration

    Objective-C
    externFBSDKAppEventUserDataType_NonnullFBSDKAppEventDateOfBirth
    Swift
    staticletdateOfBirth:AppEvents.UserDataType
  • Parameter key used to specify user’s gender.

    Declaration

    Objective-C
    externFBSDKAppEventUserDataType_NonnullFBSDKAppEventGender
    Swift
    staticletgender:AppEvents.UserDataType
  • Parameter key used to specify user’s city.

    Declaration

    Objective-C
    externFBSDKAppEventUserDataType_NonnullFBSDKAppEventCity
    Swift
    staticletcity:AppEvents.UserDataType
  • Parameter key used to specify user’s state.

    Declaration

    Objective-C
    externFBSDKAppEventUserDataType_NonnullFBSDKAppEventState
    Swift
    staticletstate:AppEvents.UserDataType
  • Parameter key used to specify user’s zip.

    Declaration

    Objective-C
    externFBSDKAppEventUserDataType_NonnullFBSDKAppEventZip
    Swift
    staticletzip:AppEvents.UserDataType
  • Parameter key used to specify user’s country.

    Declaration

    Objective-C
    externFBSDKAppEventUserDataType_NonnullFBSDKAppEventCountry
    Swift
    staticletcountry:AppEvents.UserDataType
  • The version of the App Link protocol that this library supports

    Declaration

    Objective-C
    externNS_SWIFT_NAME(AppLinkVersion)NSString*constFBSDKAppLinkVersion
    Swift
    letAppLinkVersion:String
  • The error domain for all errors from FBSDKCoreKit.
    Error codes from the SDK in the range 0-99 are reserved for this domain.

    Declaration

    Objective-C
    externNS_SWIFT_NAME(ErrorDomain)constNSErrorDomainFBSDKErrorDomain
    Swift
    letErrorDomain:String
  • The userInfo key for the invalid collection for errors with FBSDKErrorInvalidArgument.
    If the invalid argument is a collection, the collection can be found with this key and the individual invalid item can be found with FBSDKErrorArgumentValueKey.

    Declaration

    Objective-C
    externNS_SWIFT_NAME(ErrorArgumentCollectionKey)constNSErrorUserInfoKeyFBSDKErrorArgumentCollectionKey
    Swift
    letErrorArgumentCollectionKey:String
  • The userInfo key for the invalid argument name for errors with FBSDKErrorInvalidArgument.

    Declaration

    Objective-C
    externNS_SWIFT_NAME(ErrorArgumentNameKey)constNSErrorUserInfoKeyFBSDKErrorArgumentNameKey
    Swift
    letErrorArgumentNameKey:String
  • The userInfo key for the invalid argument value for errors with FBSDKErrorInvalidArgument.

    Declaration

    Objective-C
    externNS_SWIFT_NAME(ErrorArgumentValueKey)constNSErrorUserInfoKeyFBSDKErrorArgumentValueKey
    Swift
    letErrorArgumentValueKey:String
  • The userInfo key for the message for developers in NSErrors that originate from the SDK.
    The developer message will not be localized and is not intended to be presented within the app.

    Declaration

    Objective-C
    externNS_SWIFT_NAME(ErrorDeveloperMessageKey)constNSErrorUserInfoKeyFBSDKErrorDeveloperMessageKey
    Swift
    letErrorDeveloperMessageKey:String
  • The userInfo key describing a localized description that can be presented to the user.

    Declaration

    Objective-C
    externNS_SWIFT_NAME(ErrorLocalizedDescriptionKey)constNSErrorUserInfoKeyFBSDKErrorLocalizedDescriptionKey
    Swift
    letErrorLocalizedDescriptionKey:String
  • The userInfo key describing a localized title that can be presented to the user, used with FBSDKLocalizedErrorDescriptionKey.

    Declaration

    Objective-C
    externNS_SWIFT_NAME(ErrorLocalizedTitleKey)constNSErrorUserInfoKeyFBSDKErrorLocalizedTitleKey
    Swift
    letErrorLocalizedTitleKey:String
  • The userInfo key describing the error category, for error recovery purposes.
    See FBSDKGraphErrorRecoveryProcessor and [FBSDKGraphRequest disableErrorRecovery].

    Declaration

    Objective-C
    externNS_SWIFT_NAME(GraphRequestErrorKey)constNSErrorUserInfoKeyFBSDKGraphRequestErrorKey
    Swift
    letGraphRequestErrorKey:String
  • Undocumented

    Declaration

    Objective-C
    FOUNDATION_EXPORTNSErrorUserInfoKeyconstFBSDKGraphRequestErrorGraphErrorCodeKey
    Swift
    letGraphRequestErrorGraphErrorCodeKey:String
  • Undocumented

    Declaration

    Objective-C
    FOUNDATION_EXPORTNSErrorUserInfoKeyconstFBSDKGraphRequestErrorGraphErrorSubcodeKey
    Swift
    letGraphRequestErrorGraphErrorSubcodeKey:String
  • Undocumented

    Declaration

    Objective-C
    FOUNDATION_EXPORTNSErrorUserInfoKeyconstFBSDKGraphRequestErrorHTTPStatusCodeKey
    Swift
    letGraphRequestErrorHTTPStatusCodeKey:String
  • Undocumented

    Declaration

    Objective-C
    FOUNDATION_EXPORTNSErrorUserInfoKeyconstFBSDKGraphRequestErrorParsedJSONResponseKey
    Swift
    letGraphRequestErrorParsedJSONResponseKey:String
  • GET Request

    Declaration

    Objective-C
    externNS_SWIFT_NAME(get)FBSDKHTTPMethodFBSDKHTTPMethodGET
    Swift
    staticletget:HTTPMethod
  • POST Request

    Declaration

    Objective-C
    externNS_SWIFT_NAME(post)FBSDKHTTPMethodFBSDKHTTPMethodPOST
    Swift
    staticletpost:HTTPMethod
  • DELETE Request

    Declaration

    Objective-C
    externNS_SWIFT_NAME(delete)FBSDKHTTPMethodFBSDKHTTPMethodDELETE
    Swift
    staticletdelete:HTTPMethod
  • The key in the result dictionary for requests to old versions of the Graph API whose response is not a JSON object.
    When a request returns a non-JSON response (such as a “true” literal), that response will be wrapped into a dictionary using this const as the key. This only applies for very few Graph API prior to v2.1.

    Declaration

    Objective-C
    externNS_SWIFT_NAME(NonJSONResponseProperty)NSString*constFBSDKNonJSONResponseProperty
    Swift
    letNonJSONResponseProperty:String