| commit | author | age | ||
| bad748 | 1 | // Copyright (c) 2014-present, Facebook, Inc. All rights reserved. |
| W | 2 | // |
| 3 | // You are hereby granted a non-exclusive, worldwide, royalty-free license to use, | |
| 4 | // copy, modify, and distribute this software in source code or binary form for use | |
| 5 | // in connection with the web services and APIs provided by Facebook. | |
| 6 | // | |
| 7 | // As with any software that integrates with the Facebook platform, your use of | |
| 8 | // this software is subject to the Facebook Developer Principles and Policies | |
| 9 | // [http://developers.facebook.com/policy/]. This copyright notice shall be | |
| 10 | // included in all copies or substantial portions of the software. | |
| 11 | // | |
| 12 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| 13 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS | |
| 14 | // FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | |
| 15 | // COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER | |
| 16 | // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | |
| 17 | // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | |
| 18 | ||
| 19 | #import <UIKit/UIKit.h> | |
| 20 | ||
| 21 | #import <FBSDKCoreKit/FBSDKCopying.h> | |
| 22 | ||
| 23 | /*! | |
| 24 | @abstract A photo for sharing. | |
| 25 | */ | |
| 26 | @interface FBSDKSharePhoto : NSObject <FBSDKCopying, NSSecureCoding> | |
| 27 | ||
| 28 | /*! | |
| 29 | @abstract Convenience method to build a new photo object with an image. | |
| 30 | @param image If the photo is resident in memory, this method supplies the data | |
| 31 | @param userGenerated Specifies whether the photo represented by the receiver was generated by the user or by the | |
| 32 | application | |
| 33 | */ | |
| 34 | + (instancetype)photoWithImage:(UIImage *)image userGenerated:(BOOL)userGenerated; | |
| 35 | ||
| 36 | /*! | |
| 37 | @abstract Convenience method to build a new photo object with an imageURL. | |
| 38 | @param imageURL The URL to the photo | |
| 39 | @param userGenerated Specifies whether the photo represented by the receiver was generated by the user or by the | |
| 40 | application | |
| 41 | @discussion This method should only be used when adding photo content to open graph stories. | |
| 42 | For example, if you're trying to share a photo from the web by itself, download the image and use | |
| 43 | `photoWithImage:userGenerated:` instead. | |
| 44 | */ | |
| 45 | + (instancetype)photoWithImageURL:(NSURL *)imageURL userGenerated:(BOOL)userGenerated; | |
| 46 | ||
| 47 | /*! | |
| 48 | @abstract If the photo is resident in memory, this method supplies the data. | |
| 49 | @return UIImage representation of the photo | |
| 50 | */ | |
| 51 | @property (nonatomic, strong) UIImage *image; | |
| 52 | ||
| 53 | /*! | |
| 54 | @abstract The URL to the photo. | |
| 55 | @return URL that points to a network location or the location of the photo on disk | |
| 56 | */ | |
| 57 | @property (nonatomic, copy) NSURL *imageURL; | |
| 58 | ||
| 59 | /*! | |
| 60 | @abstract Specifies whether the photo represented by the receiver was generated by the user or by the application. | |
| 61 | @return YES if the photo is user-generated, otherwise NO | |
| 62 | */ | |
| 63 | @property (nonatomic, assign, getter=isUserGenerated) BOOL userGenerated; | |
| 64 | ||
| 65 | /*! | |
| 66 | @abstract Compares the receiver to another photo. | |
| 67 | @param photo The other photo | |
| 68 | @return YES if the receiver's values are equal to the other photo's values; otherwise NO | |
| 69 | */ | |
| 70 | - (BOOL)isEqualToSharePhoto:(FBSDKSharePhoto *)photo; | |
| 71 | ||
| 72 | /*! | |
| 73 | @abstract The user generated caption for the photo. Note that the 'caption' must come from | |
| 74 | * the user, as pre-filled content is forbidden by the Platform Policies (2.3). | |
| 75 | @return the Photo's caption if exists else returns null. | |
| 76 | */ | |
| 77 | @property (nonatomic, copy) NSString *caption; | |
| 78 | ||
| 79 | ||
| 80 | @end | |
