Cobrowse - IOS SDK

iOS SDK

Installation

The SaleAssist Cobrowse SDK for iOS is available for installation via several dependency managers, or as frameworks to integrate directly into your project:

SPM

https://github.com/cobrowseio/cobrowse-sdk-ios-binary.git

Add the CobrowseIO package dependency to your app targe

Pod

pod 'CobrowseIO', '~>2'

Don't forget to run pod repo update then pod install after you've edited your Podfile.

Make sure you are on the latest stable version of Pods. Run pod --version to check!

Note: Depending on your project, you may also need use_frameworks! in your Podfile.

Carthage

binary "https://raw.githubusercontent.com/cobrowseio/cobrowse-sdk-ios-binary/master/cobrowse-sdk-ios-binary.json" ~> 2.0

Remember to run carthage update after modifying your Cartfile.

More information about Carthage at https://github.com/Carthage/Carthage#if-youre-building-for-ios-tvos-or-watchos.

Link the CobrowseIO.framework to your main app target that can be found at ./Carthage/Build/iOS.

Manual

Frameworks are available for manual integration into your Xcode projects from:

https://github.com/cobrowseio/cobrowse-sdk-ios-binary/releases

Add the following lines to your code which will register this device with the SaleAssist Cobrowse servers so you can connect to it. You could choose to do this on app startup, or when your users visits a support page in your application, or any other time.

Swift

import CobrowseIO
...

CobrowseIO.instance().license = "put your license key here"
CobrowseIO.instance().start()

Objective-C

@import CobrowseIO;
...

CobrowseIO.instance.license = @"put your license key here";
[CobrowseIO.instance start];

Registering on startup

If you would like your devices to register as soon as your app starts, we recommend doing this in your app delegate application:didFinishLaunchingWithOptions: method. For example:

Swift

import CobrowseIO

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool
{
    CobrowseIO.instance().license = "put your license key here"
    CobrowseIO.instance().start()
    return true
}

Objective-C

@import CobrowseIO;

- (BOOL)application:(UIApplication*) application didFinishLaunchingWithOptions:(NSDictionary*) launchOptions
{
    CobrowseIO.instance.license = @"put your license key here";
    [CobrowseIO.instance start];
    return YES;
}

Identify your devices

Read here for Identifying your devices to cobrowse.

Add your License Key

Please register an email at [email protected] to get your License Key.

This will associate sessions from your mobile app with your SaleAssist Cobrowse account.

Requirements

• iOS 11.0 or later