| | |
| | | #import "FBSDKMacros.h" |
| | | #import "FBSDKProfilePictureView.h" |
| | | |
| | | /*! |
| | | @abstract Notification indicating that the `currentProfile` has changed. |
| | | @discussion the userInfo dictionary of the notification will contain keys |
| | | /** |
| | | Notification indicating that the `currentProfile` has changed. |
| | | |
| | | the userInfo dictionary of the notification will contain keys |
| | | `FBSDKProfileChangeOldKey` and |
| | | `FBSDKProfileChangeNewKey`. |
| | | */ |
| | | FBSDK_EXTERN NSString *const FBSDKProfileDidChangeNotification; |
| | | |
| | | /* @abstract key in notification's userInfo object for getting the old profile. |
| | | @discussion If there was no old profile, the key will not be present. |
| | | /* key in notification's userInfo object for getting the old profile. |
| | | |
| | | If there was no old profile, the key will not be present. |
| | | */ |
| | | FBSDK_EXTERN NSString *const FBSDKProfileChangeOldKey; |
| | | |
| | | /* @abstract key in notification's userInfo object for getting the new profile. |
| | | @discussion If there is no new profile, the key will not be present. |
| | | /* key in notification's userInfo object for getting the new profile. |
| | | |
| | | If there is no new profile, the key will not be present. |
| | | */ |
| | | FBSDK_EXTERN NSString *const FBSDKProfileChangeNewKey; |
| | | |
| | | /*! |
| | | @abstract Represents an immutable Facebook profile |
| | | @discussion This class provides a global "currentProfile" instance to more easily |
| | | /** |
| | | Represents an immutable Facebook profile |
| | | |
| | | This class provides a global "currentProfile" 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. |
| | | |
| | |
| | | */ |
| | | @interface FBSDKProfile : NSObject<NSCopying, NSSecureCoding> |
| | | |
| | | /*! |
| | | @abstract initializes a new instance. |
| | | @param userID the user ID |
| | | @param firstName the user's first name |
| | | @param middleName the user's middle name |
| | | @param lastName the user's last name |
| | | @param name the user's complete name |
| | | @param linkURL the link for this profile |
| | | @param refreshDate the optional date this profile was fetched. Defaults to [NSDate date]. |
| | | /** |
| | | initializes a new instance. |
| | | - Parameter userID: the user ID |
| | | - Parameter firstName: the user's first name |
| | | - Parameter middleName: the user's middle name |
| | | - Parameter lastName: the user's last name |
| | | - Parameter name: the user's complete name |
| | | - Parameter linkURL: the link for this profile |
| | | - Parameter refreshDate: the optional date this profile was fetched. Defaults to [NSDate date]. |
| | | */ |
| | | - (instancetype)initWithUserID:(NSString *)userID |
| | | firstName:(NSString *)firstName |
| | |
| | | name:(NSString *)name |
| | | linkURL:(NSURL *)linkURL |
| | | refreshDate:(NSDate *)refreshDate NS_DESIGNATED_INITIALIZER; |
| | | /*! |
| | | @abstract The user id |
| | | /** |
| | | The user id |
| | | */ |
| | | @property (nonatomic, readonly) NSString *userID; |
| | | /*! |
| | | @abstract The user's first name |
| | | @property (nonatomic, copy, readonly) NSString *userID; |
| | | /** |
| | | The user's first name |
| | | */ |
| | | @property (nonatomic, readonly) NSString *firstName; |
| | | /*! |
| | | @abstract The user's middle name |
| | | @property (nonatomic, copy, readonly) NSString *firstName; |
| | | /** |
| | | The user's middle name |
| | | */ |
| | | @property (nonatomic, readonly) NSString *middleName; |
| | | /*! |
| | | @abstract The user's last name |
| | | @property (nonatomic, copy, readonly) NSString *middleName; |
| | | /** |
| | | The user's last name |
| | | */ |
| | | @property (nonatomic, readonly) NSString *lastName; |
| | | /*! |
| | | @abstract The user's complete name |
| | | @property (nonatomic, copy, readonly) NSString *lastName; |
| | | /** |
| | | The user's complete name |
| | | */ |
| | | @property (nonatomic, readonly) NSString *name; |
| | | /*! |
| | | @abstract A URL to the user's profile. |
| | | @discussion Consider using Bolts and `FBSDKAppLinkResolver` to resolve this |
| | | @property (nonatomic, copy, readonly) NSString *name; |
| | | /** |
| | | A URL to the user's profile. |
| | | |
| | | Consider using Bolts and `FBSDKAppLinkResolver` to resolve this |
| | | to an app link to link directly to the user's profile in the Facebook app. |
| | | */ |
| | | @property (nonatomic, readonly) NSURL *linkURL; |
| | | |
| | | /*! |
| | | @abstract The last time the profile data was fetched. |
| | | /** |
| | | The last time the profile data was fetched. |
| | | */ |
| | | @property (nonatomic, readonly) NSDate *refreshDate; |
| | | |
| | | /*! |
| | | @abstract Gets the current FBSDKProfile instance. |
| | | /** |
| | | Gets the current FBSDKProfile instance. |
| | | */ |
| | | + (FBSDKProfile *)currentProfile; |
| | | |
| | | /*! |
| | | @abstract Sets the current instance and posts the appropriate notification if the profile parameter is different |
| | | /** |
| | | Sets the current instance and posts the appropriate notification if the profile parameter is different |
| | | than the receiver. |
| | | @param profile the profile to set |
| | | @discussion This persists the profile to NSUserDefaults. |
| | | - Parameter profile: the profile to set |
| | | |
| | | This persists the profile to NSUserDefaults. |
| | | */ |
| | | + (void)setCurrentProfile:(FBSDKProfile *)profile; |
| | | |
| | | /*! |
| | | @abstract Indicates if `currentProfile` will automatically observe `FBSDKAccessTokenDidChangeNotification` notifications |
| | | @param enable YES is observing |
| | | @discussion If observing, this class will issue a graph request for public profile data when the current token's userID |
| | | /** |
| | | Indicates if `currentProfile` will automatically observe `FBSDKAccessTokenDidChangeNotification` notifications |
| | | - Parameter enable: YES is observing |
| | | |
| | | If observing, this class will issue a graph request for public profile data when the current token's userID |
| | | differs from the current profile. You can observe `FBSDKProfileDidChangeNotification` for when the profile is updated. |
| | | |
| | | Note that if `[FBSDKAccessToken currentAccessToken]` is unset, the `currentProfile` instance remains. It's also possible |
| | |
| | | */ |
| | | + (void)enableUpdatesOnAccessTokenChange:(BOOL)enable; |
| | | |
| | | /*! |
| | | @abstract Loads the current profile and passes it to the completion block. |
| | | @param completion The block to be executed once the profile is loaded |
| | | @discussion If the profile is already loaded, this method will call the completion block synchronously, otherwise it |
| | | /** |
| | | Loads the current profile and passes it to the completion block. |
| | | - Parameter completion: The block to be executed once the profile is loaded |
| | | |
| | | If the profile is already loaded, this method will call the completion block synchronously, otherwise it |
| | | will begin a graph request to update `currentProfile` and then call the completion block when finished. |
| | | */ |
| | | + (void)loadCurrentProfileWithCompletion:(void(^)(FBSDKProfile *profile, NSError *error))completion; |
| | | |
| | | /*! |
| | | @abstract A convenience method for returning a complete `NSURL` for retrieving the user's profile image. |
| | | @param mode The picture mode |
| | | @param size The height and width. This will be rounded to integer precision. |
| | | /** |
| | | A convenience method for returning a complete `NSURL` for retrieving the user's profile image. |
| | | - Parameter mode: The picture mode |
| | | - Parameter size: The height and width. This will be rounded to integer precision. |
| | | */ |
| | | - (NSURL *)imageURLForPictureMode:(FBSDKProfilePictureMode)mode size:(CGSize)size; |
| | | |
| | | /*! |
| | | @abstract A convenience method for returning a Graph API path for retrieving the user's profile image. |
| | | @deprecated use `imageURLForPictureMode:size:` instead |
| | | @discussion You can pass this to a `FBSDKGraphRequest` instance to download the image. |
| | | @param mode The picture mode |
| | | @param size The height and width. This will be rounded to integer precision. |
| | | /** |
| | | A convenience method for returning a Graph API path for retrieving the user's profile image. |
| | | |
| | | - Warning:use `imageURLForPictureMode:size:` instead |
| | | |
| | | You can pass this to a `FBSDKGraphRequest` instance to download the image. |
| | | - Parameter mode: The picture mode |
| | | - Parameter size: The height and width. This will be rounded to integer precision. |
| | | */ |
| | | - (NSString *)imagePathForPictureMode:(FBSDKProfilePictureMode)mode size:(CGSize)size |
| | | __attribute__ ((deprecated("use imageURLForPictureMode:size: instead"))); |
| | | |
| | | /*! |
| | | @abstract Returns YES if the profile is equivalent to the receiver. |
| | | @param profile the profile to compare to. |
| | | /** |
| | | Returns YES if the profile is equivalent to the receiver. |
| | | - Parameter profile: the profile to compare to. |
| | | */ |
| | | - (BOOL)isEqualToProfile:(FBSDKProfile *)profile; |
| | | @end |