With CONTUS MirrorFly Chat SDK for iOS, you can easily add real-time chat features to your client app within 30 minutes.
Through our client SDK, you can initialize and configure chat into your app with minimal efforts.
Note : If you're looking for the fastest way to build your app’s UI with MirrorFly Chat SDKs, you can use our sample apps. To get our sample apps, click here
The below are the requirements for chat SDK for iOS,
- Xcode 14.1 or later
- iOS 12.1 or later
- Swift 5.0 or later
To integrate MirrorFly Chat SDK into your app, you will need a SDK License Key. The MirrorFly server will use this license key to authenticate the SDK in your application.
Step 1: Register here
Step 2: Login to your Account
Step 3: Get the License key from the
application Info’ section
Step 4: Download the iOS SDK
Step 1: Add the following ChatSDK pod to your Podfile. If pod hasn't been initialised yet means, create a Podfile by executing
pod init command.
Step 2: Add the below given pod hook code block at the end of the pod file and thus, finally install the pods by executing
pod install command.
Step 3 : Now, disable the bitcode for your project
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.
Add the following import statement below before accessing SDK anywhere in your project.
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
initializeSDK function to validate the license key and to fetch critical data from server for SDK initialization.
Furthermore, in your project you must use the
AppDelegate class within the
didFinishLaunchingWithOptions method call the initialization method by passing the license key. Let's have a look at the example given below.
|LICENSE_KEY||Used to proceed with 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 .
Unless you logged out of a session, make sure that you have called the
Registration method only once in an application
Note: While registration, the below
registerApiServicemethod will accept the additional params required for notification processing on server and
IS_FORCE_REGISTERas an optional param for maintaining sessions,
USER_TYPEas an optional param to provide type of user and
META_DATAas an optional param to provide MetaData of user.
|USER_IDENTIFIER||Unique Id to Register the User. User identifiers can only contain lowercase alphanumeric characters, hyphens (-), and underscores (_).)|
|APNS_DEVICE_TOKEN||Token to register APNS device (optional)|
|VOIP_DEVICE_TOKEN||Token to register VoIP device (optional)|
|USER_TYPE||Type of the user (optional)|
|META_DATA||list of key - value pair of metadata object. |
To know more about
IS_FORCE_REGISTER is false, and it reached the maximum no of multi-sessions then registration will not succeed it will throw a 405 exception, Either
IS_FORCE_REGISTER should be true or one of the existing session need to be logged out to continue registration.
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,
To generate a unique user id, you must pass the
username in the method
let userJID: String = try FlyUtils.getJid(USERNAME)
Once Registration was successful, ChatSDK automatically attempts to connect to the Chat Server and ChatSDK also observe the changes in application state, and accordingly it will try to connect and disconnect the Chat Server.
The connection status can be observed and tracked by confirming the
ConnectionEventDelegate. To do that you need to set ‘delegate’ in your
viewDidAppear method like below.
ConnectionEventDelegate has been set, you will be able to receive the connection status in the delegate method as mentioned below.
To know more about
ConnectionEventDelegate visit ConnectionEvent Delegate
The below given are some of the common keyword/terminologies used in the Chat SDK with 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. firstname.lastname@example.org|
|groupID/groupBareID||Unique ID assigned for each group Ex: group123456 (any alphanumeric). GroupJID = groupID +@mix.+domain of the chat server Ex: email@example.com`|
SDK here provides the built-in functions to prepare the JID and Group JID.
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
usernamein the method
let userJID : String = FlyUtils.getJid(USERNAME)
|TO_JID||String||JID of the end user|
|TEXT||String||Indicates the text message that needs to be sent|
|CALLBACK||callback to observe the action status|
Set the delegate in your
viewDidAppear method using below syntax and confirm the
MessageEventsDelegate class, this will enable you to see other incoming messages and related events.
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
MessageEventsDelegateprotocol has 12 delegate methods
onMessageReceivedis one of them. Kindly visit MessageEvent Delegate to know more about them.