PSPDFGalleryManifest


@interface PSPDFGalleryManifest : NSObject

PSPDFGalleryManifest models the manifest file that is the data source of every gallery. It abstracts the task of loading an array of PSPDFGalleryItems from potentially multiple sources.

  • Undocumented

    Declaration

    Objective-C

    
    @interface PSPDFGalleryManifest : NSObject
  • Undocumented

    Declaration

    Objective-C

    
    @interface PSPDFGalleryManifest : NSObject
  • Initializes an PSPDFGalleryManifest with the given annotation. The annotation is required.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithLinkAnnotation:
        (nonnull PSPDFLinkAnnotation *)linkAnnotation;

    Swift

    init(linkAnnotation: PSPDFLinkAnnotation)
  • The link annotation that the manifest was initialized with.

    Declaration

    Objective-C

    @property (readonly, nonatomic) PSPDFLinkAnnotation *_Nonnull linkAnnotation;

    Swift

    var linkAnnotation: PSPDFLinkAnnotation { get }
  • Loads the items from whatever data source the link annotation provides. The completion block will be executed as soon as the load either succeeds or fails.

    Note

    If this method is called while a load is already in progress, the method performs a noop and the completion block will never be called.

    Declaration

    Objective-C

    - (void)loadItemsWithCompletionBlock:
        (nullable PSPDFGalleryManifestCompletionBlock)completionBlock;

    Swift

    func loadItems(completionBlock: PSPDFGalleryManifestCompletionBlock? = nil)
  • Cancels a pending load.

    Declaration

    Objective-C

    - (void)cancel;

    Swift

    func cancel()
  • Indicates if the manifest is currently loading its items.

    Declaration

    Objective-C

    @property (readonly, getter=isLoading, nonatomic) BOOL loading;

    Swift

    var isLoading: Bool { get }