🚧

This is our documentation for beta version of QuickBlox React Native SDK. Please contact our Customer Support Team to provide your feedback, suggestions, and requests to improve this page.

Follow the instructions below to ensure that QuickBlox SDK runs smoothly with your app.

Before you begin

Visit our Key Concepts page to get an overall understanding of the most important QuickBlox concepts.

Get application credentials

QuickBlox application includes everything that brings messaging right into your application - chat, video calling, users, push notifications, etc. To create a QuickBlox application, follow the steps below:

1. Register a new account following this link. Type in your email and password to sign in. You can also sign in with your Google or Github accounts.
2. Create the app clicking New app button.
3. Configure the app. Type in the information about your organization into corresponding fields and click Add button.
4. Go to Dashboard => YOUR_APP => Overview section and copy your Application ID, Authorization Key, Authorization Secret, and Account Key .

Requirements

The minimum requirements for QuickBlox React Native SDK are:

• iOS 12.
• Android (minimum version 5.0, API 21).
• React Native (minimum version 0.60).

Install QuickBlox SDK into your app

📘

To manage project dependencies:

- Node.js and npm must be installed
- CocoaPods must be installed for iOS.

To connect QuickBlox to your app just add it into your project's dependencies by running following code sample in terminal (in your react-native app):

npm install quickblox-react-native-sdk --save

iOS and Android have different dependencies systems. For that reason, you need to install dependencies in your iOS project. Just locate ios/ folder in the root directory of the project and enter the following code snippet.

pod install

Add permissions

For Android

If your app requires adding some specific permissions to access camera, microphone, internet, and storage permissions, add these permissions to your app manifest.

<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

For iOS

You can use our SDK in the background mode as well. If you want to receive push notifications when the app goes to background mode, this requires you to add specific app permissions. Under the app build settings, open the Capabilities tab and turn on Remote notifications checkbox only.

If you want to use video calling functionality in the background mode set the Audio, AirPlay, and Picture in Picture checkboxes.

Initialize QuickBlox SDK

🚧

You must initialize SDK before calling any methods through the SDK, except for the init() method. If you attempt to call a method without connecting, the error is returned.

Initialize the framework with your application credentials. Specify Application ID, Authorization Key, Authorization Secret, and Account Key within appSettings object and pass it to the init() method.

const appSettings = {
  appId: '',
  authKey: '',
  authSecret: '',
  accountKey: ''
};

QB.settings
  .init(appSettings)
  .then(function () {
    // SDK initialized successfully
  })
  .catch(function (e) {
    // Some error occured, look at the exception message for more details
  });

📘

For Basic, Startup, and Growth plan users

- Make sure to set accountKey.
- Make sure to leave apiEndpoint and chatEndpoint fields empty to provide a smooth migration between servers.

Custom endpoints

To connect QuickBlox SDK to the custom server, you should specify apiEndpoint and chatEndpoint endpoints within the appSettings object and pass it to the init() method.

const appSettings = {
  appId: '',
  authKey: '',
  authSecret: '',
  accountKey: '',
  apiEndpoint: '', // optional
  chatEndpoint: '' // optional
};

QB.settings
  .init(appSettings)
  .then(function () {
    // SDK initialized successfully
  })
  .catch(function (e) {
    // Some error occured, look at the exception message for more details
  });

📘

For Enterprise plan users

Contact our sales team to get apiEndpoint and chatEndpoint.

Enable logging

Logging functionality allows you to keep track of all events and activities while running your app. As a result, you can monitor the operation of the SDK and improve the debug efficiency. There are 3 logging use cases:

• REST API logging is used to monitor REST API calls.
• Chat logging is used to monitor chat issues.
• WebRTC logging is used to gather issues with video.

1. Go over this section to learn how to enable logging for your iOS app.
2. Go over this section to learn how to enable logging for your Android app.

Message carbons

Message carbons functionality allows for multi-device support. Thus, all user messages get copied to all their devices so they could keep up with the current state of the conversation. For example, a User A has phone running conversations and desktop running conversations. User B has desktop running conversations. When User B sends a message to User A, the message shows on both the desktop and phone of User A.

Enable message carbons

QB.settings.enableCarbons()

Disable message carbons

QB.settings.disableCarbons()

🚧

By default, this parameter is turned off. Keep it enabled if you want to receive messages on all devices of the particular user (when a user is logged in on several devices).

Stream management

Stream management has two important features Stanza Acknowledgements and Stream Resumption:

• Stanza Acknowledgements is the ability to know if a stanza or series of stanzas has been received by one's peer. In other words, a reply is requested on every sent message. If the reply is received, the message is considered as delivered.
• Stream Resumption is the ability to quickly resume a stream that has been terminated. So once a connection is re-established, Stream Resumption is executed. By matching the sequence numbers assigned to each Stanza Acknowledgement a server and client can verify which messages are missing and request to resend missing messages.

Call initStreamManagement() method and pass autoReconnect and messageTimeout parameters to it to enable stream management.

QB.settings.initStreamManagement({
  autoReconnect: false,
  messageTimeout: 10
})

📘

You should enable Stream Management before you do the login() because the Stream Management is initialized while Chat login is performed.

The Stream Management defines an extension for active management of a stream between a client and server, including features for stanza acknowledgments.