SFBAttachedPicture


@interface SFBAttachedPicture : NSObject <NSCopying>

A class encapsulating a single attached picture.

Most file formats may have more than one attached picture of each type.

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    + (instancetype)new NS_UNAVAILABLE;

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Returns an initialized \c SFBAttachedPicture object

    Declaration

    Objective-C

    - (nonnull instancetype)initWithImageData:(nonnull NSData *)imageData;

    Parameters

    imageData

    The raw image data

  • Returns an initialized \c SFBAttachedPicture object

    Declaration

    Objective-C

    - (nonnull instancetype)initWithImageData:(nonnull NSData *)imageData
                                     type:(SFBAttachedPictureType)type;

    Parameters

    imageData

    The raw image data
    type

    The artwork type

  • Returns an initialized \c SFBAttachedPicture object

    Declaration

    Objective-C

    - (nonnull instancetype)initWithImageData:(nonnull NSData *)imageData
                                     type:(SFBAttachedPictureType)type
                              description:(nullable NSString *)description;

    Parameters

    imageData

    The raw image data
    type

    The artwork type
    description

    The image description

  • Returns an initialized \c SFBAttachedPicture object or \c nil on error

    Returns \c nil if \c dictionaryRepresentation does not contain image data

    Declaration

    Objective-C

    - (nullable instancetype)initWithDictionaryRepresentation:
    (nonnull NSDictionary<SFBAttachedPictureKey, id> *)dictionaryRepresentation;

    Parameters

    dictionaryRepresentation

    A dictionary containing the desired values

  • Copy the values contained in this object to a dictionary

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSDictionary<SFBAttachedPictureKey, id> *_Nonnull dictionaryRepresentation;

    Return Value

    A dictionary containing this object’s artwork information

  • The raw image data

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSData *_Nonnull imageData;

  • The artwork type

    Declaration

    Objective-C

    @property (nonatomic, readonly) SFBAttachedPictureType pictureType;

  • The artwork description

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *pictureDescription;