In‐app chat

Find more info about Live chat product on Infobip docs.

• Intro
• Display In-app chat view
• Customize In-app chat view
• Handle notification taps
• Library events
• Sending attachments
• Attachments preview
• Supported attachment types

Intro

In-app chat SDK is built on top of Mobile Messaging SDK and that's why Mobile Messaging should be included into your application and properly configured. If you haven't used Mobile Messaging SDK in you application yet, then please follow Quick start guide to enable it.

Then you will need to add In-app chat SDK as a dependency into your iOS app by adding the following line in to your Podfile:

pod 'MobileMessaging/InAppChat'

And start In-app chat component by adding withInAppChat() to the MobileMessaging initialization chain:

MobileMessaging
	.withApplicationCode(<# your application code #>, notificationType: <# your notifications types preferences #>)?
	.withInAppChat() // this line prepares In-app chat service to start
	.start()

Display In-app chat view

Mobile Messaging In-app chat SDK provides a built-in chat view which you can quickly embed into your own application. Key component to use is ChatViewController. We support two ways of using it:

• via Interface Builder: set "ChatViewController" as Custom class name for your view controller object.
• programmatically: by presenting the appropriate chat view controller instance from an arbitrary parent view controller, for example:

If you want it to be with top bar, it will have dismiss(x) button:

if let rootVC = UIApplication.shared.keyWindow?.rootViewController {
	let chatVC = ChatViewController.makeRootNavigationViewController()
	rootVC.present(chatVC, animated: true)
}

or, if you have navigation controller, you can push chat view controller to it, navigation bar will have back button.

let vc = ChatViewController.makeChildNavigationViewController()
navigationController?.pushViewController(vc, animated: true)

or, if you want view controller to be presented modally, it will be without top bar.

if let rootVC = UIApplication.shared.keyWindow?.rootViewController {
	let chatVC = ChatViewController.makeModalViewController()
	rootVC.present(chatVC, animated: true)
}

Customize In-app chat view

You can define your own custom appearance for chat view by accessing a chat settings object: MobileMessaging.inAppChat.settings. The following settings are available for customizations:

• title (String) - title for navigation bar when using NavigationViewController
• sendButtonTintColor (UIColor) - tint color for Send button
• navBarItemsTintColor (UIColor) - tint color of navigation bar items when using NavigationViewController
• navBarColor (UIColor) - color of navigation bar when using NavigationViewController
• navBarTitleColor (UIColor) - color of title of navigation bar when using NavigationViewController

Handle notification taps

Mobile Messaging SDK has notificationTapHandler closure that takes as parameter MTMessage object. This closure will be executed when user opens the app by tapping on the notification alert. Default implementation marks the corresponding message as seen.

Default implementation can be substituted with custom implementation. Note that chat messages may be recognized by MTMessage.isChatMessage attribute:

MobileMessaging.notificationTapHandler = { message in
	if message.isChatMessage {
		print("Chat message with text: \(message.text) was tapped")
		<# your custom handling here #>
	}
}

Library events

Mobile Messaging SDK supports MMNotificationInAppChatAvailabilityUpdated event - Library-events, which is posted after the in-app chat availability status received from backend server. The userInfo dictionary contains the following key: MMNotificationKeyInAppChatEnabled - contains boolean value.

Sending attachments

Starting from 8.1.0 SDK version, we added sending attachments feature. In order to be able to choose attachment, you application need to be able to open photo library to choose the file or use camera and microphone to capture photo and video. By the Apple policies you will need to add following keys with text descriptions to your App's Info.plist file:

• NSPhotoLibraryUsageDescription
• NSCameraUsageDescription
• NSMicrophoneUsageDescription

To enable document picker, you will need to turn on the iCloud Documents capabilities in Xcode.

Attachments preview

Starting from 8.3.0 SDK version, we added attachments preview feature. Supported file types are Images, Videos and PDFs.

In order to be able to save attachment to photo library, by the Apple policies you will need to add following key with text description to your App's Info.plist file:

• NSPhotoLibraryAddUsageDescription

Supported attachment types

Media type	File size	File format
image	10MB	JPG, JPEG, PNG
audio	10MB	M4A
video	10MB	MP4
document	10MB	PDF