Let's integrate our SDK in few minutes
#
Quick Start#
Chat SDKs for WebCONTUS MirrorFly Chat SDK with its robust features and functionalities makes the integration more efficient and easy for every client’s app.
On client-side implementation, our chat SDK allows you to initialize and configure the chat easily. On server-side implementation, we ensure the most reliable infra-management services for the chat within the app.
This guided documentation here demonstrates the process as how to install the chat SDK in your app so that you can send and receive the messages without any interruption within a few simple steps.
note
CONTUS MirrorFly Chat SDKs use the fastest way in action, to experience the same you must use our trial app to enhance your existing chat app. So just download our sample app and make a start with your app development. Click here to download the sample app.
#
Supported browsersBrowser | Supported versions |
---|---|
Edge | 13 or higher |
Chrome | 16 or higher |
Firefox | 11 or higher |
Safari | 7 or higher |
#
Make a note of Below Points Before Making a Start#
PART I - SDK License KeyBefore moving forward with CONTUS MirrorFly Chat SDK integration, it is necessary for an SDK to be authenticated by the MirrorFly server using the license key for further processing.
The below given is the process that needs to be followed to obtain a license key:
Step 1: Get started - Signup into MirrorFly Console page (https://console.mirrorfly.com/register) and create a free MirrorFly account
Step 2: While creating an account you can provide your basic details that includes your name, organization details, work email, and contact number
Step 3: Once you’re in! You get access to your MirrorFly account ‘Overview page’ where you can find a license key ,Api base Url as well as downloadable JavaScript SDK files.
#
PART II - Integrate Chat SDK into Your Web AppCONTUS MirrorFly Chat for JavaScript, makes the in-app chat development process easy with all the essential messaging features
Since it’s the core of all the languages - Importing JavaScript into the application is the fundamental step to proceed further before using any language.
note
Minimum Requirement Angular version 8.3.29
Step 1: Copy all the extracted files from the SDK
folder.
Step 2: Create a new folder inside your project's Root folder and paste all the copied files into it.
Step 3: Open your angular.json
and search for the property by navigating the buttons : build => options => scripts
.
Step 4: Here, you can find the array of scripts wherein you can add the relative file paths of respective downloaded SDK JS files.
Step 5: Now, add the below codes in the Root component (before @Component Decorator).
Step 6: Once you have added the SDK into Root component’s ngOnInit
, initialize our SDKs within angular's initialization method.
#
PART III - TerminologyThe below are the common keywords/terminologies used in SDKs with their descriptions
Keyword | Description |
---|---|
userId | 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 | userID+@+domain of the chat server Ex. 12345678@xmpp.chatsystem.dev.contus.us |
groupJid | 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` |
#
Initialize Chat SDKTo begin with the initialization process of the chat SDK you are required to have certain data that responds to the changes in the connection status in the client's app.
Now, paste the license key on the licensekey param and use the below given method to pass these data through the SDK for further processing.
note
You can find the sandbox server details in the further Sandbox section for testing purposes.
#
Request ParamsArguments | Description | Type | Required |
---|---|---|---|
apiBaseUrl | API Base URL for Backend | String | true |
licenseKey | Mirrorfly's License Key | String | true |
isTrialLicenseKey | if true Trial Mode will be Enabled | Boolean | false |
callbackListeners | Check here for callback listerners | Object | true |
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |
#
Sandbox DetailsThe apiUrl
and licenseKey
details can get it from the 'Overview' section in the mirrorfly Console dashboard.
note
To learn more about callback listeners, go to the Callback Event Listener Section.
#
Example Response#
PART IV - Create a User#
Register UserStep 1: You can use the below given method to register a new user.
Step 2: Once you are registered, you will be provided with a username and password that you can utilize to make the connection with the server via connect method.
#
Request ParamsStatus | Description | Type | Required |
---|---|---|---|
USER_IDENTIFIER | Unique Id to Register the User | String | true |
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |
data | Username and Password | Object |
#
Sample Response:caution
username
is the unique id that allows you to connect with other users to send or receive messages.
#
Connect to MirrorFly ServerStep 1: You can use the credentials that you have obtained while registration to make the connection with the server.
Step 2: Once you have created the connection successfully, you will be responded with an approval message as ‘statusCode of 200’ or else will get an execution error.
Step 3: With this you can also trace the connection status that you receive in connectionListener callback function.
Step 4: If you face any error while making a connection with the server, you will receive an error message with callback.
#
Request ParamsStatus | Description | Type | Required |
---|---|---|---|
USERNAME | Username | String | true |
PASSWORD | Password | String | true |
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |
note
To learn more about all possible logins and profile related setup, go to Profile Section.
#
PART V - Send a MessageFinally, to send a message to another user you can use the below given method,
note
You can use the const userJid = SDK.getJid(USER_ID)
method, to generate a JID for any user.
#
Request ParamStatus | Description | Type | Required |
---|---|---|---|
TO_USER_JID | JID of the To User. username + "@" + xmppSocketHost | JID String | true |
MESSAGE_BODY | Text Message Body | String | true |
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |
#
PART VI - Receive a MessageTo receive a message from another user you must implement the messageListener function. It’s a function that will be triggered whenever you receive a new message or related event in one-to-one or group chat. Further to initialize the SDK, you need to add the below callback method during the process.
note
To learn more on 'message listener callbacks,' see the Message Callback Event Listener Section