Get Started
Last updated
Was this helpful?
Last updated
Was this helpful?
Before you get started: Make sure you have and obtain the APP_KEY_SECRET.
You can install the TapTalk.io Omnichannel iOS SDK using like the following. If you are new to CocoaPods, you can see more information in . To create a Podfile, open a terminal window, navigate to your project directory, and then create a Podfile by running the following command in the terminal:
Then Podfile will be created in your project directory. Open the Podfile and add the following lines to the Podfile.
Note: For SDK version 1.1.0 and above, removeuse_frameworks!
and add additional pod implementation with modular headers to handle some compatibility issues.
For versions below 1.1.0, please remove pod 'AFNetworking
' and pod 'JSONModel'
implementation on the code above with use_frameworks!
Note: Please make sure you implement ios version 11.0platform :ios, '11.0'
for minimum deployment target to obtain latest update of TapTalk.io SDK
Since TapTalk.io use uses git-lfs
(Git Large Files Storage) you will need to install GIT LFS to clone/install TapTalk.io SDK through Cocoapods.
Note: Make sure to install git-lfs
before pod install, otherwise the pod install / pod update will be error
Next, after the git-lfs
is installed, install the TapTalk.io through CocoaPods.
To make sure TapTalk.io Omnichannel iOS have all permission to access user's media, file, location, and contact, the application needs to ask for permissions. Go to your info.plist, and add the following key-value pairs.
Information Property Key
Information Property Value
Privacy - Camera Usage Description
$(PRODUCT_NAME) needs to request access to your camera to take profile picture and to send image chat.
Privacy - Contacts Usage Description
$(PRODUCT_NAME) need your permission to access your contact, we will sync your contact to our server and automatically find your friend so it is easier for you to find your friends.
Privacy - Photo Library Additions Usage Description
$(PRODUCT_NAME) needs to request access to your photo library to save photo.
Privacy - Photo Library Usage Description
$(PRODUCT_NAME) needs to request access to your photo library to take profile picture and to send image chat.
Privacy - Location When In Use Usage Description
$(PRODUCT_NAME) needs to request access to your location to send location chat.
To enable background modes, go to Target -> Capabilities, then turn Background Modes toggle to ON, next select Background fetch and Remote notifications
After you turn on the Background Modes, Required background modes key will be added automatically in your Info.plist as shown below.
To allow the iOS SDK to respond to the connection and state changes in your iOS client app, you have to implement all of our application delegate methods in your UIApplicationDelegate
methods in appDelegate file.
After you initialize the TapTalk.io Omnichannel, you have to connect and implement these methods in your UIApplicationDelegate
methods in appDelegate file to make sure TapTalk.io Omnichannel runs smoothly in your application.
TapTalk.io Omnichannel Application Delegate Method
Description
application:didFinishLaunchingWithOptions:
Tells the delegate that the launch process is almost done and the app is almost ready to run.
applicationWillResignActive:
Tells the delegate that the app is about to become inactive.
applicationDidEnterBackground:
Tells the delegate that the app is now in the background.
applicationWillEnterForeground:
Tells the delegate that the app is about to enter the foreground.
applicationDidBecomeActive:
Tells the delegate that the app has become active.
applicationWillTerminate:
Tells the delegate when the app is about to terminate.
handleException:
Tells the delegate when application throws exception.
You have to add below code NSSetUncaughtExceptionHandler(&handleExceptions);
in application:didFinishLaunchingWithOptions:
method to register uncaught exception handler and add delegate function handleExceptions
.
Note: Don't forget to register for exception handler inside application:didFinishLaunchingWithOptions:
method and implement handleExceptions
method in appDelegate class to make sure TapTalk.io able to handle exceptions.
In order to use TapTalk.io Omnichannel, you must first initialize an instance by passing the APP_KEY_SECRET
and API_BASE_URL
assigned to your application to the initWithSecretKey:
method as a parameter. Generally, initialization is implemented in the appDelegate application:didFinishLaunchingWithOptions:
method.
To allow the Omnichannel iOS SDK to respond to the connection and state changes in your iOS client app, you have to implement all of our application delegate methods in your UIApplicationDelegate methods in appDelegate file. You can follow the instructions in Implement Application Delegate page.
To open TapTalk Omnichannel's view UI for your application, you can use the presentTapTalkLiveViewWithCurrentNavigationController:animated
or pushTapTalkLiveViewWithCurrentNavigationController:animated
method from the TapTalkLive class. This will open a homepage view controller containing a list of available channels, the user's latest case, and QnA path.
Easiest way to install is using :
Background modes is required to handle background process in TapTalk.io. It is used to run some processes in the background before the app is killed. For more information about the processes, check out the .
To enable location search result preview while sending location message, a Google Places API Key is required. To obtain the API key for your application, you can check provided by Google. To initialize, insert your obtained key using the initializeGooglePlacesApiKey()
method.