Other Constants

The following constants are available globally.

  • In the old legacy file format the default number of PBKDF rounds is 50000. The new default is PSPDFAESDefaultPBKDFNumberOfRounds. (10000)

    Declaration

    Objective-C

    extern const NSUInteger PSPDFDefaultPBKDFNumberOfRounds

    Swift

    let PSPDFDefaultPBKDFNumberOfRounds: UInt
  • The PSPDFAESCryptoInputStream Error Domain. - note: Used in the PSPDFAESCryptoInputStream -(NSError *)streamError method.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFAESCryptoInputStreamErrorDomain

    Swift

    let PSPDFAESCryptoInputStreamErrorDomain: String
  • The PSPDFAESCryptoOutputStream Error Domain. - note: Used in the PSPDFAESCryptoOutputStream -(NSError *)streamError method.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFAESCryptoOutputStreamErrorDomain

    Swift

    let PSPDFAESCryptoOutputStreamErrorDomain: String
  • Set to @YES in the options dictionary to make links modal.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionModalKey

    Swift

    let PSPDFActionOptionModalKey: String
  • Enable Autoplay if target is a video.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionAutoplayKey

    Swift

    let PSPDFActionOptionAutoplayKey: String
  • Enable/Disable controls. (e.g. Browser back/next buttons)

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionControlsKey

    Swift

    let PSPDFActionOptionControlsKey: String
  • Loop the video.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionLoopKey

    Swift

    let PSPDFActionOptionLoopKey: String
  • Allow fullscreen presentation.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionFullscreenKey

    Swift

    let PSPDFActionOptionFullscreenKey: String
  • Set video offset.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionOffsetKey

    Swift

    let PSPDFActionOptionOffsetKey: String
  • Set modal size.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionSizeKey

    Swift

    let PSPDFActionOptionSizeKey: String
  • Show as popover.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionPopoverKey

    Swift

    let PSPDFActionOptionPopoverKey: String
  • Show cover, accepts string path.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionCoverKey

    Swift

    let PSPDFActionOptionCoverKey: String
  • The target page.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionPageKey

    Swift

    let PSPDFActionOptionPageKey: String
  • Shows a button that activates links.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionButtonKey

    Swift

    let PSPDFActionOptionButtonKey: String
  • Controls if a close button is displayed, when PSPDFActionOptionButtonKey is used. Default will be YES.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionOptionCloseButtonKey

    Swift

    let PSPDFActionOptionCloseButtonKey: String
  • Constant to convert PSPDFActionType into NSString and back.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActionTypeTransformerName

    Swift

    let PSPDFActionTypeTransformerName: String
  • 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
  • This key will return the last used style.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFStyleManagerLastUsedStylesKey

    Swift

    let PSPDFStyleManagerLastUsedStylesKey: String
  • This key will mark styles as generic, thus they’ll be returned with all other style types except the last used trait.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFStyleManagerGenericStylesKey

    Swift

    let PSPDFStyleManagerGenericStylesKey: String
  • Color preset type

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFStyleManagerColorPresetKey

    Swift

    let PSPDFStyleManagerColorPresetKey: String
  • Fired whenever the toolbar visibility changes.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFAnnotationToolbarControllerVisibilityDidChangeNotification

    Swift

    static let PSPDFAnnotationToolbarControllerVisibilityDidChange: NSNotification.Name
  • Key inside the notification’s userInfo.

    Declaration

    Objective-C

    extern NSString
        *const _Nonnull PSPDFAnnotationToolbarControllerVisibilityAnimatedKey

    Swift

    let PSPDFAnnotationToolbarControllerVisibilityAnimatedKey: String
  • Notification sent out after appearanceMode is changed.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFAppearanceModeChangedNotification

    Swift

    static let PSPDFAppearanceModeChanged: NSNotification.Name
  • Notification userInfo dictionary key. Holds a BOOL NSNumber which is YES when an animated mode change was requested.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFAppearanceModeChangedAnimatedKey

    Swift

    let PSPDFAppearanceModeChangedAnimatedKey: String
  • Notification posted on the main thread whenever detected is set to YES even if it was YES before.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFApplePencilDetectedNotification

    Swift

    static let PSPDFApplePencilDetected: NSNotification.Name
  • Notification posted on the main thread whenever detected changes value.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFApplePencilDetectedChangedNotification

    Swift

    static let PSPDFApplePencilDetectedChanged: NSNotification.Name
  • Policy for Open In.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPolicyEventOpenIn
  • Policy for print.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPolicyEventPrint
  • Policy for mail.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPolicyEventEmail
  • Policy for message.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPolicyEventMessage
  • Policy for Quick Look.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPolicyEventQuickLook
  • Policy for audio recording.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPolicyEventAudioRecording
  • Policy for the camera.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPolicyEventCamera
  • Policy for the photo library.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPolicyEventPhotoLibrary
  • Policy for the pasteboard. Includes Copy/Paste.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPolicyEventPasteboard
  • Policy for submitting forms.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPolicyEventSubmitForm
  • Policy for the network.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFPolicyEventNetwork
  • Register to get notified when the bookmarks managed by the bookmark manager posting this notification change.

    A change is defined as adding, removing, or replacing a bookmark or changing its sort order.

    This notification is guaranteed to be posted on the main thread.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFBookmarksChangedNotification

    Swift

    static let PSPDFBookmarksChanged: NSNotification.Name
  • The priority with which the filterElement is centered inside the filter view.

    Declaration

    Objective-C

    static const UILayoutPriority PSPDFCollectionReusableFilterViewCenterPriority =
        UILayoutPriorityDefaultHigh - 10

    Swift

    static let PSPDFCollectionReusableFilterViewCenterPriority: NSLayoutConstraint.Priority
  • The default minimum margin of the filterElement

    Declaration

    Objective-C

    static const CGFloat PSPDFCollectionReusableFilterViewDefaultMargin = 8

    Swift

    let PSPDFCollectionReusableFilterViewDefaultMargin: CGFloat
  • Use on searchResultZoomScale for an automatic scale mode that makes text readable in most cases.

    Declaration

    Objective-C

    extern const CGFloat PSPDFAutomaticSearchResultZoomScale

    Swift

    let PSPDFAutomaticSearchResultZoomScale: CGFloat
  • Pre-provided activity that opens a dialog to go to a specific page.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActivityTypeGoToPage

    Swift

    let PSPDFActivityTypeGoToPage: String
  • Pre-provided activity that invokes text search.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActivityTypeSearch

    Swift

    let PSPDFActivityTypeSearch: String
  • Pre-provided activity that shows the outline view controller.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActivityTypeOutline

    Swift

    let PSPDFActivityTypeOutline: String
  • Pre-provided activity that shows the bookmark view controller.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActivityTypeBookmarks

    Swift

    let PSPDFActivityTypeBookmarks: String
  • Pre-provided activity that shows the open in view controller.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFActivityTypeOpenIn

    Swift

    let PSPDFActivityTypeOpenIn: String
  • Search glyphs.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsGlyphsKey

    Swift

    let PSPDFObjectsGlyphsKey: String
  • Always return full PSPDFWords. Implies PSPDFObjectsTextKey.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsWordsKey

    Swift

    let PSPDFObjectsWordsKey: String
  • Include Text.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsTextKey

    Swift

    let PSPDFObjectsTextKey: String
  • Include text blocks, sorted after most appropriate.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsTextBlocksKey

    Swift

    let PSPDFObjectsTextBlocksKey: String
  • Include Image info.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsImagesKey

    Swift

    let PSPDFObjectsImagesKey: String
  • Output category for annotations.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsAnnotationsKey

    Swift

    let PSPDFObjectsAnnotationsKey: String
  • Ignore too large text blocks (that are > 90% of a page)

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsIgnoreLargeTextBlocksKey

    Swift

    let PSPDFObjectsIgnoreLargeTextBlocksKey: String
  • Include annotations of attached type

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsAnnotationTypesKey

    Swift

    let PSPDFObjectsAnnotationTypesKey: String
  • Special case; used for PSPDFAnnotationTypeNote hit testing.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsAnnotationPageBoundsKey

    Swift

    let PSPDFObjectsAnnotationPageBoundsKey: String
  • Special case; Used to correctly hit test zoom-invariant annotations.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsPageZoomLevelKey

    Swift

    let PSPDFObjectsPageZoomLevelKey: String
  • Include annotations that are part of a group.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsAnnotationIncludedGroupedKey

    Swift

    let PSPDFObjectsAnnotationIncludedGroupedKey: String
  • Will sort words/annotations (smaller words/annotations first). Use for touch detection.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsSmartSortKey

    Swift

    let PSPDFObjectsSmartSortKey: String
  • Will use path-based hit-testing based on the center point if set. All annotations that support path based hit-testing but fail the test will be excluded from the results.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectMinDiameterKey

    Swift

    let PSPDFObjectMinDiameterKey: String
  • Will look at the text flow and select full sentences, not just what’s within the rect.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsTextFlowKey

    Swift

    let PSPDFObjectsTextFlowKey: String
  • Will stop after finding the first matching object.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsFindFirstOnlyKey

    Swift

    let PSPDFObjectsFindFirstOnlyKey: String
  • Only relevant for rect. Will test for intersection instead of objects that are fully included in the pdfRect. Defaults to YES if not set.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFObjectsTestIntersectionKey

    Swift

    let PSPDFObjectsTestIntersectionKey: String
  • Customize the sharing options. The default options will be used if not set.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFDocumentActionSharingOptionsKey

    Swift

    let PSPDFDocumentActionSharingOptionsKey: String
  • Customize the page range. By default all pages are used. Expects an NSOrderedSet.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFDocumentActionVisiblePagesKey

    Swift

    let PSPDFDocumentActionVisiblePagesKey: String
  • Presents the UIPrintInteractionController.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFDocumentActionPrint

    Swift

    let PSPDFDocumentActionPrint: String
  • Presents the MFMailComposeViewController.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFDocumentActionEmail

    Swift

    let PSPDFDocumentActionEmail: String
  • Presents the UIDocumentInteractionController.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFDocumentActionOpenIn

    Swift

    let PSPDFDocumentActionOpenIn: String
  • Presents the MFMessageComposeViewController.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFDocumentActionMessage

    Swift

    let PSPDFDocumentActionMessage: String
  • The notification posted when a checkpoint is saved. The object sending this is the document’s checkpointer.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFDocumentCheckpointSavedNotification

    Swift

    static let PSPDFDocumentCheckpointSaved: NSNotification.Name
  • The key set in PSPDFDocumentCheckpointSavedNotification‘s userInfo that indicates (using a BOOL wrapped in a NSNumber) whether the checkpoint saved successfully or not.

    Declaration

    Objective-C

    extern NSString
        *const _Nonnull PSPDFDocumentCheckpointSavedNotificationSucessKey

    Swift

    let PSPDFDocumentCheckpointSavedNotificationSucessKey: String
  • Fired whenever the toolbar visibility changes.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFDocumentEditorToolbarControllerVisibilityDidChangeNotification

    Swift

    static let PSPDFDocumentEditorToolbarControllerVisibilityDidChange: NSNotification.Name
  • Key inside the notification’s userInfo.

    Declaration

    Objective-C

    extern NSString
        *const _Nonnull PSPDFDocumentEditorToolbarControllerVisibilityAnimatedKey

    Swift

    let PSPDFDocumentEditorToolbarControllerVisibilityAnimatedKey: String
  • The constant to be used to indicate that the key length should be determined automatically.

    Declaration

    Objective-C

    extern const NSUInteger PSPDFDocumentSecurityOptionsKeyLengthAutomatic

    Swift

    let PSPDFDocumentSecurityOptionsKeyLengthAutomatic: UInt
  • The XMP PDF namespace.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFXMPPDFNamespace

    Swift

    let PSPDFXMPPDFNamespace: String
  • The XMP PDF namespace prefix.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFXMPPDFNamespacePrefix

    Swift

    let PSPDFXMPPDFNamespacePrefix: String
  • The XMP Dublin Core namespace.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFXMPDCNamespace

    Swift

    let PSPDFXMPDCNamespace: String
  • The XMP Dublin Core namespace prefix.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFXMPDCNamespacePrefix

    Swift

    let PSPDFXMPDCNamespacePrefix: String
  • Posted whenever a task starts loading.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFDownloadManagerDidStartLoadingTaskNotification

    Swift

    static let PSPDFDownloadManagerDidStartLoadingTask: NSNotification.Name
  • Posted whenever a task finishes loading.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFDownloadManagerDidFinishLoadingTaskNotification

    Swift

    static let PSPDFDownloadManagerDidFinishLoadingTask: NSNotification.Name
  • Posted whenever a task failed to load.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFDownloadManagerDidFailToLoadTaskNotification

    Swift

    static let PSPDFDownloadManagerDidFailToLoadTask: NSNotification.Name
  • The PSPDFKit Error Domain.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFErrorDomain

    Swift

    let PSPDFErrorDomain: String
  • Notification when someone pressed Clear Field.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFFormInputAccessoryViewDidPressClearButtonNotification

    Swift

    static let PSPDFFormInputAccessoryViewDidPressClearButton: NSNotification.Name
  • Notification when someone presses Clear.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFFreeTextAccessoryViewDidPressClearButtonNotification

    Swift

    static let PSPDFFreeTextAccessoryViewDidPressClearButton: NSNotification.Name
  • String. The type of an item.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryItemTypeKey

    Swift

    let PSPDFGalleryItemTypeKey: String
  • String. The content URL of an item.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryItemContentURLKey

    Swift

    let PSPDFGalleryItemContentURLKey: String
  • String. The caption of an item.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryItemCaptionKey

    Swift

    let PSPDFGalleryItemCaptionKey: String
  • String. The options of an item.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryItemOptionsKey

    Swift

    let PSPDFGalleryItemOptionsKey: String
  • Boolean. Indicates if the content should automatically start playing.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionAutoplay

    Swift

    let PSPDFGalleryOptionAutoplay: String
  • Boolean. Indicates if controls should be displayed.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionControls

    Swift

    let PSPDFGalleryOptionControls: String
  • Boolean. Indicates if the content should loop forever.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionLoop

    Swift

    let PSPDFGalleryOptionLoop: String
  • Boolean. Indicates that the content can be presented fullscreen.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionFullscreen

    Swift

    let PSPDFGalleryOptionFullscreen: String
  • NSString. Indicates the cover mode.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionCoverMode

    Swift

    let PSPDFGalleryOptionCoverMode: String
  • NSURL. Indicates which image should be presented as a cover view.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionCoverImage

    Swift

    let PSPDFGalleryOptionCoverImage: String
  • NSNumber. The time in the video where the preview should be captured.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionCoverPreviewCaptureTime

    Swift

    let PSPDFGalleryOptionCoverPreviewCaptureTime: String
  • NSArray. The preferred video qualities.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionPreferredVideoQualities

    Swift

    let PSPDFGalleryOptionPreferredVideoQualities: String
  • NSNumber. The start time of the video.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionStartTime

    Swift

    let PSPDFGalleryOptionStartTime: String
  • NSNumber. The end time of the video.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFGalleryOptionEndTime

    Swift

    let PSPDFGalleryOptionEndTime: String
  • Default padding factor added to the glyph rects in PSPDFBoundingBoxFromGlyphs and PSPDFRectsFromGlyphs to improve selection appearance. The padding factor is multiplied by the frame height and the width and height extended by that value.

    Declaration

    Objective-C

    extern const CGFloat PSPDFDefaultTextPaddingFactor

    Swift

    let PSPDFDefaultTextPaddingFactor: CGFloat
  • Set this as delayForSyncingLocalChanges to disable automatic syncing of local changes.

    Declaration

    Objective-C

    extern const NSTimeInterval PSPDFInstantSyncingLocalChangesDisabled

    Swift

    let PSPDFInstantSyncingLocalChangesDisabled: TimeInterval
  • Key for NSNotification userInfo dictionary. Where supported, the value under this key will be an instance of NSError.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFInstantErrorKey

    Swift

    let PSPDFInstantErrorKey: String
  • Key for NSNotification userInfo dictionary. Where supported, the value under this key will be an instance of NSString.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFInstantAuthenticationTokenKey

    Swift

    let PSPDFInstantAuthenticationTokenKey: String
  • Notification posted when downloading a PDF file from the server finishes. At this point the document can be obtained from editableDocumentWithError: or readOnlyDocumentWithError:.

    This will be posted on a background thread.

    The object of this notification will be the descriptor of the document whose download finished (PSPDFInstantDocumentDescriptor).

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFInstantDidFinishDownloadNotification

    Swift

    static let PSPDFInstantDidFinishDownload: NSNotification.Name
  • Notification posted when downloading the PDF file from the server fails.

    This will be posted on a background thread.

    The object of this notification will be the descriptor of the document whose download failed (PSPDFInstantDocumentDescriptor). The error that occurred (NSError) is available under PSPDFInstantErrorKey in the userInfo.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFInstantDidFailDownloadNotification

    Swift

    static let PSPDFInstantDidFailDownload: NSNotification.Name
  • Notification posted when synchronizing annotations for a document fails. The most likely reason is network failure.

    This will be posted on a background thread.

    The object of this notification will be the descriptor of the document that failed synchronization (PSPDFInstantDocumentDescriptor). The error that occurred (NSError) is available under PSPDFInstantErrorKey in the userInfo.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFInstantDidFailSyncingNotification

    Swift

    static let PSPDFInstantDidFailSyncing: NSNotification.Name
  • Notification posted when Instant fails to authenticate with the PSPDFKit Server to synchronize annotations. This typically means either the user no longer has access to the document or the JWT expired. Your own server should be able to say if the user still has access.

    If the user still has access, obtain a new JWT from your server and set it as the document descriptor’s authenticationToken. If the user no longer has access, stop showing this document to the user and call removeLocalStorageWithError: on the document descriptor.

    This will be posted on a background thread.

    The object of this notification will be the descriptor of the document that failed authentication (PSPDFInstantDocumentDescriptor).

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFInstantDidFailAuthenticationNotification

    Swift

    static let PSPDFInstantDidFailAuthentication: NSNotification.Name
  • Notification posted when the authentication token for a document has been successfully updated.

    This will be posted on a background thread.

    The object of this notification will be the descriptor of the document that failed authentication (PSPDFInstantDocumentDescriptor). The accepted authentication token (NSString) is available under PSPDFInstantAuthenticationTokenKey in the userInfo.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFInstantDidUpdateAuthenticationTokenNotification

    Swift

    static let PSPDFInstantDidUpdateAuthenticationToken: NSNotification.Name
  • Notification posted when the authentication token for a document could not be updated.

    This will be posted on a background thread.

    The object of this notification will be the descriptor of the document that failed authentication (PSPDFInstantDocumentDescriptor). The error that occurred (NSError) is available under PSPDFInstantErrorKey in the userInfo.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFInstantDidFailUpdatingAuthenticationTokenNotification

    Swift

    static let PSPDFInstantDidFailUpdatingAuthenticationToken: NSNotification.Name
  • Domain for errors encountered by PSPDF Instant.

    Declaration

    Objective-C

    extern const NSErrorDomain _Nonnull PSPDFInstantErrorDomain

    Swift

    let PSPDFInstantErrorDomain: String
  • Key for NSError userInfo for the PSPDFInstantDocumentDescriptorDescriptor an error relates to, if applicable.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFInstantErrorDocumentDescriptorKey

    Swift

    let PSPDFInstantErrorDocumentDescriptorKey: String
  • Key for NSError userInfo for the PSPDFDocument an error relates to, if applicable.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFInstantErrorDocumentKey

    Swift

    let PSPDFInstantErrorDocumentKey: String
  • User info key for the (extended) SQLite error code as an NSNumber in the case of PSPDFInstantErrorDatabaseAccessFailed.

    A detailed discussions of these codes can be found at https://www.sqlite.org/rescode.html - note: Important: This value can very well be nil! (Not all database access errors need to be SQLite errors.)

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFInstantErrorSQLiteExtendedErrorCodeKey

    Swift

    let PSPDFInstantErrorSQLiteExtendedErrorCodeKey: String
  • The domain for errors originating from PSPDFJSONAdapter.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFJSONAdapterErrorDomain

    Swift

    let PSPDFJSONAdapterErrorDomain: String
  • +classForParsingJSONDictionary: returned nil for the given dictionary.

    Declaration

    Objective-C

    extern const NSInteger PSPDFJSONAdapterErrorNoClassFound

    Swift

    let PSPDFJSONAdapterErrorNoClassFound: Int
  • X-Callback URL, see http://x-callback-url.com - note: This is used for the Chrome activity in PSPDFWebViewController. Example: PSPDFKit.sharedInstance[PSPDFXCallbackURLStringKey] = @"pspdfcatalog://";

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFXCallbackURLStringKey

    Swift

    let PSPDFXCallbackURLStringKey: String
  • Custom PSPDFApplicationPolicy instance that can be configured with setLicenseKey:options:.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFApplicationPolicyKey

    Swift

    let PSPDFApplicationPolicyKey: String
  • Custom PSPDFFileManager instance that can be configured with setLicenseKey:options:.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFFileManagerKey

    Swift

    let PSPDFFileManagerKey: String
  • Custom coordinated PSPDFFileManager instance that can be configured with setLicenseKey:options:.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFCoordinatedFileManagerKey

    Swift

    let PSPDFCoordinatedFileManagerKey: String
  • Specifies whether coordinated file operations are used by default in PSPDFDocument. Creates PSPDFCoordinatedFileDataProviders when initializing documents with local URLs. Expects a boolean NSNumber. Defaults to @YES. Set to @NO to disable.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFFileCoordinationEnabledKey

    Swift

    let PSPDFFileCoordinationEnabledKey: String
  • Specifies the indexing priority that the shared PSPDFLibrary instance must use. Must be a valid PSPDFLibraryIndexingPriority value wrapped in a NSNumber. SeePSPDFLibraryIndexingPriority` for details.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryIndexingPriorityKey

    Swift

    let PSPDFLibraryIndexingPriorityKey: String
  • Set to @YES to disable the use of WKWebView when available.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFWebKitLegacyModeKey

    Swift

    let PSPDFWebKitLegacyModeKey: String
  • The library version.

    Declaration

    Objective-C

    extern const NSUInteger PSPDFLibraryVersion

    Swift

    let PSPDFLibraryVersion: UInt
  • PSPDFLibrary uses NSNotifications to post status updates.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFLibraryWillStartIndexingDocumentNotification

    Swift

    static let PSPDFLibraryWillStartIndexingDocument: NSNotification.Name
  • Undocumented

  • Sent when a document is removed from the library.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFLibraryDidRemoveDocumentNotification

    Swift

    static let PSPDFLibraryDidRemoveDocument: NSNotification.Name
  • Sent when all indexes are cleared as a result of -[PSPDFLibrary clearAllIndexes].

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFLibraryDidClearIndexesNotification

    Swift

    static let PSPDFLibraryDidClearIndexes: NSNotification.Name
  • The key in the NSNotification userInfo for the UID of the document.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryNotificationUIDKey

    Swift

    let PSPDFLibraryNotificationUIDKey: String
  • The key in the NSNotification userInfo if the indexing operation was successful.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryNotificationSuccessKey

    Swift

    let PSPDFLibraryNotificationSuccessKey: String
  • The name of the exception thrown when an invalid operation occurs.

    Declaration

    Objective-C

    extern const NSExceptionName _Nonnull PSPDFLibraryInvalidOperationException

    Swift

    static let PSPDFLibraryInvalidOperationException: NSExceptionName
  • Option keys. Limit the number of document results.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryMaximumSearchResultsTotalKey

    Swift

    let PSPDFLibraryMaximumSearchResultsTotalKey: String
  • Undocumented

  • Limit the number of preview results.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryMaximumPreviewResultsTotalKey

    Swift

    let PSPDFLibraryMaximumPreviewResultsTotalKey: String
  • Undocumented

  • Set this to @YES to restrict search to exact word matches instead of beginsWith/endsWith checks. - warning: If the default tokenizer is used, this will impact performance. If you find it is too slow, consider using a different tokenizer. See https://pspdfkit.com/guides/ios/current/features/indexed-full-text-search/

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryMatchExactWordsOnlyKey

    Swift

    let PSPDFLibraryMatchExactWordsOnlyKey: String
  • Set this to @YES to restrict search to exact phrase matches. This means that Lorem ipsum dolor only matches that phrase and not something like Lorem sit ipsum dolor. - warning: If the default tokenizer is used, this will impact performance. If you find it is too slow, consider using a different tokenizer. See https://pspdfkit.com/guides/ios/current/features/indexed-full-text-search/

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryMatchExactPhrasesOnlyKey

    Swift

    let PSPDFLibraryMatchExactPhrasesOnlyKey: String
  • Set this to @YES to exclude annotations from the search. By default, indexed annotations will be searched.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryExcludeAnnotationsKey

    Swift

    let PSPDFLibraryExcludeAnnotationsKey: String
  • Set this to @YES to include document text from the search. By default, indexed document text will be searched.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryExcludeDocumentTextKey

    Swift

    let PSPDFLibraryExcludeDocumentTextKey: String
  • Customizes the range of the preview string. Defaults to 20/160.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFLibraryPreviewRangeKey

    Swift

    let PSPDFLibraryPreviewRangeKey: String
  • Transforms named actions to enum type and back.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFNamedActionTypeTransformerName

    Swift

    let PSPDFNamedActionTypeTransformerName: String
  • Posted whenever any network activity in PSPDFKit starts.

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFNetworkActivityDidStartNotification

    Swift

    static let PSPDFNetworkActivityDidStart: NSNotification.Name
  • Posted whenever any network activity in PSPDFKit finishes (that is, either completes or fails).

    Declaration

    Objective-C

    extern const NSNotificationName _Nonnull PSPDFNetworkActivityDidFinishNotification

    Swift

    static let PSPDFNetworkActivityDidFinish: NSNotification.Name
  • Specifies a pattern for a new page with a dot grid that is 5mm apart.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFNewPagePatternDot5mm

    Swift

    let PSPDFNewPagePatternDot5mm: String
  • Specifies a pattern for a new page with a grid that is 5mm apart.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFNewPagePatternGrid5mm

    Swift

    let PSPDFNewPagePatternGrid5mm: String
  • Specifies a pattern for a new page with lines that are 5mm apart.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFNewPagePatternLines5mm

    Swift

    let PSPDFNewPagePatternLines5mm: String
  • Specifies a pattern for a new page with lines that are 7mm apart.

    Declaration

    Objective-C

    extern NSString *const _Nonnull PSPDFNewPagePatternLines7mm

    Swift

    let PSPDFNewPagePatternLines7mm: String
  • Marks an unused or invalid page number.

    Declaration

    Objective-C

    static const NSUInteger PSPDFPageNull = (9223372036854775807L * 2UL + 1UL)

    Swift

    let PSPDFPageNull: UInt