WAFbImpl.git - Gitblit

			@@ -14,32 +14,71 @@
			// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
			// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
			// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
			// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
			// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."

			#import "FBSDKMacros.h"
			#import "TargetConditionals.h"

			#if !TARGET_OS_TV

			#import "FBSDKProfilePictureView.h"

			/*!
			@abstract Notification indicating that the `currentProfile` has changed.
			@discussion the userInfo dictionary of the notification will contain keys
			@class FBSDKProfile;

			NS_ASSUME_NONNULL_BEGIN

			#if __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_10_0

			/**
			Notification indicating that the `currentProfile` has changed.

			the userInfo dictionary of the notification will contain keys
			`FBSDKProfileChangeOldKey` and
			`FBSDKProfileChangeNewKey`.
			*/
			FBSDK_EXTERN NSString *const FBSDKProfileDidChangeNotification;
			FOUNDATION_EXPORT NSNotificationName const FBSDKProfileDidChangeNotification
			NS_SWIFT_NAME(ProfileDidChange);

			/* @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.
			#else

			/**
			Notification indicating that the `currentProfile` has changed.

			the userInfo dictionary of the notification will contain keys
			`FBSDKProfileChangeOldKey` and
			`FBSDKProfileChangeNewKey`.
			*/
			FBSDK_EXTERN NSString *const FBSDKProfileChangeOldKey;
			FOUNDATION_EXPORT NSString *const FBSDKProfileDidChangeNotification
			NS_SWIFT_NAME(ProfileDidChangeNotification);

			/* @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.
			#endif

			/* 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 FBSDKProfileChangeNewKey;
			FOUNDATION_EXPORT NSString *const FBSDKProfileChangeOldKey
			NS_SWIFT_NAME(ProfileChangeOldKey);

			/*!
			@abstract Represents an immutable Facebook profile
			@discussion This class provides a global "currentProfile" instance to more easily
			/* key in notification's userInfo object for getting the new profile.

			If there is no new profile, the key will not be present.
			*/
			FOUNDATION_EXPORT NSString *const FBSDKProfileChangeNewKey
			NS_SWIFT_NAME(ProfileChangeNewKey);

			/**
			Describes the callback for loadCurrentProfileWithCompletion.
			@param profile the FBSDKProfile
			@param error the error during the request, if any

			*/
			typedef void (^FBSDKProfileBlock)(FBSDKProfile _Nullable profile, NSError _Nullable error)
			NS_SWIFT_NAME(ProfileBlock);

			/**
			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.

			@@ -48,10 +87,14 @@

			You can use this class to build your own `FBSDKProfilePictureView` or in place of typical requests to "/me".
			*/
			NS_SWIFT_NAME(Profile)
			@interface FBSDKProfile : NSObject<NSCopying, NSSecureCoding>

			/*!
			@abstract initializes a new instance.
			- (instancetype)init NS_UNAVAILABLE;
			+ (instancetype)new NS_UNAVAILABLE;

			/**
			initializes a new instance.
			@param userID the user ID
			@param firstName the user's first name
			@param middleName the user's middle name
			@@ -61,96 +104,94 @@
			@param refreshDate the optional date this profile was fetched. Defaults to [NSDate date].
			*/
			- (instancetype)initWithUserID:(NSString *)userID
			firstName:(NSString *)firstName
			middleName:(NSString *)middleName
			lastName:(NSString *)lastName
			name:(NSString *)name
			linkURL:(NSURL *)linkURL
			refreshDate:(NSDate *)refreshDate NS_DESIGNATED_INITIALIZER;
			/*!
			@abstract The user id
			firstName:(nullable NSString *)firstName
			middleName:(nullable NSString *)middleName
			lastName:(nullable NSString *)lastName
			name:(nullable NSString *)name
			linkURL:(nullable NSURL *)linkURL
			refreshDate:(nullable NSDate *)refreshDate NS_DESIGNATED_INITIALIZER;

			/**
			The current profile instance and posts the appropriate notification
			if the profile parameter is different than the receiver.

			This persists the profile to NSUserDefaults.
			*/
			@property (nonatomic, readonly) NSString *userID;
			/*!
			@abstract The user's first name

			/// The current profile
			@property (class, nonatomic, strong, nullable) FBSDKProfile *currentProfile
			NS_SWIFT_NAME(current);

			/**
			The user id
			*/
			@property (nonatomic, readonly) NSString *firstName;
			/*!
			@abstract The user's middle name
			@property (nonatomic, copy, readonly) NSString *userID;
			/**
			The user's first name
			*/
			@property (nonatomic, readonly) NSString *middleName;
			/*!
			@abstract The user's last name
			@property (nonatomic, copy, readonly, nullable) NSString *firstName;
			/**
			The user's middle name
			*/
			@property (nonatomic, readonly) NSString *lastName;
			/*!
			@abstract The user's complete name
			@property (nonatomic, copy, readonly, nullable) NSString *middleName;
			/**
			The user's last 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, nullable) NSString *lastName;
			/**
			The user's complete name
			*/
			@property (nonatomic, copy, readonly, nullable) NSString *name;
			/**
			A URL to the user's profile.

			Consider using `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;
			@property (nonatomic, readonly, nullable) 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.
			*/
			+ (FBSDKProfile *)currentProfile;

			/*!
			@abstract 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.
			*/
			+ (void)setCurrentProfile:(FBSDKProfile *)profile;

			/*!
			@abstract Indicates if `currentProfile` will automatically observe `FBSDKAccessTokenDidChangeNotification` notifications
			/**
			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

			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
			for `currentProfile` to return nil until the data is fetched.
			*/
			+ (void)enableUpdatesOnAccessTokenChange:(BOOL)enable;
			+ (void)enableUpdatesOnAccessTokenChange:(BOOL)enable
			NS_SWIFT_NAME(enableUpdatesOnAccessTokenChange(_:));

			/*!
			@abstract Loads the current profile and passes it to the completion block.
			/**
			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

			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;
			+ (void)loadCurrentProfileWithCompletion:(nullable FBSDKProfileBlock)completion;

			/*!
			@abstract A convenience method for returning a complete `NSURL` for retrieving the user's profile image.
			/**
			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.
			*/
			- (NSURL *)imageURLForPictureMode:(FBSDKProfilePictureMode)mode size:(CGSize)size;
			- (nullable NSURL *)imageURLForPictureMode:(FBSDKProfilePictureMode)mode size:(CGSize)size
			NS_SWIFT_NAME(imageURL(forMode: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.
			*/
			- (NSString *)imagePathForPictureMode:(FBSDKProfilePictureMode)mode size:(CGSize)size
			__attribute__ ((deprecated("use imageURLForPictureMode:size: instead")));

			/*!
			@abstract Returns YES if the profile is equivalent to the receiver.
			/**
			Returns YES if the profile is equivalent to the receiver.
			@param profile the profile to compare to.
			*/
			- (BOOL)isEqualToProfile:(FBSDKProfile *)profile;
			@end

			NS_ASSUME_NONNULL_END

			#endif