MENU

Introduction

LiveChat Widget for iOS allows app users to contact support directly from the mobile application. The widget is very easy for developers to integrate into their existing iOS apps. Source code and installation instructions can be found on GitHub.

Version 2.0 of the widget has several significant improvements over the previous version that can be found here.

Requirements

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects.

Install it with the following command:

$ gem install cocoapods

To integrate LiveChat into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'LiveChat', '~> 2.0'
end

Then, run the following command:

$ pod install

Manual Installation

You can integrate LiveChat into your project manually without using a dependency manager.

Swift

Just drag all files from the LiveChat/Classes directory into your project.

Objective-C

Drag all files from the LiveChat/Classes directory into your project. When adding first *.swift file to Objective-C project, Xcode will ask you to create a Bridging Header. It is not necessary for LiveChat to work, so you can decline unless you plan to call Swift code from Objective-C. More information about bridging headers and Swift and Objective-C interoperability can be found here. You need to put following import statement: #import "<Your Project Name>-Swift.h" at the top of your .m file.

Also, for Objective-C projects, you need to set the Embedded Content Contains Swift Code flag in your project to Yes (found under Build Options in the Build Settings tab).

Usage

Initalization

import LiveChat

LiveChat.licenseId = "YOUR_LICENSE_ID"

Presenting Chat Widget

LiveChat.presentChat()

Setting Custom Variables

You can provide customer name or email if they are known, so customer will not need to fill pre-chat survey:

LiveChat.name = "iOS Widget Example"
LiveChat.email = "example@livechatinc.com"

If you want to associate some additional info with your customer, you can set Custom Variables:

LiveChat.setVariable(withKey:"Variable name", value:"Some value")

Notifying user about agent response

class YOUR_CLASS_NAME : LiveChatDelegate { // Your class need to implement LiveChatDelegate protocol
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
        LiveChat.licenseId = "YOUR_LICENSE_ID"
        LiveChat.delegate = self // Set self as delegate

        return true
    }

    func received(message: LiveChatMessage) {
        print("Received message: \(message.text)")
        // Handle message here
    }
}

You can notifiy your user about agent response if chat was minimized by the user. To handle incoming messages your class must implement LiveChatDelegate protocol and set itself as LiveChat.delegate.

Handling URL

func handle(URL: URL) {
    print("URL is \(URL.absoluteString)")
    // Handle URL here
}

By default, all links in chat messages are opened in Safari browser. To change this behavior you can use the LiveChatDelegate to handle URL's yourself.

Example Apps

Example apps can be found in the Examples folder. Samples for both Swift and Objective-C are provided.

Getting help

Any questions? Chat with Us!

License

LiveChat for iOS is available under the MIT license. See the LICENSE file for more info.