Skip to content

upscopeio/cobrowsing-ios

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Upscope iOS SDK

Version License Platform

Requirements

  • iOS 16.0+
  • Swift 5.9+
  • Xcode 15.0+

Installation

CocoaPods

Add the following line to your Podfile:

pod 'UpscopeIO', '~> 2025.11.6'

Then run:

pod install

Swift Package Manager

Add the following dependency to your Package.swift:

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

Quick Start

1. Initialize the SDK

import UpscopeIO

// In your AppDelegate or App initialization
let upscopeManager = UpscopeManager(apiKey: "YOUR_API_KEY")
UpscopeManager.shared = upscopeManager  // Required for redaction to work
upscopeManager.connect()

2. Generate a Session Code

// Generate a code for your support agent
let code = upscopeManager.getCode()
print("Share this code with support: \(code)")

3. Redact Sensitive Information

SwiftUI

TextField("Credit Card", text: $creditCardNumber)
    .upscopeRedacted()

SecureField("Password", text: $password)
    .upscopeRedacted()

UIKit

creditCardTextField.markAsRedacted()
passwordTextField.markAsRedacted()

Advanced Usage

Custom Configuration

let config = PartialConfiguration(
    settings: PartialConfiguration.Settings(
        requireAuthorizationForSession: true,
        authorizationPromptTitle: "Screen Sharing Request",
        authorizationPromptMessage: "Support would like to view your screen",
        endOfScreenshareMessage: "Thank you for sharing your screen. The session has ended.",
        translationsOk: "OK"
    )
)

let upscopeManager = UpscopeManager(
    apiKey: "YOUR_API_KEY",
    localConfig: config
)

Session Management

// Start a session programmatically
upscopeManager.startSession()

// End the current session
upscopeManager.endSession()

// Get session status
if let session = upscopeManager.session {
    print("Session ID: \(session.id)")
    print("Status: \(session.status)")
}

Documentation

For comprehensive documentation, visit https://cobrowsingapi.com/docs

Support

Version

Current version: 2025.11.6

About

Co-Browsing for iOS

Resources

License

Stars

Watchers

Forks

Packages

No packages published