| | |
| | | #import <UIKit/UIKit.h> |
| | | |
| | | #import <FBSDKCoreKit/FBSDKCopying.h> |
| | | #import <FBSDKShareKit/FBSDKSharingValidation.h> |
| | | |
| | | @class PHAsset; |
| | | |
| | | /** |
| | | A photo for sharing. |
| | | */ |
| | | @interface FBSDKSharePhoto : NSObject <FBSDKCopying, NSSecureCoding> |
| | | @interface FBSDKSharePhoto : NSObject <FBSDKCopying, FBSDKSharingValidation, NSSecureCoding> |
| | | |
| | | /** |
| | | Convenience method to build a new photo object with an image. |
| | | - Parameter image: If the photo is resident in memory, this method supplies the data |
| | | - Parameter userGenerated: Specifies whether the photo represented by the receiver was generated by the user or by the |
| | | @param image If the photo is resident in memory, this method supplies the data |
| | | @param userGenerated Specifies whether the photo represented by the receiver was generated by the user or by the |
| | | application |
| | | */ |
| | | + (instancetype)photoWithImage:(UIImage *)image userGenerated:(BOOL)userGenerated; |
| | | |
| | | /** |
| | | Convenience method to build a new photo object with an imageURL. |
| | | - Parameter imageURL: The URL to the photo |
| | | - Parameter userGenerated: Specifies whether the photo represented by the receiver was generated by the user or by the |
| | | @param imageURL The URL to the photo |
| | | @param userGenerated Specifies whether the photo represented by the receiver was generated by the user or by the |
| | | application |
| | | |
| | | This method should only be used when adding photo content to open graph stories. |
| | |
| | | + (instancetype)photoWithImageURL:(NSURL *)imageURL userGenerated:(BOOL)userGenerated; |
| | | |
| | | /** |
| | | Convenience method to build a new photo object with a PHAsset. |
| | | - Parameter photoAsset: The PHAsset that represents the photo in the Photos library. |
| | | - Parameter userGenerated: Specifies whether the photo represented by the receiver was generated by the user or by the |
| | | application |
| | | */ |
| | | + (instancetype)photoWithPhotoAsset:(PHAsset *)photoAsset userGenerated:(BOOL)userGenerated; |
| | | |
| | | /** |
| | | If the photo is resident in memory, this method supplies the data. |
| | | - Returns: UIImage representation of the photo |
| | | @return UIImage representation of the photo |
| | | */ |
| | | @property (nonatomic, strong) UIImage *image; |
| | | |
| | | /** |
| | | The URL to the photo. |
| | | - Returns: URL that points to a network location or the location of the photo on disk |
| | | @return URL that points to a network location or the location of the photo on disk |
| | | */ |
| | | @property (nonatomic, copy) NSURL *imageURL; |
| | | |
| | | /** |
| | | The representation of the photo in the Photos library. |
| | | - Returns: PHAsset that represents the photo in the Photos library. |
| | | */ |
| | | @property (nonatomic, copy) PHAsset *photoAsset; |
| | | |
| | | /** |
| | | Specifies whether the photo represented by the receiver was generated by the user or by the application. |
| | | - Returns: YES if the photo is user-generated, otherwise NO |
| | | @return YES if the photo is user-generated, otherwise NO |
| | | */ |
| | | @property (nonatomic, assign, getter=isUserGenerated) BOOL userGenerated; |
| | | |
| | | /** |
| | | Compares the receiver to another photo. |
| | | - Parameter photo: The other photo |
| | | - Returns: YES if the receiver's values are equal to the other photo's values; otherwise NO |
| | | @param photo The other photo |
| | | @return YES if the receiver's values are equal to the other photo's values; otherwise NO |
| | | */ |
| | | - (BOOL)isEqualToSharePhoto:(FBSDKSharePhoto *)photo; |
| | | |
| | | /** |
| | | The user generated caption for the photo. Note that the 'caption' must come from |
| | | * the user, as pre-filled content is forbidden by the Platform Policies (2.3). |
| | | - Returns: the Photo's caption if exists else returns null. |
| | | @return the Photo's caption if exists else returns null. |
| | | */ |
| | | @property (nonatomic, copy) NSString *caption; |
| | | |