UserView Logo
UserViewby Upscope

Documentation

Installation

Beta
The mobile SDKs are currently in beta. If you encounter any issues, please contact us.

Requirements

  • iOS 14.0+
  • Swift 5.9+
  • Xcode 15.0+

Installation

Add the package dependency to your Package.swift:

dependencies: [
    .package(url: "https://github.com/upscopeio/cobrowsing-ios.git", from: "2026.3.13")
]

Or add it through Xcode: 1. Go to File > Add Package Dependencies 2. Enter https://github.com/upscopeio/cobrowsing-ios.git 3. Select the version and add to your target

Initialization

Initialize the SDK in your AppDelegate or App struct:

import UpscopeIO

let config = UpscopeConfiguration(apiKey: "YOUR_API_KEY")
try Upscope.shared.initialize(with: config)

The SDK auto-connects by default. To disable this, set autoConnect: false in the configuration and call Upscope.shared.connect() manually when ready.

SwiftUI App Example

import SwiftUI
import UpscopeIO

@main
struct MyApp: App {
    init() {
        let config = UpscopeConfiguration(apiKey: "YOUR_API_KEY")
        try? Upscope.shared.initialize(with: config)
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

UIKit AppDelegate Example

import UIKit
import UpscopeIO

@main
class AppDelegate: UIResponder, UIApplicationDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        let config = UpscopeConfiguration(apiKey: "YOUR_API_KEY")
        try? Upscope.shared.initialize(with: config)
        return true
    }
}

Public API Key

You can find your public API key in the installation page of your UserView dashboard.

iPad Split Screen Support

The SDK automatically handles iPad split screen scenarios. Each app instance captures only its own portion of the screen, and alerts appear on the correct window. No additional configuration is required.

Lookup Code on Shake

By default, shaking the device will display the lookup code in an alert. This can be disabled via configuration options.