Installation Guide

This guide will walk you through the process of installing the Upshot.ai iOS SDK in your project.

Install SDK

Upshot.ai iOS SDK can be added in 2 ways as detailed.

Install Manually

To install the SDK manually:

1. Download the SDK from the dashboard and unzip the iOS SDK
2. Drag Upshot.xcframework inside your project
3. Make sure that Upshot.xcframework is added to Embedded Binaries

Install using CocoaPods

To install SDK using CocoaPods:

1. Add the Upshot.ai SDK to your Podfile:

pod "Upshot"

2. Run pod install in your terminal to download SDK automatically:

cd ios && pod install

Platform-specific Setup

iOS Setup

1. Add required permissions to Info.plist:

   The app requires access to the device’s camera and photo library to enable image-sharing features in In-App Messages (IAM) and Badges.

<key>NSLocationWhenInUseUsageDescription</key>
<string>This app uses location to provide location-based features</string>
<key>NSCameraUsageDescription</key>
<string>This app uses camera for enhanced features</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>This app uses photo library for enhanced features</string>

2. Configure Background Modes (if needed):

<key>UIBackgroundModes</key>
<array>
    <string>remote-notification</string>
    <string>background-fetch</string>
</array>

3. Add push notification capability (if needed):
   • Enable Push Notifications in Xcode project settings
   • Add your APNs certificate or configure APNs key

Post-Installation Setup

1. Import the SDK in your iOS application:

Objective-C

@import Upshot;

Swift

import Upshot

For detailed import and initialization steps, refer to our Initialization.

Troubleshooting

Common Issues

iOS Build Issues:

• Clean build folder: Product → Clean Build Folder in Xcode
• Reinstall pods: cd ios && pod deintegrate && pod install
• Check iOS deployment target (minimum iOS 12.0)
• Verify framework is properly linked in Build Phases

CocoaPods Issues:

• Update CocoaPods: sudo gem install cocoapods
• Clear CocoaPods cache: pod cache clean --all
• Check for conflicting dependency versions

Framework Issues:

• Ensure Upshot.xcframework is added to Embedded Binaries
• Verify code signing settings for framework
• Check that framework is compatible with your Xcode version

Next Steps

• Initialize the SDK
• Setup Push Notifications
• Configure User Profiles
• Implement Event Tracking