PSPDFRemoteFileObject

Objective-C

@interface PSPDFRemoteFileObject : NSObject<PSPDFRemoteContentObject>

PSPDF_EMPTY_INIT_UNAVAILABLE

/// Designated initializer.
- (instancetype)initWithRemoteURL:(NSURL *)remoteURL targetURL:(NSURL *)targetFileURL fileManager:(id<PSPDFFileManager>)fileManager NS_DESIGNATED_INITIALIZER;

/// The remote URL to fetch the content from.
@property (nonatomic, copy, readonly) NSURL *remoteURL;
@property (nonatomic, copy, readonly) NSURL *targetURL;

#pragma mark PSPDFRemoteContentObject

/// The remote content of the object. This property is managed by `PSPDFDownloadManager`.
@property (nonatomic, nullable) NSURL *remoteContent;

/// The loading state of the object. This property is managed by `PSPDFDownloadManager`.
@property (nonatomic, getter=isLoadingRemoteContent) BOOL loadingRemoteContent;

/// The download progress of the object. Only meaningful if `loadingRemoteContent` is YES.
/// This property is managed by `PSPDFDownloadManager`.
@property (nonatomic) CGFloat remoteContentProgress;

/// The remote content error of the object. This property is managed by `PSPDFDownloadManager`.
@property (nonatomic, nullable) NSError *remoteContentError;

/// The completion block.
@property (nonatomic, copy, nullable) void (^completionBlock)(id<PSPDFRemoteContentObject> remoteObject);

@end

Swift

class RemoteFileObject : NSObject, RemoteContentObject

Undocumented

  • Unavailable

    Not the designated initializer

    Undocumented

    Declaration

    Objective-C

    PSPDF_EMPTY_INIT_UNAVAILABLE

  • Unavailable

    Not the designated initializer

    Undocumented

    Declaration

    Objective-C

    PSPDF_EMPTY_INIT_UNAVAILABLE

  • Designated initializer.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRemoteURL:(nonnull NSURL *)remoteURL
                                targetURL:(nonnull NSURL *)targetFileURL
                              fileManager:
                                  (nonnull id<PSPDFFileManager>)fileManager;

    Swift

    init(remoteURL: URL, targetURL targetFileURL: URL, fileManager: FileManager)

  • The remote URL to fetch the content from.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSURL *_Nonnull remoteURL;

    Swift

    var remoteURL: URL { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSURL *targetURL

    Swift

    var targetURL: URL { get }

PSPDFRemoteContentObject

  • The remote content of the object. This property is managed by PSPDFDownloadManager.

    Declaration

    Objective-C

    @property (nonatomic, nullable) NSURL *remoteContent;

    Swift

    var remoteContent: URL? { get set }

  • The loading state of the object. This property is managed by PSPDFDownloadManager.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isLoadingRemoteContent) BOOL loadingRemoteContent;

    Swift

    var isLoadingRemoteContent: Bool { get set }

  • The download progress of the object. Only meaningful if loadingRemoteContent is YES. This property is managed by PSPDFDownloadManager.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat remoteContentProgress;

    Swift

    var remoteContentProgress: CGFloat { get set }

  • The remote content error of the object. This property is managed by PSPDFDownloadManager.

    Declaration

    Objective-C

    @property (nonatomic, nullable) NSError *remoteContentError;

    Swift

    var remoteContentError: Error? { get set }

  • The completion block.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) void (^) (id<PSPDFRemoteContentObject> _Nonnull) completionBlock;

    Swift

    var completionBlock: ((RemoteContentObject) -> Void)? { get set }