PSPDFFileIndexItemDescriptor

Objective-C


@interface PSPDFFileIndexItemDescriptor : NSObject <NSSecureCoding>

Swift

class FileIndexItemDescriptor : NSObject, NSSecureCoding

This class encapsulates the metadata associated with a document used in the PSPDFLibraryFileSystemDataSource

  • 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

  • The document’s path, relative to the file system data source’s documents directory URL.

    Note

    Use [NSURL fileURLWithPath:descriptor.documentPath relativeToURL:fileSystemDataSource.documentsDirectoryURL] to construct an absolute path.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull documentPath;

    Swift

    var documentPath: String { get }

  • The document’s UID

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull documentUID;

    Swift

    var documentUID: String { get }

  • The document’s modification date

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSDate *_Nonnull lastModificationDate;

    Swift

    var lastModificationDate: Date { get }

  • Returns a Boolean value that indicates whether a given descriptor is equal to the receiver.

    Declaration

    Objective-C

    - (BOOL)isEqualToFileIndexItemDescriptor:
    (nonnull PSPDFFileIndexItemDescriptor *)other;

    Swift

    func isEqual(to other: FileIndexItemDescriptor) -> Bool

    Parameters

    other

    The descriptor with which to compare the receiver.

    Return Value

    YES is other is equivalent to the receiver, otherwise false.