Let's integrate our SDK in few minutes

Quick Start#

Download SDK Files

Chat SDKs for iOS#

Make an easy and efficient way with CONTUS MirrorFly Chat SDK for iOS - simply integrate the real-time chat features and functionalities into a client's app.

With client-side implementation, our chat SDK lets you initialize and configure the chat easily. With the server-side, Our solution ensures the most reliable infra-management services for the chat within the app. Furthermore, we will let you know how to install the chat SDK in your app for a better in-app chat experience.

Note : To obtain a fastest way in action using CONTUS MirrorFly Chat SDKs, you must try our trial app to enhance your chat app. So, just download our sample app and start with your app development. Click here to download the sample app.

Requirements#

The below are the requirements for chat SDK for iOS,

Xcode 13 or later
iOS 12.1 or later
Swift 5.0 or later

Points to be Noted Before Making a Move#

SDK License Key#

Before proceeding with CONTUS MirrorFly Chat SDK integration, there must be an SDK license key that needs to be obtained for your MirrorFly application.

This SDK must be authenticated by the MirrorFly server by making use of the license key for further processing.

To obtain your license key you need to follow the below steps:#

Step 1: Signup into MirrorFly Console page (https://console.mirrorfly.com/register) to create a free MirrorFly account.

Step 2: You can provide your basic details like your name, organization details, work email, and contact number while creating an account.

Step 3: Once you’re in! You get access to your MirrorFly account ‘Overview page’ where you can find the downloadable iOS SDK for further integration process.

Step 4: To download the frameworks, click on the ‘Download’ button, this will take you to the top of this guided documentation page. Here, click on the given ‘Download button’ and extract the frameworks from the ZIP folder.

Step 5: After downloading the files, You have to create a new project to start with integration process to build your chat app for iOS.

Integrate Chat SDK#

Since the SDKs were compiled into multiple XCFramework binary packages you need to start with SDK integration. Thus, you have to follow the below given steps,

Step 1: First extract the xcframework files from the downloaded zip file that is provided at the top of this guided documentation. Once extracted you get the following xcframeworks.

FlyCore.xcframework
FlyCommon.xcframework
FlyNetwork.xcframework
FlyDatabase.xcframework
FlyXmpp.xcframework
FlyTranslate.xcframework
FlyCall.xcframework

Frameworks

Step 2: Add all the extracted xcframeworks to your project.

Goto Project ->  Target -> General -> Frameworks,libraries and Embedded Content -> Select Embed & Sign for all the Chat SDK's xcframeworks

EmbedAndSign

Step 3 : Now, disable the bitcodes for your project

Goto Project -> Build Settings -> Filter the term `Bitcode` -> and select No from the dropdown

Bitcode

Step 4: If you have not initiated any pods project before, then initiate the one. Now, add the required pods that are necessary for the SDK to execute the process perfectly.

 pod 'libPhoneNumber-iOS'
 pod 'Alamofire'
 pod 'RealmSwift', '10.20.1'
 pod 'XMPPFramework/Swift'
 pod 'SocketRocket'
 pod 'Socket.IO-Client-Swift'
 pod 'GoogleWebRTC'

Step 5: Add the below given pod hook code block at the end of the pod file and thus, finally install the pods.

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '12.1'
      config.build_settings['ENABLE_BITCODE'] = 'NO'
      config.build_settings['APPLICATION_EXTENSION_API_ONLY'] = 'No'
      config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
    end
  end
end

Podfile

Step 6: Now, enable all the below mentioned capabilities into your project.

Goto Project -> Target -> Signing & Capabilities -> Click + at the top left corner -> Search for the capabilities below

Capabilities
App Groups
Background Modes

Now, go to the background mode and enable the below given modes

Background Modes
Audio,Airplay, and Picture in Picture
Background fetch
Remote notifications

Capabilities

Configure the SDK server & Data#

Now, configure the server details in SDK and access the data globally using the AppDelegate class.

You can copy the license key from the 'Overview’ section in the Console dashboard.

let BASE_URL = "https://api-preprod-sandbox.mirrorfly.com/api/v1/"
let LICENSE_KEY = "xxxxxxxxxxxxxxxxxxxxxx"
let CONTAINER_ID = "xxxxxxxxxxxxxxxxxxxxxx"

Parameter Description#

Function	Parameter Type	Description
CONTAINER_ID	`String`	Create App groups and assign the obtained group container id. SDK uses this string to create the path for the local storage.

Initialize ChatSDK#

To start using the sdk, there are a few basic pieces of data that must be made available for the SDKs to function perfectly.

Thus, we utilize the usage of the ChatSDK builder class making the data available for SDKs. Furthermore, in your project you must use the AppDelegate class within the didFinishLaunchingWithOptions method and also provide required data to build the ChatSDK Builder. Let's have a look at the example given below.

Swift
Objective-C

try? ChatSDK.Builder.setAppGroupContainerID(containerID: CONTAINER_ID)
      .setLicenseKey(key: LICENSE_KEY)
      .isTrialLicense(isTrial: true)
      .setDomainBaseUrl(baseUrl: BASE_URL)
      .buildAndInitialize()

AppDelegate

Chat Builder Function Description#

Function	Parameter Type	Description
setAppGroupContainerID	`String`	Pass group container id of the project that stores UserDefaults and Database
setLicenseKey	`String`	Used to proceed with Registration
isTrialLicense	`Bool`	If the obtained license key is a trial license key - display the message as `true` else `false`
setDomainBaseUrl	`String`	Url required to make API calls
buildAndInitialize	n/a	Initialize the chat configuration

caution

The base url must have Http/Https protocol which should be closed with a slash (/), or else will display an exception bug message.

Registration#

The below method should be called to register a new user. This method will take care of both Sandbox mode registration as well as Live mode registration based on isTrialLicense provided in the ChatSDK.Builder class.

info

Unless you logged out of a session, make sure that you have called the Registration method only once in an application

Note: If the below registerApiService methods are available at the time of registration then can be passed across for further processing wherein, can be accepted as an optional param.

APNS_DEVICE_TOKEN
VOIP_TOKEN
IS_EXPORT

Swift
Objective-C

try! ChatManager.registerApiService(for:  USER_IDENTIFIER ) { isSuccess, flyError, flyData in
        var data = flyData
        if isSuccess {
         // This is your Password
           guard let password = data["password"] as? String else{
               return
           }
           // This is your Username
           guard let username = data["username"] as? String else{
               return
           }
        }else{
            let error = data.getMessage()
            print("#chatSDK \(error)")
        }
    }

Argument	Type	Description
USER_IDENTIFIER	`String`	Unique Id to Register the User
APNS_DEVICE_TOKEN	`String`	Token to register APNS device (optional)
VOIP_DEVICE_TOKEN	`String`	Token to register VoIP device (optional)
IS_EXPORT	`Bool`	`true` for production(apns certificate) builds and `false` for sandbox(apns certificate)builds
CALLBACK	`FlyCompletionHandler`	`FlyCompletionHandler` is implemented and expressed as lambda expression

To know more about FlyCompletionHandler click here

info

Save your own contact details in DB after registration. Your contact detail will be used while sending group messages. Call below method to save your own contact details,

ContactManager.shared.saveTempContact(userId: "OUR OWN JID" , name: "OUR NAME")

To generate a unique user id, you must pass the username in the method String userJID = FlyUtils.getJid(USERNAME)

Connect to the Chat Server#

Whenever you are planning to send a message using the Chat SDK, first you have to establish a connection to the chat server using the below given method.

Swift
Objective-C

ChatManager.connect()

Disconnect Chat Server#

Use the below given method to disconnect from the chat server call.

Swift
Objective-C

ChatManager.disconnect()

Observe Connection Events#

The connection status can be observed and tracked by confirming the ConnectionEventDelegate. To do that you need to set ‘delegate’ in your ViewController's viewDidAppear method like below.

Swift
Objective-C

  ChatManager.shared.connectionDelegate = self

Once the ConnectionEventDelegate has been set, you will be able to receive the connection status in the delegate method as mentioned below. Learn more about this method @ ConnectionEventDelegate.

Swift
Objective-C

     func onConnected() {
        // Navigate to Conversation screen
     }

Terminology#

The below given are some of the common keyword/terminologies used in the Chat SDK with description

Keyword	Description
userID/userBareID	Unique ID assigned for each user Ex: 12345678 (any alphanumeric). The below characters is not allowed in userId: U+0022 (") U+0026 (&) U+0027 (') U+002F (/) U+003A (:) U+003C (<) U+003E (>) U+0040 (@) userID should follow below specification: https://xmpp.org/extensions/xep-0106.html
userJid (or) JID	userID+@+domain of the chat server Ex. 12345678@xmpp.chatsystem.dev.contus.us
groupID/groupBareID	Unique ID assigned for each group Ex: group123456 (any alphanumeric). GroupJID = groupID +@mix.+domain of the chat server Ex: group123456@mix.xmpp.mirrorfly.dev.contus.us`

info

SDK here provides the built-in functions to prepare the JID and Group JID.

Send a One-to-One Message#

The below method is used to send a text message from one user to another.

Note: To generate a unique user id, you must call the other user's username in the method String userJID = FlyUtils.getJid(USERNAME)

Swift
Objective-C

FlyMessenger.sendTextMessage(TO_JID, TEXT) { isSuccess,error,chatMessage in
     if isSuccess {
        // Update the UI
     }else{
        // Handle the error
     }
 }

Argument	Type	Description
TO_JID	String	jid of the end user
TEXT	String	Specifies the text message that needs to be sent
REPLY_MESSAGE_ID	String	Provides the Message ID of replied message or else generates an empty string (optional)
CALLBACK	`SendMessageListener`	callback to observe the action status

Receive a One-to-One Message#

Set the delegate in your ViewController's viewDidAppear method using below syntax and confirm the MessageEventsDelegate class, this will enable you to see other incoming messages and related events.

Swift
Objective-C

  ChatManager.shared.messageEventsDelegate = self

Once the delegate has been set, we will be able to receive the incoming message in the method mentioned below.To know more about other methods in MessageEventsDelegate kindly visit MessageEvent Delegate

To know more about other methods visit MessageEvent Delegate class,

Swift
Objective-C

func onMessageReceived(message: ChatMessage, chatJid: String) {
      // Message received from chatJid, content is message.messageTextContent
}