// Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
|
//
|
// You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
|
// copy, modify, and distribute this software in source code or binary form for use
|
// in connection with the web services and APIs provided by Facebook.
|
//
|
// As with any software that integrates with the Facebook platform, your use of
|
// this software is subject to the Facebook Developer Principles and Policies
|
// [http://developers.facebook.com/policy/]. This copyright notice shall be
|
// included in all copies or substantial portions of the software.
|
//
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
// 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.
|
|
#import <UIKit/UIKit.h>
|
|
#import <FBSDKCoreKit/FBSDKCopying.h>
|
|
/**
|
A photo for sharing.
|
*/
|
@interface FBSDKSharePhoto : NSObject <FBSDKCopying, 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
|
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
|
application
|
|
This method should only be used when adding photo content to open graph stories.
|
For example, if you're trying to share a photo from the web by itself, download the image and use
|
`photoWithImage:userGenerated:` instead.
|
*/
|
+ (instancetype)photoWithImageURL:(NSURL *)imageURL userGenerated:(BOOL)userGenerated;
|
|
/**
|
If the photo is resident in memory, this method supplies the data.
|
- Returns: 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
|
*/
|
@property (nonatomic, copy) NSURL *imageURL;
|
|
/**
|
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
|
*/
|
@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
|
*/
|
- (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.
|
*/
|
@property (nonatomic, copy) NSString *caption;
|
|
|
@end
|
