LiveEngage In-App Messaging iOS SDK

This read.me include the quick start guide for LiveEngage In-App Messaging iOS SDK in Swift and Objective-C.

SDK Documentation

Integration guide, API Documentation and Configurations can be found in Livepersons Developers Portal: https://developers.liveperson.com/consumer-experience-ios-sdk-quick-start.html

Prerequisites

To use the LivePerson In-App Messaging SDK, the following are required:

Version 3.1.1 and above

• XCode 9.3 or later
• Swift 4.1 or later, or Objective-C

Version 3.1 and below

• XCode 9.2 or lower
• Swift 4.0 or lower, or Objective-C

Note: For information on supported operating systems and devices, refer to System Requirements

Installation

LiveEngage In-App Messaging SDK for iOS supports multiple methods of installations.

Option 1: Using CocoaPods

The SDK is also compatible with CocoaPods, a dependency manager for Swift and Objective-C Cocoa projects. CocoaPods has thousands of libraries and is used in over 2 million apps. It can help you scale your projects elegantly and provides a standard format for managing external libraries.

1. Install cocoapods using the following command:

	$ gem install cocoapods

2. Navigate to your project folder and init new pod using the following command:

	$ pod init

3. Podfile should be created under your project’s folder. To integrate Liveperson Messaging SDK into your Xcode project using CocoaPods, specify it in your Podfile:

	source 'https://github.com/LivePersonInc/iOSPodSpecs.git'
	platform :ios, '9.0'
	use_frameworks!

	target '<Your Target Name>' do
	    pod 'LPMessagingSDK'
	end

4. Run the following command in the terminal under your project folder:

	$ pod install

5. Incase you wish to upgrade to the latest SDK version and you have already ran 'pod install', Run the following command:

 $ pod update

6. In project settings, navigate to the Build Phases tab, and click the + button to add a New Run Script Phase. Add the script below in order to loop through the frameworks embedded in the application and remove unused architectures (used for simulator). This step is a workaround for known iOS issue and is necessary for archiving your app before publishing it to the App Store.

   bash "${SRCROOT}/Pods/LPMessagingSDK/LPMessagingSDK/LPInfra.framework/frameworks-strip.sh"
   

Option 2: Using Libraries Copy to Xcode Project

1. Click here to download the SDK package.

2. Once downloaded, extract the ZIP file to a folder on your Mac.

3. Copy (Drag and Drop) all framework and bundle files into the project.

4. In project settings, navigate to the Build Phases tab, and make sure to have LPMessagingSDKModels.bundle under Copy Bundle Resources.

5. In project settings, navigate to the Build Phases tab, and click the + button to add a New Run Script Phase. Add the script below in order to loop through the frameworks embedded in the application and remove unused architectures (used for simulator). This step is a workaround for known iOS issue and is necessary for archiving your app before publishing it to the App Store.

bash "${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/LPInfra.framework/frameworks-strip.sh"

Step 2: Configure project settings to connect LiveEngage SDK

1. In project settings, navigate to the General tab, and add all Framework files to the Embedded Binaries section.

2. In the General tab, make sure that the framework files are under Embedded Libraries.

3. In Build settings, make sure Always Embed Swift Standard Libraries is set to YES.

4. Due to a new Apple policy for iOS 10 (or later), apps must declare in their project settings which privacy settings may be used. For more information, refer to Apple’s website In Xcode info.plist of the project, add two new privacy keys and values:

• Key: NSPhotoLibraryUsageDescription, Value: "Photo Library Privacy Setting for LiveEngage In-App Messaging SDK for iOS",
• Key: NSCameraUsageDescription, Value: "Camera Privacy Setting for LiveEngage In-App Messaging SDK for iOS"
  This step is required in order to be able to upload your host app into the App Store, as SDK 2.0 has the ability to share photos from the camera and/or photo library. Note: Due to Apple policy, this step is mandatory even if the photo sharing feature is disabled in the SDK.

5. Some XCode Project's Capabilities need to be switched on in order to support SDK specific features. In XCode, navigate to project's Targets settings and select the relevant target of your app, then navigate to 'Capabilities' tab.

• Push Notifications: SDK uses remote push notification to notify the user whenever a new message from remote user has been received. To use remote push notifications, switch on 'Push Notifications' toggle.
• Structured Content: map items require MapKit framework to show location in map. To use map items, switch on 'Maps' toggle.

License

All usage of the contents, documentation or code found in this repository is subject to the LivePerson API Terms of Use. Please use the link above to read them carefully before utilizing the site.