Getting started

Learn how to add the OpenWeb SDK to your iOS app.

The OpenWeb iOS SDK empowers you to create an in-app user experience that fuels quality interactions with community and content, enabling users to make engaging and valuable contributions.

Specifically, the iOS SDK offers the following benefits:

  • Simple, straightforward API with the flexibility to use UIViews over just UIViewControllers
  • Comprehensive error states, report reasons, and a clarity mode for reliable app development
  • Robust, stable SDK foundation, supported by performance enhancements like background threading
  • New design preset options to seamlessly integrate the user experience with your brand's aesthetic
  • Stunning shimmering skeletons while loading data


Requirements

  • iOS 12.0 or later
  • OpenWeb account
  • Xcode


Add the iOS SDK

To add a Conversation to your app, you must import the OpenWeb iOS SDK and then configure your project.

You can add the iOS SDK using either Cocoapods or Swift Package Manager.


Using Cocoapods

  1. In a text editor, open Podfile.
  2. Add pod 'SpotIMCore', '2.1.0.
target 'OpenWeb-SDK-iOS-Demo' do
  # Use one of those options
  use_frameworks!
  # use_frameworks! :linkage => :static

  # Pod for OpenWeb-SDK
  pod 'SpotIMCore', '2.1.0'
end
  1. In Terminal, at the terminal prompt of your project directory, execute pod install to install the dependencies added to Podfile.
  2. Open the .xcworkspace file for your project to launch Xcode.

Using Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the Swift compiler. Once you have your Swift package set up, add SpotIM to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/SpotIM/spotim-ios-sdk-pod.git", .upToNextMajor(from: "2.1.0"))
]


Next Step