About PSPDFKit Instant for iOS
With Instant, it’s easier than ever to add real-time collaboration features to your PSPDFKit-powered app, allowing your users to seamlessly share, edit and annotate PDF documents across iOS, Android and Web apps. Read more in the Overview guide.
At a Glance
- PSPDFInstantClient: The entry point into Instant, representing a connection to your PSPDFKit Server.
- PSPDFInstantDocumentDescriptor: The API to each document managed by Instant. A document descriptor may be used to download the associated PDF file and create a PSPDFDocument.
- PSPDFInstantViewController: A subclass of PSPDFViewController that supports annotation synchronization between all users viewing the same document.
- PSPDFInstantError: The list of Instant specific errors that can happen when managing or syncing documents.
Read more in the Usage guide.
See the Getting Started guide for a step-by-step guide to integrating Instant.
Instant is commercially licensed. Contact us at [email protected]. Copyright © 2010-2018 PSPDFKit GmbH.
Feel free to submit a support ticket if you have any questions or bug reports.
The entry point to Instant, representing a client that can connect to PSPDFKit Server.
The Instant client manages the descriptors of the documents that you have access to. It provides the container for your downloaded documents, and controls the communication channel to the server. By providing a delegate, you are informed of relevant events regarding the synced documents and can manage tasks like authentication in a centralized manner.See more
@interface PSPDFInstantClient : NSObject
class PSPDFInstantClient : NSObject
PSPDFInstantDocumentDescriptorrepresents a document managed by Instant and may be used to download a local copy of the document to show to the user.
Instant manages downloading and storing the PDF files, and synchronizes their annotations. You obtain instances that conform to this protocol from a
PSPDFInstantClient, which also keeps the instances it creates alive.
A document descriptor posts the following notifications to inform you of relevant events:
PSPDFInstantDidFailAuthenticationNotificationwhen authenticating the document failed
PSPDFInstantDidUpdateAuthenticationTokenNotificationwhen the document has been successfully re-authenticated
PSPDFInstantDidFailUpdatingAuthenticationTokenNotificationwhen re-authenticating the document failed
PSPDFInstantDidFinishDownloadNotificationwhen the document download finishes
PSPDFInstantDidFailDownloadNotificationwhen the document download fails
PSPDFInstantDidBeginSyncingNotificationwhen the document starts a new sync cycle
PSPDFInstantSyncCycleDidChangeStateNotificationwhen the sync cycle changes its state
PSPDFInstantDidFailSyncingNotificationwhen the sync cycle stops abnormally (reasons include cancellation)
PSPDFInstantDidFinishSyncingNotificationwhen the sync cycle completes successfully
Each of these notifications will typically be posted on a background thread, and have the document descriptor as theirSee more
objectproperty. For a centralized, more type-safe alternative see
PSPDFInstantClientDelegate, and for more details on the sync cycle, refer to the documentation of
@protocol PSPDFInstantDocumentDescriptor <NSObject>
protocol PSPDFInstantDocumentDescriptor : NSObjectProtocol