Quick Start

QuickBlox SDK helps you implement real-time chat, video chat, and push notifications to your app. You can fully concentrate on your mobile app development. QuickBlox iOS SDK supports both Swift and Objective-C programming languages.

Start with sample apps

If you are just starting your app and developing it from scratch, we recommend to use our sample apps. We use GitHub repositories to make it easy to explore, copy, and modify our code samples. The guide on how to launch and configure the sample app is on GitHub.

Chat samples

Choose the code sample below to jump-start the development.

Video calling samples

Choose the code sample below to jump-start the development.

More samples

For more samples, head to our Code Samples page. These sample apps are available on GitHub so feel free to browse them there. Just clone the repository and modify the source code for your own projects.

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 iOS SDK are:

• iOS 13.0
• CocoaPods 1.1
• Xcode 11

Install QuickBlox SDK into your app

You can install the QuickBlox iOS SDK using either SPM (Swift Package Manager) or CocoaPods.

Swift Package Manager

🚧

QuickBlox iOS SDK is available using the [Swift Package Manager] (https://www.swift.org/package-manager/) (SPM) since version 2.18.1 for Quickblox and since version 2.8.1 for QuickbloxWebRTC.

To add QuickBlox IOS SDK to your project using SPM, you can follow these steps:

1. Open your Xcode project and navigate to File > Swift Packages > Add Package Dependency.
2. In the search bar, enter the QuickBlox repository URL: https://github.com/QuickBlox/ios-quickblox-sdk.git or QuickbloxWebRTC repository URL: https://github.com/QuickBlox/ios-quickblox-sdk-webrtc.git and click Add Package.
3. Xcode will then fetch the SDK and you can add it to your project by clicking Add Package.
4. You can then import QuickBlox modules into your code and use its API.

import Quickblox
import QuickbloxWebRTC

@import Quickblox;
@import QuickbloxWebRTC;

For more information on spm customization options, you can refer to the Apple Documentation.

CocoaPods

📘

CocoaPods must be installed.

1. Create a Podfile. Project dependencies should be managed by CocoaPods. Create this file in the same directory with your project.

pod init
touch Podfile
open -e Podfile

2. Open the created Podfile and enter the following code lines into it. Specify the SDK version being installed.

platform :ios, "12.0"
use_frameworks!
target 'MyApp' do
    pod 'QuickBlox', '~> 2.17.10'
    pod 'Quickblox-WebRTC', '~> 2.7.6'
end

3. Install QuickBlox dependencies in your project.

pod install

4. Import headers to start using Quickblox frameworks.

import Quickblox
import QuickbloxWebRTC

#import <Quickblox/Quickblox.h>
#import <QuickbloxWebRTC/QuickbloxWebRTC.h>

Send your first message

Initialize QuickBlox SDK

Initialize the framework with applicationID, authKey, authSecret, and accountKey. Add the code below to the AppDelegate file located in the root directory of your project:

Quickblox.initWithApplicationId(92, authKey: "wJHdOcQSxXQGWx5", authSecret: "BTFsj7Rtt27DAmT", accountKey: "7yvNe17TnjNUqDoPwfqp")

[Quickblox initWithApplicationId:92 authKey:@"wJHdOcQSxXQGWx5" authSecret:@"BTFsj7Rtt27DAmT" accountKey:@"7yvNe17TnjNUqDoPwfqp"];

❗️

Security

It's not recommended to keep your authKey and authSecret inside an application in production mode, instead of this, the best approach will be to store them on your backend and initialize QuickBlox SDK with applicationId and acountKey only. More details you can find in Initialize QuickBlox SDK without Authorization Key and Secret section.

Authorize user

Now, it is time to log in with the user. To create a user session, call the logIn() method and pass the user login and user password as arguments to it.

QBRequest.logIn(withUserLogin: "userLogin", password: "userPassword", successBlock: { (response, user) in
    
}, errorBlock: { (response) in
    
})

[QBRequest logInWithUserLogin:@"userLogin" password:@"userPassword" successBlock:^(QBResponse * _Nonnull response, QBUUser * _Nonnull tUser) {
    
} errorBlock:^(QBResponse * _Nonnull response) {
    
}];

Connect to chat

Having authorized a user, you can proceed with connecting to the chat server to start using Chat module functionality. Call the connect() method and pass the user.id and user.password to it.

QBChat.instance.connect(withUserID: user.id, password: user.password, completion: { (error) in
    
})

[QBChat.instance connectWithUserID:currentUser.ID password:currentUser.password completion:^(NSError * _Nullable error) {

}];

Create dialog

QuickBlox provides three types of dialogs: 1-1 dialog, group dialog, and public dialog. Learn more about dialogs here.

Let’s create a simple 1-1 dialog. Create a QBChatDialog instance and set the dialogID, type, and occupantIDs fields. Call the createDialog() method and pass the dialog to it as an argument.

let dialog = QBChatDialog(dialogID: nil, type: .private)
dialog.occupantIDs = [34]
QBRequest.createDialog(dialog, successBlock: { (response, createdDialog) in
    
}, errorBlock: { (response) in
    
})

QBChatDialog *dialog = [[QBChatDialog alloc] initWithDialogID:nil type:QBChatDialogTypePrivate];
dialog.occupantIDs = @[@34]; // an ID of opponent
[QBRequest createDialog:dialog successBlock:^(QBResponse * _Nonnull response, QBChatDialog * _Nonnull createdDialog) {
    
} errorBlock:^(QBResponse * _Nonnull response) {
    
}];

📘

Make sure to set nil value for the dialogID parameter.

Receive messages

To track events in your chat (for example, receive messages, track to whom your messages are delivered and who read them), you must implement the chat delegate methods for your chat controller. Use the addDelegate() method to add a listener enabling the app to listen to the received messages. In other words, you subscribe to this event using chat delegate in your chat controller.

QBChat.instance.addDelegate(self)

[QBChat.instance addDelegate: self];

Implement theQBChatDelegate methods you need in your chat controller.

/// MARK: - QBChatDelegate
extension YourViewController: QBChatDelegate {
    // MARK: - Manage chat receive message callback's
    func chatRoomDidReceive(_ message: QBChatMessage, fromDialogID dialogID: String) {
        // Called whenever group chat dialog did receive a message.
        // !!!note Will be called on both recipients' and senders' device (with corrected time from server)
    }
    func chatDidReceive(_ message: QBChatMessage) {
        // Called whenever new private message was received from QBChat.
        // !!!note Will be called only on recipient device
    }
}

/// MARK: - QBChatDelegate
// MARK: - Manage chat receive message callback's
- (void)chatDidReceiveMessage:(QBChatMessage *)message {
    // Called whenever new private message was received from QBChat.
    // !!!note Will be called only on recipient device
}
- (void)chatRoomDidReceiveMessage:(QBChatMessage *)message fromDialogID (NSString*)dialogID {
    // Called whenever group chat dialog did receive a message.
    // !!!note Will be called on both recepients' and senders' device (with corrected time from server)
}

Send message

To send a message, create QBChatMessage instance. Set the text of the message. Call the send() method and pass the message as an argument to it.

let message = QBChatMessage()
message.text = "How are you today?"
message.customParameters["save_to_history"] = true
let privateDialog = ...
privateDialog.send(message) { (error) in
}

//MARK: ChatDelegate
func chatDidReceive(_ message: QBChatMessage) {
 }

QBChatMessage *message = [[QBChatMessage alloc] init];
message.text = @"How are you today?";
message.customParameters[@"save_to_history"] = @"1";
QBChatDialog *privateDialog = ...;
[privateDialog sendMessage:message completionBlock:^(NSError * _Nullable error) {
}];

//MARK: ChatDelegate
- (void)chatDidReceiveMessage:(QBChatMessage *)message {
} (edited)

📘

Set the save_to_history parameter if you want this message to be saved in chat history.