Swift SDK Version

UserProfile

publicstructUserProfile

Represents an immutable Facebook profile.

This class provides a global current instance to more easily add social context to your application. When the profile changes, a notification is posted so that you can update relevant parts of your UI and is persisted to NSUserDefaults.

Typically, you will want to call Profile.updatesOnAccessTokenChange = true, so that it automatically observes changes to the AccessToken.current.

You can use this class to build your own ProfilePictureView or in place of typical requests to /me.

userId
The user id.
Declaration
Swift
publicletuserId:String
Show on GitHub
firstName
The user’s first name.
Declaration
Swift
publicletfirstName:String?
Show on GitHub
middleName
The user’s middle name.
Declaration
Swift
publicletmiddleName:String?
Show on GitHub
lastName
The user’s last name.
Declaration
Swift
publicletlastName:String?
Show on GitHub
fullName
The user’s complete name.
Declaration
Swift
publicletfullName:String?
Show on GitHub
profileURL
A URL to the user’s profile.
Declaration
Swift
publicletprofileURL:URL?
Show on GitHub
refreshDate
The last time the profile was refreshed.
Declaration
Swift
publicletrefreshDate:Date
Show on GitHub

init(userId:firstName:middleName:lastName:fullName:profileURL:refreshDate:)

Creates a new instance of Profile.

Declaration

Swift

publicinit(userId:String,firstName:String?=nil,middleName:String?=nil,lastName:String?=nil,fullName:String?=nil,profileURL:URL?=nil,refreshDate:Date=Date())

Parameters

`userId`	The user id.
`firstName`	Optional user’s first name.
`middleName`	Optional user’s middle name.
`lastName`	Optional user’s last name.
`fullName`	Optional user’s full name.
`profileURL`	Optional user’s profile URL.
`refreshDate`	Optional user’s last refresh date. Default: `NSDate()` aka current date/time.

Show on GitHub

FetchResult
Describes the result of a fetch of UserProfile.
See more
Declaration
Swift
publicenumFetchResult
Show on GitHub

PictureView
A view to display a profile picture.
See more
Declaration
Swift
publicfinalclassPictureView:UIView
Show on GitHub

Loading Profile

Completion
Convenience alias for type of closure that is used as a completion for fetching UserProfile.
Declaration
Swift
publictypealiasCompletion=(FetchResult)->Void
Show on GitHub
fetch(userId:completion:)
Fetches a user profile by userId.
If the current profile is set, and it has the same userId, calling method will reset the current profile with the newly fetched one.
Declaration
Swift
publicstaticfuncfetch(userId:String,completion:@escapingCompletion)
Parameters
userId
Facebook user id of the profile to fetch.
completion
The closure to be executed once the profile is refreshed.
Show on GitHub
refresh(_:)
Refreshes the existing user profile.
If the current profile is set, and receiver has the same userId, calling method will reset the current profile with the newly fetched one.
Declaration
Swift
publicfuncrefresh(_completion:Completion?)
Parameters
completion
Optional closure to be executed once the profile is refreshed. Default: nil.
Show on GitHub

Current Profile

current
Current instance of Profile that represents the currently logged in user’s profile.
Declaration
Swift
publicstaticvarcurrent:UserProfile?{getset}
Show on GitHub
loadCurrent(_:)
Loads the current profile and passes it to the completion closure.
If the current profile is already loaded, this method will call the completion block synchronously, otherwise it will begin a graph request to update current profile and the call the completion closure when finished.
Declaration
Swift
publicstaticfuncloadCurrent(_completion:Completion?)
Parameters
completion
The closure to be executed once the profile is loaded.
Show on GitHub
updatesOnAccessTokenChange
Allows controlling whether current profile should automatically update when AccessToken.current changes.
Note
If AccessToken.current is unset (changes to nil), the current profile instance remains. It’s also possible for the current to return nil until the data is fetched.
Declaration
Swift
publicstaticvarupdatesOnAccessTokenChange:Bool{getset}
Show on GitHub

Profile Picture

PictureAspectRatio
Defines the aspect ratio for the source image of the profile picture.
See more
Declaration
Swift
publicenumPictureAspectRatio
Show on GitHub
imageURLWith(_:size:)
Returns a complete NSURL for retrieving the user’s profile image.
Declaration
Swift
publicfuncimageURLWith(_aspectRatio:PictureAspectRatio,size:CGSize)->URL
Parameters
aspectRatio
Apsect ratio of the source image to use.
size
Requested height and width of the image. Will be rounded to integer precision.
Show on GitHub

`userId`	Facebook user id of the profile to fetch.
`completion`	The closure to be executed once the profile is refreshed.

`aspectRatio`	Apsect ratio of the source image to use.
`size`	Requested height and width of the image. Will be rounded to integer precision.