Other Constants

The following constants are available globally.

  • Prefix used for all analytics events. “pspdf”. A underscore (_) is added after this prefix to all analytics events as well.

    Declaration

    Objective-C

    extern NSString *const PSPDFAnalyticsEventPrefix

    Swift

    let PSPDFAnalyticsEventPrefix: String
  • Posted when the library begins indexing a document.

    The object of this notification will be the PDFLibrary instance that posts it. The UID of the document about to be indexed can be found in the userInfo under PSPDFLibraryNotificationUIDKey.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFLibraryWillStartIndexingDocumentNotification

    Swift

    static let PSPDFLibraryWillStartIndexingDocument: NSNotification.Name
  • Posted when the library completed or failed indexing a document.

    The object of this notification will be the PDFLibrary instance that posts it. The UID of the indexed document can be found in the userInfo under PSPDFLibraryNotificationUIDKey, while PSPDFLibraryNotificationSuccessKey holds a Bool, indicting whether indexing completed successfully.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFLibraryDidFinishIndexingDocumentNotification

    Swift

    static let PSPDFLibraryDidFinishIndexingDocument: NSNotification.Name
  • Posted when the library removed a document from the index.

    The object of this notification will be the PDFLibrary instance that posts it. The UID of the indexed document can be found in the userInfo under PSPDFLibraryNotificationUIDKey.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFLibraryDidRemoveDocumentNotification

    Swift

    static let PSPDFLibraryDidRemoveDocument: NSNotification.Name
  • Posted when the library did complete clearing all its indexes.

    The object of this notification will be the PDFLibrary on which clearAllIndexes() has been called. No userInfo will be provided.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFLibraryDidClearIndexesNotification

    Swift

    static let PSPDFLibraryDidClearIndexes: NSNotification.Name
  • In document-specific notifications posted by PDFLibrary, the userInfo key under which the UID of that document can be found.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryNotificationUIDKey

    Swift

    let PSPDFLibraryNotificationUIDKey: String
  • In PSPDFLibraryDidFinishIndexingDocumentNotification, the userInfo key holding the success state of the operation as a Bool.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryNotificationSuccessKey

    Swift

    let PSPDFLibraryNotificationSuccessKey: String