Alternative Installation Methods

Install the Airship SDK using Carthage or xcframeworks for iOS, tvOS, and visionOS projects that cannot use Swift Package Manager.

View as Markdown

These installation methods are available for projects that cannot use Swift Package Manager. For new projects, use SPM — see Install and Set Up the Apple SDK.

Note

CocoaPods is no longer supported. If you currently integrate Airship via CocoaPods, migrate to SPM — see Install and Set Up the Apple SDK — or to one of the manual integration methods below.

Install Carthage if you haven’t already. See the Carthage installation guide .
Verify Enable Modules and Link Frameworks Automatically are enabled in your project’s Build Settings.
Follow Carthage’s adding frameworks to an application instructions to add frameworks to your application.
Specify the Airship iOS SDK in your Cartfile:

github "urbanairship/ios-library"

Build the frameworks:

$ carthage update

Add the frameworks to your project. Airship is modular, so select only the frameworks you need:
Available frameworks:
- AirshipBasement : Required by AirshipCore (must be included)
- AirshipCore : Push messaging features including channels, tags, named user and default actions (required)
- AirshipSceneRenderer : Scene/layout rendering engine (required if you include AirshipAutomation or AirshipMessageCenter)
- AirshipScenes : Embedded views and custom views (required if you include AirshipAutomation or AirshipMessageCenter)
- AirshipAutomation : Automation and in-app messaging
- AirshipMessageCenter : Message center
- AirshipNotificationServiceExtension : Service Extension framework (only for Notification Service Extension targets, not the app target)*
- AirshipPreferenceCenter : Preference Center
- AirshipFeatureFlags : Feature flags
- AirshipObjectiveC : Objective-C Bindings
- AirshipDebug : Debugging tools
If you include AirshipAutomation or AirshipMessageCenter, you must also add AirshipScenes and AirshipSceneRenderer — the app will fail to link without them.
Import the frameworks in your code. Import statements match the framework names, except embedded views and custom views, which live in AirshipScenes:

import AirshipCore
import AirshipMessageCenter
import AirshipAutomation
import AirshipScenes

Download and decompress the latest version of the iOS SDK .
Inside the folder you should see a collection of XCFrameworks. Airship is modular, so select only the XCFrameworks you need:
Available XCFrameworks:
- AirshipBasement.xcframework : Required by AirshipCore (must be included)
- AirshipCore.xcframework : Push messaging features including channels, tags, named user and default actions (required)
- AirshipSceneRenderer.xcframework : Scene/layout rendering engine (required if you include AirshipAutomation or AirshipMessageCenter)
- AirshipScenes.xcframework : Embedded views and custom views (required if you include AirshipAutomation or AirshipMessageCenter)
- AirshipAutomation.xcframework : Automation and in-app messaging
- AirshipMessageCenter.xcframework : Message center
- AirshipNotificationServiceExtension.xcframework : Service Extension framework (only for Notification Service Extension targets, not the app target)*
- AirshipPreferenceCenter.xcframework : Preference Center
- AirshipFeatureFlags.xcframework : Feature flags
- AirshipObjectiveC.xcframework : Objective-C Bindings
- AirshipDebug.xcframework : Debugging tools
If you include AirshipAutomation.xcframework or AirshipMessageCenter.xcframework, you must also add AirshipScenes.xcframework and AirshipSceneRenderer.xcframework — the app will fail to link without them.
Add XCFrameworks to your project:
- Open your project in Xcode.
- Click on your project in the Project Navigator.
- Select your target.
- Make sure the General tab is selected.
- Scroll down to Frameworks, Libraries, and Embedded Content.
- Drag in the desired XCFrameworks from the downloaded SDK. They are wired up automatically as dependencies of your target.
Verify Build Settings:
- Enable Modules should be set to Yes.
- Link Frameworks Automatically should be set to Yes.

Import the frameworks in your code. Import statements match the framework names, except embedded views and custom views, which live in AirshipScenes:

import AirshipCore
import AirshipMessageCenter
import AirshipAutomation
import AirshipScenes