/kustomer-ios

Primary LanguageObjective-COtherNOASSERTION


The iOS SDK for the Kustomer.com mobile client

Documentation and guides

See our official docs and guides

Requirements

Installation

Swift Package Manager

  1. Create or open your project inside of Xcode
  2. Navigate to File > Swift Packages > Add Package Dependency
  3. Enter https://github.com/kustomer/kustomer-ios in the URL field
  4. Use the Up to Next Major Version rule spanning from 2.0.0 < 3.0.0, and hit the Next button

Cocoapods

  1. Add pod 'KustomerChat', :git => 'https://github.com/kustomer/kustomer-ios.git' to your Podfile
  2. Run pod update or pod install on your project

Manual

  1. Add KustomerChat.xcframework and KustomerNetworking.xcframework to your project's Frameworks, Libraries, and Embedded Content section.
  2. Check Embed & Sign for both frameworks.

Post-Install

  1. Add photo and camera privacy descriptions to your Info.plist.
  2. In the application(_:didFinishLaunchingWithOptions:) method of your AppDelegate add
Kustomer.configure(apiKey: "API_KEY_HERE", options: nil, launchOptions: launchOptions)
  1. Call Kustomer.show() whenever and wherever you want to open the Kustomer chat interface.

See Installation for a full guide.

Example app

  • Open Example/Example.xcodeproj
  • Set your API key in AppDelegate.swift
    • Your API key must have only the org.tracking role. You can get your API key from the Kustomer website.
  • Run the app