Connection
Learn how to connect to the chat server and set connection settings.
Before you begin
- Register a QuickBlox account. This is a matter of a few minutes and you will be able to use this account to build your apps.
- Configure QuickBlox SDK for your app. Check out our Setup page for more details.
- Create a user session to be able to use QuickBlox functionality. See our Authentication page to learn how to do it.
Visit our Key Concepts page to get an overall understanding of the most important QuickBlox concepts.
Connect to chat server
To connect to the chat server use the code snippet below.
Use QBChatDelegate
to handle different connection states.
Connect to chat server with QuickBlox session token
In case, you authenticate with QuickBlox via Firebase, Facebook, or Custom Identity Provider, you should connect to the chat server with QuickBlox user session token and QuickBlox user ID.
As a result of successful authentication via Firebase, Facebook, or Custom Identity Provider, you receive a QuickBlox user session token and QuickBlox user ID. Use QuickBlox user session token as a password and QuickBlox user ID as a login to connect to the chat server.
Don’t use the Firebase/Facebook access token as a password to connect to the chat server. You will receive the following runtime error in this case: <failure xmlns="urn:ietf:params:xml:ns:xmpp-sasl"><not-authorized/><text xml:lang='en'>Password not verified</text></failure>
.
Argument | Required | Description |
---|---|---|
userID | yes | The ID of a user |
userPassword | yes | Specifies an active QuickBlox user session token set as a password. |
Disconnect from chat server
Disconnect from the chat server using the snippet below.
Enable auto-reconnect to chat
The SDK reconnects automatically when the connection to the chat server is lost. There is a way to disable it and then manage it manually.
QBSettings.autoReconnectEnabled = true
QBSettings.autoReconnectEnabled = YES;
Manage chat connections
To provide a seamless chat experience, our SDK manages connections to the chat server at an application-wide level. Thus, to handle offline messages correctly, use the disconnect()
method when an app goes to the background and connect()
method when an app goes to the foreground. As a result, the SDK will disconnect/connect the current user from the chat server when the app goes to the background/foreground mode.
Set connection settings
Use the settings below to configure the connection to the chat server.
Parameters | Description |
---|---|
autoReconnectEnabled | iOS SDK reconnects automatically to the chat server when the connection to the server is lost. Default: false. |
reconnectTimerInterval | A reconnect timer can optionally be used to attempt a reconnect periodically. Set in seconds. Default: 5. |
carbonsEnabled | Message carbons allow for real-time message syncing between devices. Default: false. |
keepAliveInterval | Keep-alive option for a socket connection. Keep-alive is the option allowing to detect a stale connection. Set in seconds. Default: 20. |
streamManagementSendMessageTimeout | The timeout value for stream management. Set in seconds. If this parameter is greater than 0, then it is applied, otherwise, it is not applied. Default: 0. |
networkIndicatorManagerEnabled | A boolean value indicating whether the manager is enabled. If true, the manager will change status bar network activity indicator according to network operation notifications it receives. Default: false. |
Was this page helpful?