Skip to content

Home

Jump to bottom
rohitphogat19 edited this page Mar 12, 2019 · 18 revisions

Welcome to the Channelize-iOS

Contents

Channelize-iOS

The following documentation is built to help you with installing our iOS SDKs into your project.

The Channelize SDK can be installed using the following method

Firstly, you will need to register on Channelize: https://channelize.io/pricing

After the successful payment at https://channelize.io/pricing you'll get the API URLs and Keys to run Channelize into your app.

  1. If you want to Use only Channelize API sdk, download Channelize-API.zip file from here
  1. If you want to use both Channelize API and UI SDK, download both Channelize-API.zip and Channelize.zip file from here.
  1. Extract these files, you will get framework files.
  2. Copy and paste these in your project directory.
  3. Drag and drop it in the Embedded Binaries section of your project

Integration

Dependencies

** Requirements ** Before we begin, please do make sure that

  • Your application is built on iOS 9.0 or above.
  • Since Channelize SDK as of now only supports Version 9.0 or higher.
  • You have Xcode 9.4.1 or later as your IDE to install and run Channelize SDK on iOS.
  • Swift 4 / 4.1

Pod Installation

If you are using only API SDK then you need followings pods

pod 'MQTTClient', '0.14.0'
pod 'MQTTClient/Websocket'
pod 'Alamofire', '4.7.3'
pod 'AlamofireObjectMapper', '5.1.0'

If you are using both API and UI SDK, then you need followings pods

pod 'MQTTClient', '0.14.0'
pod 'MQTTClient/Websocket'
pod 'Alamofire', '4.7.3'
pod 'AlamofireObjectMapper', '5.1.0'
pod 'Gallery', '2.0.6'
pod 'Lightbox', '2.1.2'
pod 'SwiftIconFont', '2.8.0'
pod 'CWStatusBarNotification', '2.3.5'
pod 'GiphyCoreSDK', '1.2.0'
pod 'Crashlytics', '3.10.7'
pod 'Chatto',  :git => 'https://github.com/BigStepTechnologies/Chatto', :branch => 'bigstep/v1.0'
pod 'ChattoAdditions',  :git => 'https://github.com/BigStepTechnologies/Chatto', :branch => 'bigstep/v1.0'
pod 'InputBarAccessoryView', '2.2.2'
pod 'SDWebImage/GIF'
pod 'ZVProgressHUD', '2.0.0'
pod 'ZVActivityIndicatorView', '0.1.2'

Configuration

  • Step 1 - Create a file with name Channelize-Info.plist as mentioned in the demo project.
  • Step 2 - Place required keys in the Channelize-Info.plist file according to

-> If you are using only API SDK, following keys are required

<key>PUBLIC_KEY</key>
<string>xxxx PublicKey xxxx</string>
<key>API_URL</key>
<string>xxxx API URL xxxxx </string>
<key>MQTT_URL</key>
<string>xxxxxxx MQTT URL xxxxxx</string>

-> If you are using both API and UI SDKs, then following keys are required

  • Map API Key => For Location Messages
  • GIPHY_API_KEY => For stickers and GIF messages
  • Note => You can skip these keys if you don't want to use Location and Stickers message. You have to disable them in UI SDK customization.
<key>MAP_API_KEY</key>
<string>xxxx Map Key xxxx</string>
<key>PUBLIC_KEY</key>
<string>xxxx PublicKey xxxx</string>
<key>API_URL</key>
<string>xxxx API URL xxxxx </string>
<key>MQTT_URL</key>
<string>xxxxxxx MQTT URL xxxxxx</string>
<key>GIPHY_API_KEY</key>
<string>xxxx GIPHY API Key xxxx</string>

Language File

If you are using UI SDK then, you need to create CHLocalizable.strings file in your project directory and put all strings from this url and change them according to you

CHLocalizable.strings

Permissions

Make sure you have the following permissions in your Info.plist file

<key>NSAppTransportSecurity</key>
  <dict>
  	<key>NSAllowsArbitraryLoads</key>
  	<true/>
  </dict>
  <key>NSCameraUsageDescription</key>
  <string>You can take photos to document your job.</string>
  <key>NSLocationAlwaysUsageDescription</key>
  <string>This app wants to access your location</string>
  <key>NSLocationWhenInUseUsageDescription</key>
  <string>This app wants to access your location</string>
  <key>NSPhotoLibraryUsageDescription</key>
  <string>You can select photos to attach to reports.</string>

Channelize API SDK Integration

Please visit this page for API SDK integration https://github.com/ChannelizeIO/Channelize-iOS/wiki/Channelize-API-SDK-Integration

Channelize UI SDK Integration

Please visit these page for UI SDK integration https://github.com/ChannelizeIO/Channelize-iOS/wiki/Channelize-iOS-UI-SDK-Documentation

Clone this wiki locally