FBSDKSharePhoto - Documentation - Meta for Developers

FBSDKSharePhoto

A more recent version of this class is available. Check out the latest version.

A photo for sharing.

Conforms to:	`FBSDKCopying, NSSecureCoding`
Superclass:	`NSObject`
Declared in:	`FBSDKSharePhoto.h`

Properties

caption

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).

@property (nonatomic,
    copy) NSString *caption;

Declared In: FBSDKSharePhoto.h

image

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

@property (nonatomic,
    strong) UIImage *image;

Declared In: FBSDKSharePhoto.h

imageURL

The URL to the photo.

@property (nonatomic,
    copy) NSURL *imageURL;

Declared In: FBSDKSharePhoto.h

userGenerated

Specifies whether the photo represented by the receiver was generated by the user or by the application.

@property (nonatomic,
    assign,
    getter=isUserGenerated) BOOL userGenerated;

Declared In: FBSDKSharePhoto.h

Class Methods

photoWithImage:userGenerated:

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

Parameter	Description
`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)

`photoWithImage:`	`(UIImage *)image`
`userGenerated:`	`(BOOL)userGenerated;`

Declared In: FBSDKSharePhoto.h

photoWithImageURL:userGenerated:

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

Parameter	Description
`imageURL`	The URL to the photo
`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;`

Discussion:

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.

Declared In: FBSDKSharePhoto.h

Instance Methods

isEqualToSharePhoto:

Compares the receiver to another photo.

Parameter	Description
`photo`	The other photo

- (BOOL) isEqualToSharePhoto:(FBSDKSharePhoto *)photo;

Declared In: FBSDKSharePhoto.h