Get started integrating Apryse iOS SDK

Apple has information on using Swift Package Manager, which you may review for topics not covered in this guide.

Apryse is available as a Swift Package from the following URL:

1https://github.com/ApryseSDK/pdftron-apple-package

To include it, open your project's Swift Package Manager pane:

Enter the github link to the package. Add a high maximum version number to ensure you are always up-to-date. Apryse versioning does not strictly follow a semantic versioning system. (We very rarely make changes that break public APIs.)

Apryse uses a select number AppStore permissions to allow certain functionality such as adding image stamps and detecting the Apple Pencil. Your app's plist must include the following keys (with whatever description is appropriate for your app), or it will be rejected from the AppStore.

1<key>NSCameraUsageDescription</key>
2<string>This will allow you to use the image from your camera.</string>
3<key>NSPhotoLibraryAddUsageDescription</key>
4<string>This will allow you to add images to your photo library.</string>
5<key>NSPhotoLibraryUsageDescription</key>
6<string>This will allow you to create signatures and annotations from images in your photo library.</string>
7<key>NSBluetoothAlwaysUsageDescription</key>
8<string>This will allow us to detect if an Apple Pencil is paired, enabling palm rejection and the ability to scroll with one finger while annotating.</string>
9<key>NSBluetoothPeripheralUsageDescription</key>
10<string>This will allow us detect if an Apple Pencil is paired, enabling palm rejection and the ability to scroll with one finger while annotating.</string>

You only need to explicitly initialize Apryse when you have purchased a license key.

Initialize Apryse before you use any Apryse related classes or methods. This only needs to be done once.

The best practice to do this is to use the optional application:willFinishLaunchingWithOptions: method in the AppDelegate class found in either the AppDelegate.swift or AppDelegate.m file in the left pane depending on your choice of language:

1// In AppDelegate.swift
2import UIKit
3import PDFNet
4@UIApplicationMain
5class AppDelegate: UIResponder, UIApplicationDelegate {
6    var window: UIWindow?
7    //... Any methods already here
8    func application(_ application: UIApplication, willFinishLaunchingWithOptions launchOptions:[UIApplication.LaunchOptionsKey: Any]?) -> Bool {
9        PTPDFNet.initialize("Insert Commercial License Key Here After Purchase")
10        return true
11    }
12}

1// In AppDelegate.m
2#import "AppDelegate.h"
3#import <PDFNet/PDFNet.h>
4@interface AppDelegate ()
5@end
6@implementation AppDelegate
7// ... Any methods already here
8- (BOOL)application:(UIApplication *)application willFinishLaunchingWithOptions:(nullable NSDictionary *)launchOptions{
9    [PTPDFNet Initialize:@"Insert Commercial License Key Here After Purchase"];
10    return true;
11}

While you are trialing Apryse, you can pass any string to the initialize method. A string that is not a license key will enable demo mode, where all pages are lightly watermarked.

You can now use Apryse SDK to view, annotate and edit documents.

Note: SPM distributes the dynamic .xcframework only. If you wish to use the .framework, you will need to use CocoaPods or Manual integration. If you wish to use the static framework, you will have to integrate it manually.

• Xcode

1. Apryse iOS SDK

Download the SDK

Download

1Take note of the location of your `PDFNet.dmg` download.

1. Create a new Xcode Project. Call it pdfhello. For the purposes of this guide, select a view scene application.
2. From your PDFNet.dmg download, copy the /Lib/ folder into pdfhello/.

1. Select the project in the left pane and go to the General tab. Scroll down to find the Embedded Binaries section. Here, add Lib/Tools/Tools.framework and Lib/Framework-dynamic/PDFNet.framework from the Lib/ folder you copied into your project. You can do this by dragging them in from Finder or by clicking the + sign to browse your files.

1. Go to the Build Phases tab and click on the + button to add a New Run Script Phase. Copy and paste the following into the shell command:This will ensure invalid slices are striped from the framework before being submitted to the app store (a longstanding Xcode bug).

1bash "$BUILT_PRODUCTS_DIR/$FRAMEWORKS_FOLDER_PATH/PDFNet.framework/strip-framework.sh"

Apryse uses a select number AppStore permissions to allow certain functionality such as adding image stamps and detecting the Apple Pencil. Your app's plist must include the following keys (with whatever description is appropriate for your app), or it will be rejected from the AppStore.

1<key>NSCameraUsageDescription</key>
2<string>This will allow you to use the image from your camera.</string>
3<key>NSPhotoLibraryAddUsageDescription</key>
4<string>This will allow you to add images to your photo library.</string>
5<key>NSPhotoLibraryUsageDescription</key>
6<string>This will allow you to create signatures and annotations from images in your photo library.</string>
7<key>NSBluetoothAlwaysUsageDescription</key>
8<string>This will allow us to detect if an Apple Pencil is paired, enabling palm rejection and the ability to scroll with one finger while annotating.</string>
9<key>NSBluetoothPeripheralUsageDescription</key>
10<string>This will allow us detect if an Apple Pencil is paired, enabling palm rejection and the ability to scroll with one finger while annotating.</string>

Initialize Apryse before you use any Apryse related classes or methods. This only needs to be done once.

The best practice to do this is to use the optional application:willFinishLaunchingWithOptions: method in the AppDelegate class found in either the AppDelegate.swift or AppDelegate.m file in the left pane depending on your choice of language:

1// In AppDelegate.swift
2import UIKit
3import PDFNet
4@UIApplicationMain
5class AppDelegate: UIResponder, UIApplicationDelegate {
6    var window: UIWindow?
7    //... Any methods already here
8    func application(_ application: UIApplication, willFinishLaunchingWithOptions launchOptions:[UIApplication.LaunchOptionsKey: Any]?) -> Bool {
9        PTPDFNet.initialize("Insert Commercial License Key Here After Purchase")
10        return true
11    }
12}

1// In AppDelegate.m
2#import "AppDelegate.h"
3#import <PDFNet/PDFNet.h>
4@interface AppDelegate ()
5@end
6@implementation AppDelegate
7// ... Any methods already here
8- (BOOL)application:(UIApplication *)application willFinishLaunchingWithOptions:(nullable NSDictionary *)launchOptions{
9    [PTPDFNet Initialize:@"Insert Commercial License Key Here After Purchase"];
10    return true;
11}

While you are trialing Apryse, you can pass any string to the initialize method. A string that is not a license key will enable demo mode, where all pages are lightly watermarked.