FBSDKSharePhoto Class Reference

#import <FBSDKSharePhoto.h>

Inheritance diagram for FBSDKSharePhoto:

Instance Methods
(BOOL)	- isEqualToSharePhoto:
Instance Methods inherited from <FBSDKCopying>
(id)	- copy

Class Methods
(instancetype)	+ photoWithImage:userGenerated:
(instancetype)	+ photoWithImageURL:userGenerated:

Properties
UIImage *	image
NSURL *	imageURL
BOOL	userGenerated
NSString *	caption

Detailed Description

A photo for sharing.

Method Documentation

- (BOOL) isEqualToSharePhoto:

(FBSDKSharePhoto *)

photo

Compares the receiver to another photo.

Parameters

photo

The other photo

Returns

YES if the receiver's values are equal to the other photo's values; otherwise NO

+ (instancetype) photoWithImage:		(UIImage *)	image
userGenerated:		(BOOL)	userGenerated

Convenience method to build a new photo object with an image.

Parameters

image	If the photo is resident in memory, this method supplies the data
userGenerated	Specifies whether the photo represented by the receiver was generated by the user or by the application

+ (instancetype) photoWithImageURL:		(NSURL *)	imageURL
userGenerated:		(BOOL)	userGenerated

Convenience method to build a new photo object with an imageURL.

Parameters

imageURL	The URL to the photo
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.

Property Documentation

- (NSString*) caption

readwritenonatomiccopy

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.

- (UIImage*) image

readwritenonatomicstrong

If the photo is resident in memory, this method supplies the data.

Returns

UIImage representation of the photo

- (NSURL*) imageURL

readwritenonatomiccopy

The URL to the photo.

Returns

URL that points to a network location or the location of the photo on disk

- (BOOL) userGenerated

readwritenonatomicassign

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

---

The documentation for this class was generated from the following file:

• Frameworks/FBSDKShareKit.framework/Headers/FBSDKSharePhoto.h