App Distribution for iOS, Android and Windows
DashboardStart for free
  • Updraft App Distribution Documentation
  • Microsoft App Center Alternative
    • Windows App Distribution
    • App Center Migration Tool
  • Welcome to Updraft!
    • What is Updraft?
  • Quickstart
    • Register your Organization
    • Your first app project
      • Upload your first app versions (builds)
      • Install your app
  • Dashboard
    • Create Projects
    • Latest received Feedbacks
    • Documentation
    • Usermanagement
      • Permission Groups
      • Tester Dashboard
    • Profile & User Account
      • Profile Preferences
        • Two-factor authentication
      • Personal token
      • Notifications
      • Organizations
      • Account Settings
      • Plan & Billing
        • Free Plan
        • Paid Plan (Pay-As-You-Go)
      • Security (Single Sign-On)
        • Single Sign-On with Okta
        • Single Sign-On with Google Worspace
        • Single Sign-On with Microsoft Entra
        • Single Sign-On with JumpCloud
        • Single Sign-On with Ping Identity
        • Custom SSO (SAML)
      • Developer Accounts
        • App Store Connect API
        • Google Play Developer API Integration Guide
  • Your Projects
    • Project Settings
      • Overview
      • Automatically clean up build binaries
      • Notification Integrations
        • Slack integration
        • Webhook integration
        • Microsoft Teams integration
        • Discord integration
        • WebEx integration
      • User & Permissions
    • App Overview & App Settings
      • Notifications
      • Security
      • Last uploaded build
      • Add another app to your project
      • Android App Bundle (AAB)
    • Builds and App versions
      • Build history / app version history
        • iOS Resigning
        • Android Resigning
      • Release Notes
      • Exchange already uploaded app version
      • Distribute and install a pre-release version of your app
        • App download page
    • Feedback
    • App Distribution
      • Testers & Distribution Groups
      • Distribute your app
        • Single Release
        • Beta Release (one link two apps)
        • Store
          • App Store Distribution
          • Play Store Distribution
      • Release History
      • Install an app distributed from Updraft
  • Integrations
    • Jenkins Plugin Updraft
    • Fastlane
    • Gradle
    • Teamcity with Gradle (Android)
    • Teamcity
    • GitLab CI/CD
      • GitLab iOS with Fastlane
      • GitLab app distribution for iOS builds
      • GitLab app distribution for Android builds
    • Bitrise
  • API
    • Upload API
    • Upload Apps with CURL
    • Rest API
      • Distribution group and Permission group API
  • Updraft SDK
    • Autoupdate
    • Integrating Updraft Android SDK
    • Integrating Updraft iOS SDK
    • Integrating Updraft Flutter SDK
  • Android
    • Unknown sources in Android
    • .apk installation on Samsung Browser
    • Android FAQ
    • 🪅Android Icon Troubleshooting
    • Google Play Store upload issues
  • iOS
    • Untrusted Enterprise Developer
    • Code Signing Explained (Certificates, Identifiers, Profiles – what?)
    • Registering a UDID for Ad Hoc Distribution
    • What does "App could not be installed at this time" mean?
    • iPadOS on Safari
    • iOS FAQ
  • Data Security
    • Data hosting in Switzerland
      • Swiss data privacy law
    • End to end data encryption
    • General Data Protection Regulation (GDPR)
    • Single Sign On (SSO)
    • Custom Storage
      • Google Cloud Storage
      • Custom S3 bucket
    • ISO 27001
  • What's New/ Changelog
  • Roadmap
  • FAQ
  • Contact us
Powered by GitBook
On this page
  • Github
  • Requirements
  • Installation
  • Setup
  • Auto Update
  • Feedback & Bug Reporting
  • Advanced setup
  • Base URL
  1. Updraft SDK

Integrating Updraft iOS SDK

Updraft iOS Open Source SDK is a Framework to support getupdraft.com mobile app distribution for iOS Apps. The SDK includes a graphical feedback & bug reporter and automatic app updating features.

PreviousIntegrating Updraft Android SDKNextIntegrating Updraft Flutter SDK

Last updated 9 months ago

Github

Requirements

  • iOS 10.0+

  • Xcode 9.0+

  • Swift 4.0+

Installation

CocoaPods

pod 'UpdraftSDK'

Then, run:

pod install

Carthage

github 'appswithlove/updraft-sdk-ios'

Then, run:

carthage update

In your application targets “General” tab under the “Linked Frameworks and Libraries” section, drag and drop Updraft.framework from the Carthage/Build/iOS directory that carthage update produced.

Setup

Swift

  1. Import Updraft module in AppDelegate:

    import Updraft
  2. Start the SDK with your "SDK Key" and "App Key":

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    	
    	Updraft.shared.start(sdkKey: "YOUR_SDK_KEY", appKey: "YOUR_APP_KEY")
    		
    	return true
    }

Objective-C

  1. Import Updraft module in AppDelegate

    @import Updraft;
  2. Start the SDK with your "SDK Key" and "App Key":

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    
    		[[Updraft shared] startWithSdkKey:@"YOUR_SDK_KEY" appKey:@"YOUR_APP_KEY" isAppStoreRelease: false];
    
    		return YES;
    	}

Parameters

Auto Update

AutoUpdate work by comparing the build number of the app installed on the user's device and the app uploaded on GetUpdraft.

A prompt is displayed to the user if his installed version is lower than the version on Updraft. Thus, the build number must be incremented for each new build release to trigger the auto-update process.

Micro version comparison is supported, for example version 1.2.3.20180804 is greater than version 1.2.3.20180803

Feedback & Bug Reporting

A prompt is shown to the user to inform him of the change of state of the feedback functionality.

If enabled, the user is explained how he can give feedback. User can take a screenshot to give a feedback.

Advanced setup

Logging

To check if data is send properly to Updraft and also see some additional SDK log data in the console, you can set different log levels.

To change the log level, add the following line before starting the SDK:

Swift

Updraft.shared.logLevel = .info

Objective-C

[Updraft shared].logLevel = LogLevelInfo;

Default level: warning => Only warnings and errors will be printed.

Base URL

If you have your own instance of Updraft, set this property to the base URL of your instance, before starting the SDK.

Swift

Updraft.shared.baseUrl = "https://your_base_url/"

Objective-C

[Updraft shared].baseUrl = @"https://your_base_url/";

Get and specify UpdraftSDK in your Podfile:

Get and specify Updraft in your Cartfile:

sdkKey: Your sdk key obtained on

appKey: You app key obtained on

Auto Update functionality can be enabled/disabled on in your app edit menu.

Feedback functionality can be enabled/disabled on in your app edit menu.

Default

CocoaPods
Carthage
Updraft
Updraft
getupdraft.com
getupdraft.com
https://getupdraft.com/
GitHub - appswithlove/updraft-sdk-ios: Updraft SDK for iOSGitHub
Updraft iOS SDK Github
Logo