Facebook SDK for iOS Reference - Documentation - Meta for Developers

Facebook SDK for iOS Reference (v4.17)

Previous Versions 4.16 4.15.1 4.15 4.14 4.13 4.12 4.11 4.9 4.8 4.7 4.6 4.5 4.4 4.3 4.2 4.1 4.0.1 4.0 3.24 3.23 3.22 3.21 3.20 3.19 3.18 3.17 3.16 3.15 3.14 3.13 3.12 3.11 3.10 3.9 3.8 3.7 3.6 3.5 3.2.1 3.0 Legacy

Core Kit Classes

Name	Description
`FBSDKAccessToken`	Represents an immutable access token for using Facebook services
`FBSDKAppEvents`	Client-side event logging for specialized application analytics available through Facebook App Insights and for use with Facebook Ads conversion tracking and optimization
`FBSDKApplicationDelegate`	The FBSDKApplicationDelegate is designed to post process the results from Facebook Login or Facebook Dialogs (or any action that requires switching over to the native Facebook app or Safari)
`FBSDKAppLinkResolver`	Provides an implementation of the BFAppLinkResolving protocol that uses the Facebook App Link Index API to resolve App Links given a URL
`FBSDKAppLinkUtility`	Class containing App Links related utility methods
`FBSDKButton`	A base class for common SDK buttons
`FBSDKGraphErrorRecoveryProcessor`	Defines a type that can process Facebook NSErrors with best practices
`FBSDKGraphRequest`	Represents a request to the Facebook Graph API
`FBSDKGraphRequestConnection`	The FBSDKGraphRequestConnection represents a single connection to Facebook to service a request
`FBSDKGraphRequestDataAttachment`	A container class for data attachments so that additional metadata can be provided about the attachment
`FBSDKProfile`	Represents an immutable Facebook profile
`FBSDKProfilePictureView`	A view to display a profile picture
`FBSDKTestUsersManager`	Provides methods for managing test accounts for testing Facebook integration
`FBSDKUtility`	Class to contain common utility methods

Core Kit Protocols

Name	Description
`BFAppLinkResolving`
`FBSDKCopying`	Extension protocol for NSCopying that adds the copy method, which is implemented on NSObject
`FBSDKErrorRecoveryAttempting`	a formal protocol very similar to the informal protocol NSErrorRecoveryAttempting
`FBSDKGraphErrorRecoveryProcessorDelegate`	Defines a delegate for FBSDKGraphErrorRecoveryProcessor
`FBSDKGraphRequestConnectionDelegate`	The FBSDKGraphRequestConnectionDelegate protocol defines the methods used to receive network activity progress information from a FBSDKGraphRequestConnection
`FBSDKMutableCopying`	Extension protocol for NSMutableCopying that adds the mutableCopy method, which is implemented on NSObject

Core Kit Other

Name	Description
`FBSDKSettings`

Name	Description
`FBSDKLoginButton`	A button that initiates a log in or log out flow upon tapping
`FBSDKLoginManager`	FBSDKLoginManager provides methods for logging the user in and out
`FBSDKLoginManagerLoginResult`	Describes the result of a login attempt
`FBSDKLoginTooltipView`	Represents a tooltip to be displayed next to a Facebook login button to highlight features for new users
`FBSDKTooltipView`	Tooltip bubble with text in it used to display tips for UI elements, with a pointed arrow (to refer to the UI element)

Name	Description
`FBSDKLoginButtonDelegate`	A delegate for FBSDKLoginButton
`FBSDKLoginTooltipViewDelegate`	The FBSDKLoginTooltipViewDelegate protocol defines the methods used to receive event notifications from FBSDKLoginTooltipView objects

Name	Description
`FBSDKLoginConstants`

Share Kit Classes

Name	Description
`FBSDKAppGroupContent`	A model for creating an app group
`FBSDKAppInviteContent`	A model for app invite
`FBSDKAppInviteDialog`	A dialog for sending App Invites
`FBSDKGameRequestContent`	A model for a game request
`FBSDKGameRequestDialog`	A dialog for sending game requests
`FBSDKHashtag`	Represents a single hashtag that can be used with the share dialog
`FBSDKLikeButton`	A button to like an object
`FBSDKLikeControl`	UI control to like an object in the Facebook graph
`FBSDKMessageDialog`	A dialog for sharing content through Messenger
`FBSDKSendButton`	A button to send content through Messenger
`FBSDKShareAPI`	A utility class for sharing through the graph API
`FBSDKShareButton`	A button to share content
`FBSDKShareDialog`	A dialog for sharing content on Facebook
`FBSDKShareLinkContent`	A model for status and link content to be shared
`FBSDKShareMediaContent`	A model for media content (photo or video) to be shared
`FBSDKShareOpenGraphAction`	An Open Graph Action for sharing
`FBSDKShareOpenGraphContent`	A model for Open Graph content to be shared
`FBSDKShareOpenGraphObject`	An Open Graph Object for sharing
`FBSDKShareOpenGraphValueContainer`	A base class to container Open Graph values
`FBSDKSharePhoto`	A photo for sharing
`FBSDKSharePhotoContent`	A model for photo content to be shared
`FBSDKShareVideo`	A video for sharing
`FBSDKShareVideoContent`	A model for video content to be shared

Share Kit Protocols

Name	Description
`FBSDKAppGroupAddDialogDelegate`
`FBSDKAppGroupJoinDialogDelegate`
`FBSDKAppInviteDialogDelegate`	A delegate for FBSDKAppInviteDialog
`FBSDKGameRequestDialogDelegate`	A delegate for FBSDKGameRequestDialog
`FBSDKLiking`	The common interface for components that initiate liking
`FBSDKShareOpenGraphValueContaining`	Protocol defining operations on open graph actions and objects
`FBSDKSharing`	The common interface for components that initiate sharing
`FBSDKSharingButton`	The common interface for sharing buttons
`FBSDKSharingContent`	A base interface for content to be shared
`FBSDKSharingDelegate`	A delegate for FBSDKSharing
`FBSDKSharingDialog`	The common interface for dialogs that initiate sharing

Share Kit Categories

Name	Description
`FBSDKAppGroupAddDialog`
`FBSDKAppGroupJoinDialog`

Share Kit Other

Name	Description
`FBSDKLikeObjectType`
`FBSDKShareConstants`
`FBSDKShareDialogMode`

Audience Network Classes

Name	Description
`FBAdChoicesView`	FBAdChoicesView offers a simple way to display a sponsored or AdChoices icon
`FBAdImage`	Represents an image creative
`FBAdSettings`	AdSettings contains global settings for all ad controls
`FBAdStarRating`	Represents the Facebook ad star rating, which contains the rating value and rating scale
`FBAdStarRatingView`	Helper view that draws a star rating based off a native ad
`FBAdView`	A customized UIView to represent a Facebook ad (a
`FBInterstitialAd`	A modal view controller to represent a Facebook interstitial ad
`FBMediaView`	The FBMediaView loads media content from a given FBNativeAd
`FBNativeAd`	The FBNativeAd represents ad metadata to allow you to construct custom ad views
`FBNativeAdCollectionViewAdProvider`	Additional functionality on top of FBNativeAdsManager to assist in using native ads within a UICollectionView
`FBNativeAdCollectionViewCellProvider`	Class which assists in putting FBNativeAdViews into UICollectionViews
`FBNativeAdScrollView`	Contains multiple ads in a scroll view
`FBNativeAdsManager`	This class provides a mechanism to fetch a set of ads and then use them within your application
`FBNativeAdTableViewAdProvider`	Additional functionality on top of FBNativeAdsManager to assist in using native ads within a UITableView
`FBNativeAdTableViewCellProvider`	Class which assists in putting FBNativeAdViews into UITableViews
`FBNativeAdView`	The FBNativeAdView creates prebuilt native ad template views and manages native ads
`FBNativeAdViewAttributes`	Describes the look and feel of a native ad view
`FBRewardedVideoAd`	A modal view controller to represent a Facebook rewarded video ad

Audience Network Protocols

Name	Description
`FBAdViewDelegate`	The methods declared by the FBAdViewDelegate protocol allow the adopting delegate to respond to messages from the FBAdView class and thus respond to operations such as whether the ad has been loaded, the person has clicked the ad
`FBInterstitialAdDelegate`	The methods declared by the FBInterstitialAdDelegate protocol allow the adopting delegate to respond to messages from the FBInterstitialAd class and thus respond to operations such as whether the interstitial ad has been loaded, user has clicked or closed the interstitial
`FBMediaViewDelegate`	The methods declared by the FBMediaViewDelegate protocol allow the adopting delegate to respond to messages from the FBMediaView class and thus respond to operations such as whether the media content has been loaded
`FBNativeAdDelegate`	The methods declared by the FBNativeAdDelegate protocol allow the adopting delegate to respond to messages from the FBNativeAd class and thus respond to operations such as whether the native ad has been loaded
`FBNativeAdsManagerDelegate`	Messages from FBNativeAdsManager indicating success or failure loading ads
`FBRewardedVideoAdDelegate`	The methods declared by the FBRewardedVideoAdDelegate protocol allow the adopting delegate to respond to messages from the FBRewardedVideoAd class and thus respond to operations such as whether the ad has been loaded, the person has clicked the ad or closed video/end card

Audience Network Other

Name	Description
`FBAdSize`

Messenger Share Kit Classes

Name	Description
`FBSDKMessengerBroadcastContext`	This object is used as an override in FBSDKMessengerShareOptions to ensure the broadcast flow in Messenger is triggered, even if your app was entered from a flow that normally triggers the Messenger reply flow
`FBSDKMessengerContext`	This represents the way that content is shared between Messenger and partner apps
`FBSDKMessengerShareButton`	Provides a helper method to return a UIButton intended for sharing to Messenger
`FBSDKMessengerShareOptions`	Optional parameters that change the way content is shared into Messenger
`FBSDKMessengerSharer`	The FBSDKMessengerSharer is used to share media from apps into Messenger
`FBSDKMessengerURLHandler`	FBSDKMessengerURLHandler is used to handle incoming URLs from Messenger
`FBSDKMessengerURLHandlerCancelContext`	This object represents a user canceling out of a share flow in Messenger
`FBSDKMessengerURLHandlerOpenFromComposerContext`	This object represents a user selecting this app from the composer in Messenger Passing this context into a share method will trigger a the reply flow
`FBSDKMessengerURLHandlerReplyContext`	This object represents a user tapping reply from a message in Messenger

Account Kit Classes

Name	Description
`AKFAccountKit`	Primary interface for authenticating AccountKit accounts
`AKFAccountPreferences`	Accesses Account preferences that are stored on the Account Kit servers for the associated app and account
`AKFPhoneNumber`	This class represents a phone number
`AKFSettings`	AccountKit application settings
`AKFTheme`	A theme for the Account Kit UI

Account Kit Protocols

Name	Description
`AKFAccessToken`	The protocol that represents an Access Token
`AKFAccount`	The protocol that represents an Account
`AKFAccountPreferencesDelegate`	The delegate the receives messages from AKFAccountPreferences
`AKFAdvancedUIActionController`	A controller that exposes actions to the AKFAdvancedUIManager
`AKFAdvancedUIManager`	Manager for advanced UI configuration
`AKFAdvancedUIManaging`	Protocol for classes that manage Advanced UI
`AKFConfiguring`	Defines the properties that can be configured for the Account Kit UI
`AKFTheming`	The receiver can be themed
`AKFViewController`	A view controller for Account Kit that reports the status of the login through the delegate
`AKFViewControllerDelegate`	Receives callbacks from the View Controller when the login flow completes

Account Kit Other

Name	Description
`AKFButtonType`
`AKFError`
`AKFErrorDetail`
`AKFLoginFlowState`
`AKFLoginType`
`AKFResponseType`
`AKFTextPosition`

Build a Mobile Site

View Site in Mobile | Classic