IOS

• Requirements

• Installation

  • Swift Package Manager
  • CocoaPods
  • XCFramework
• Configuration

• Components

  • SearchBoxView
  • EmpathizeView
  • QuerySuggestionsView
  • PopularSearches

• Xcode 12.x
• Swift 5.x
• iOS 11.0
• RxSwift as an external dependency

XAPPSClient contains RxSwift as external dependency.

These are currently the supported installation options.

Swift Package Manager

Inside your Xcode project, select File > Swift Packages > Add Package Dependency and enter repository URL:

https://github.com/empathyco/x-apps-customername-ios-releases.git

CocoaPods

Add the following pods XAPPSClient, XAPPSCore and RxSwift

1
2
3
4
5
6
7
8
9
10
11
12
# Podfile
use_frameworks!

target 'YOUR_TARGET_NAME' do
    pod 'XAPPSClient', :git => 'https://github.com/empathyco/x-apps-customername-ios-releases.git', :tag => '1.0.0'
    pod 'XAPPSCore', :git => 'https://github.com/empathyco/x-apps-ios-core-releases.git', :tag => '1.0.0'
    pod 'RxSwift', '6.0.0' 
end

target 'YOUR_TESTING_TARGET' do
    
end

Replace YOUR_TARGET_NAME and then, in the Podfile directory, type:

1
$ pod install

XCFramework

Each release includes *.xcframework framework binaries. Simply drag the needed framework binaries to your Frameworks, Libraries, and Embedded Content section under your target’s General tab.

Add the following XCFrameworks XAPPSClient, XAPPSCore and RxSwift*

To get these XCFrameworks files (XAPPSClient and XAPPSCore), download release as a zip ( https://github.com/empathyco/x-apps-customername-ios-releases/archive/main.zip ).

*RxSwift : Empathy uses RxSwift as an external dependency. Please check the installation RxSwift info, to add it to your project (Only when you are adding Empathy with CocoaPods or XCFramework).

Init Empathy XAPPS Client in AppDelegate :

• Default Configuration

1
2
3
4
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    EmpathyClient.init()
    return true
}

• Custom Configuration, using a ClientConfiguration object to initialize EmpathyClient

1
2
3
4
5
6
7
8
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    let clientConfig = ClientConfiguration()
    clientConfig.catalogue = ConfigurationParameter("your-key-here", "your-value-here")
    clientConfig.store = ConfigurationParameter("your-key-here", "your-value-here")
    clientConfig.warehouse = ConfigurationParameter("your-key-here", "your-value-here")
    EmpathyClient.init(clientConfiguration: clientConfig)
    return true
}

Client Configuration

This is the list of parameters that are currently supported:

SearchBoxView

Use

To get a SearchBoxView you can add the view in the storyboard or in the code.

• Code

1
2
3
4
5
6
7
8
9
10
11
12
public lazy var searchBoxCode: SearchBoxView = {
    return SearchBoxView(frame: .zero)
}()

override func viewDidLoad() {
    super.viewDidLoad()
    self.view.addSubview(searchBoxCode)
    searchBoxCode.topAnchor.constraint(equalTo: view.topAnchor, constant: 50).isActive = true
    searchBoxCode.leftAnchor.constraint(equalTo: view.leftAnchor, constant: 10).isActive = true
    searchBoxCode.rightAnchor.constraint(equalTo: view.rightAnchor, constant: -10).isActive = true
    searchBox?.heightAnchor.constraint(greaterThanOrEqualToConstant: 50).isActive = true
}

• Storyboad

1. Add new UIView component into your storyboard

2. In Identity inspector, change the Class to SearchBoxView and Module to XAPPSClient

   

3. Link SearchBoxView to ViewController

   

Listener

To get SearchBoxView actions callback. You need to implement the BaseSearchBoxDelegate in the ViewController

Configuration

Work in progress ….