PSPDFKit for iOS with Instant
PSPDFKit and Instant are two separate dynamic frameworks available in the same download. Download the latest release, or use CocoaPods (see the integration section below).
A PSPDFKit Server instance
See the Example Projects guide to get an instance up and running.
The latest stable Xcode
PSPDFKit and Instant usually require the latest stable version of Xcode available at the time the release was made.
Quick Start With the Example Project
Instant comes with an example iOS project in the
Examples folder, which connects to either of our example server apps.
- Run PSPDFKit Server locally using one of our Example Projects.
- In a web browser, log in to the example app with the same user ID the iOS app uses in
AppDelegate.swift, which by default is ‘test’.
- Add a document to the server using the ‘Upload PDF’ button.
- Select the document to view it with PSPDFKit for Web.
- Build and run the Instant-iOS-Example scheme on the iOS Simulator. After launching the app should load the document list from the server.
- Tap the document in the app to download it and show it in a
- Add annotations in the iOS app or in the browser to see annotation syncing.
Instant-iOS-Example does not build, make sure you are using the latest stable version of Xcode version, and expand the
Frameworks group in the Project Navigator and check that
Instant.framework are black rather than red, which would mean the framework is missing. If the app runs but no documents appear make sure the
serverURL and user ID in
AppDelegate.swift and the server is running and the server is reachable from the device.
To run on an iOS device rather than the Simulator, set the
Instant-iOS-Example/AppDelegate.swift to an absolute URL that the server can be reached at. This is your Mac’s local IP address, which you can see by option-clicking the Wi-Fi icon in the macOS menu bar.
Integrating the Instant Framework
If you’re already using CocoaPods, the the simplest way to add PSPDFKit and Instant to your project is to add the following to your
Podfile, then run
1 2 3 4 5 6
use_frameworks! target :YourTargetName do pod 'PSPDFKit', podspec: 'https://customers.pspdfkit.com/cocoapods/YOUR_COCOAPODS_KEY_GOES_HERE/pspdfkit/latest.podspec' pod 'Instant', podspec: 'https://customers.pspdfkit.com/cocoapods/YOUR_COCOAPODS_KEY_GOES_HERE/instant/latest.podspec' end
Otherwise follow the steps below for manual integration:
Embedded Binariessection of your target
(Optional but recommended for production) You may want to copy debug symbols for debugging and crash reporting: add
Instant.framework.dSYMto your Xcode project (do not add it to any targets - just add it to the tree) and add this as an input file to the
Run Script Phasethat runs
strip-framework.shadded when integrating PSPDFKit. The script will copy the debug symbols into the products directory and strip it from unneeded architectures.