QuickBlox

https://docs.quickblox.com
Admin
QuickBlox is a backend-as-a-service platform that enables developers to build chat, messaging, video...
Tokens:682,491
Snippets:5,457
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Complete App.tsx Example

Source: https://docs.quickblox.com/ui-kits/react-uikit-send-your-first-message

This is a full example of the App.tsx file demonstrating the integration of QuickBloxUIKitProvider, SDK initialization, and user authentication.

```TypeScript
import React, { useEffect } from 'react';

// @ts-ignore
import * as QB from "quickblox/quickblox";
import {
  QuickBloxUIKitProvider,
  qbDataContext,
  QuickBloxUIKitDesktopLayout,
  LoginData,
  AuthorizationData,
  QBDataContextType,
} from 'quickblox-react-ui-kit';
import { QBConfig } from './QBconfig';
import './App.css';

function App() {

  const currentUser: LoginData = {
    login: '',
    password: '',
  };

  const qbUIKitContext: QBDataContextType = React.useContext(qbDataContext);

  const [isUserAuthorized, setUserAuthorized] = React.useState(false);
  const [isSDKInitialized, setSDKInitialized] = React.useState(false);

  const prepareSDK = async (): Promise<void> => {
    // check if we have installed SDK
    if ((window as any).QB === undefined) {
      if (QB !== undefined) {
        (window as any).QB = QB;
      } else {
        let QBLib = require('quickblox/quickblox.min');
        (window as any).QB = QBLib;
      }
    }

    const APPLICATION_ID = QBConfig.credentials.appId;
    const AUTH_KEY = QBConfig.credentials.authKey;
    const AUTH_SECRET = QBConfig.credentials.authSecret;
    const ACCOUNT_KEY = QBConfig.credentials.accountKey;
    const CONFIG = QBConfig.appConfig;

    QB.init(APPLICATION_ID, AUTH_KEY, AUTH_SECRET, ACCOUNT_KEY, CONFIG);

  };

  useEffect(() => {
    if (!isSDKInitialized) {
      prepareSDK().then(result => {

        QB.createSession(currentUser, async function (errorCreateSession: any, session: any) {
          if (errorCreateSession) {
            console.log('Create User Session has error:', JSON.stringify(errorCreateSession));
          } else {
            const userId: number = session.user_id;
            const password: string = session.token;
            const paramsConnect = { userId, password };

            QB.chat.connect(paramsConnect, async function (errorConnect: any, resultConnect: any) {
              if (errorConnect) {

```

--------------------------------

### Install QuickBlox SDK

Source: https://docs.quickblox.com/ui-kits/react-uikit-send-your-first-message

Install the QuickBlox JavaScript SDK using npm. This is a prerequisite for using the UIKit.

```JavaScript
npm install quickblox
```

--------------------------------

### Install QuickBlox React UI Kit Package

Source: https://docs.quickblox.com/ui-kits/react-uikit-send-your-first-message

Install the quickblox-react-ui-kit package using npm.

```powershell
npm install quickblox-react-ui-kit --save
```

--------------------------------

### Install SDK with Bower

Source: https://docs.quickblox.com/sdks/js-sdk-reference

Install the QuickBlox JavaScript SDK using the Bower package manager for front-end projects.

```bash
bower install quickblox --save
```

--------------------------------

### Install SDK with NPM

Source: https://docs.quickblox.com/sdks/js-sdk-reference

Install the QuickBlox JavaScript SDK for Node.js applications using the NPM package manager.

```bash
npm install quickblox --save
```

--------------------------------

### Install QuickBlox Dependencies with CocoaPods

Source: https://docs.quickblox.com/docs/ios-setup

Run this command in your project directory after configuring the Podfile to install the specified QuickBlox SDK versions.

```bash
pod install

```

--------------------------------

### Install QuickBlox SDK with Yarn

Source: https://docs.quickblox.com/sdks/js-quick-start

Install the QuickBlox SDK into your project using Yarn. This command adds the SDK as a dependency to your project.

```bash
yarn add quickblox
```

--------------------------------

### Install Standalone AI Answer Assistant Library

Source: https://docs.quickblox.com/ui-kits/react-uikit-ai-features

Install the qb-ai-answer-assistant library using npm. This package provides the QBAIAnswerAssistant object for AI-powered features.

```PowerShell
npm install qb-ai-answer-assistant
```

--------------------------------

### Install qb-ai-rephrase library

Source: https://docs.quickblox.com/ui-kits/react-uikit-ai-features

Install the standalone qb-ai-rephrase library using npm. This command adds the necessary package to your project.

```powershell
npm install qb-ai-rephrase
```

--------------------------------

### Install qb-ai-translate Library

Source: https://docs.quickblox.com/ui-kits/react-uikit-ai-features

Install the standalone qb-ai-translate library using npm. This library provides the QBAITranslate object for AI translation features.

```PowerShell
npm install qb-ai-translate
```

--------------------------------

### Install QuickBlox React UIKit

Source: https://docs.quickblox.com/ui-kits/react-uikit-send-your-first-message

Install the QuickBlox React UI Kit package using npm. This package provides pre-built UI components for chat.

```JavaScript
npm install quickblox-react-ui-kit
```

--------------------------------

### Run the Application

Source: https://docs.quickblox.com/ui-kits/react-uikit-send-your-first-message

This command is used to start the React application after the QuickBlox SDK has been configured and integrated.

```powershell
npm start
```

--------------------------------

### Verification Endpoint Request Example

Source: https://docs.quickblox.com/docs/custom-identity-provider

Example of a GET request to your identity provider's verification endpoint. This endpoint receives user credentials and returns unique user identifiers and optional user details.

```HTTP
GET	https://youripserver.com/users/identity?IdP_user_ID=4324&IdP_token=8b75a6c7191285499d890a81df4ee7fe49bc732a
```

--------------------------------

### Get Users with Sorting

Source: https://docs.quickblox.com/sdks/android-users

This example demonstrates how to retrieve a list of users and apply sorting based on fields like 'created_at' in descending order.

```APIDOC
## Get Users with Sorting

### Description
Retrieves a list of users with the ability to specify sorting parameters. The example shows sorting by 'created_at' in descending order.

### Method
`QBUsers.getUsers`

### Parameters
- `requestBuilder`: A `QBPagedRequestBuilder` object configured with sorting rules.

### Request Example (Java)
```Java
String field = "created_at";
String typeField = "date";
String sortDesc = "desc";
String paramSort = "order";

ArrayList<GenericQueryRule> rules = new ArrayList<GenericQueryRule>();
rules.add(new GenericQueryRule(paramSort, sortDesc + " " + typeField + " " + field));

QBPagedRequestBuilder requestBuilder = new QBPagedRequestBuilder();
requestBuilder.setRules(rules);

QBUsers.getUsers(requestBuilder).performAsync(new QBEntityCallback<ArrayList<QBUser>>() {
    @Override
    public void onSuccess(ArrayList<QBUser> usersList, Bundle bundle) {

    }

    @Override
    public void onError(QBResponseException exception) {

    }
});
```

### Request Example (Kotlin)
```Kotlin
val field = "created_at"
val typeField = "date"
val sortDesc = "desc"
val paramSort = "order"

val rules = ArrayList<GenericQueryRule>()
rules.add(GenericQueryRule(paramSort, "$sortDesc $typeField $field"))

val requestBuilder = QBPagedRequestBuilder()
requestBuilder.rules = rules

QBUsers.getUsers(requestBuilder).performAsync(object : QBEntityCallback<ArrayList<QBUser>> {
    override fun onSuccess(usersList: ArrayList<QBUser>, bundle: Bundle) {

    }

    override fun onError(exception: QBResponseException) {

    }
})
```

### Sort Operators
| Sort operator | Applicable to types | Applicable to fields                                                                                         |
| ------------- | ------------------- | ------------------------------------------------------------------------------------------------------------ |
| sortAsc       | All types           | id, full_name, email, login, phone, website, created_at, updated_at,last_request_at, external_user_id |
| sortDesc      | All types           | id, full_name, email, login, phone, website, created_at, updated_at,last_request_at, external_user_id |

### Response
#### Success Response
- `ArrayList<QBUser>`: A list of `QBUser` objects.
- `Bundle`: Additional data.
```

--------------------------------

### Initialize QuickBlox SDK

Source: https://docs.quickblox.com/sdks/js-quick-start

Initialize the SDK with your application credentials. Ensure you use your actual APPLICATION_ID, AUTH_KEY, AUTH_SECRET, and ACCOUNT_KEY.

```APIDOC
## Initialize QuickBlox SDK

### Description
Initialize the SDK with application credentials.

### Method
`QB.init(applicationId, authKey, authSecret, accountKey)`

### Parameters
- **applicationId** (number) - Your QuickBlox Application ID.
- **authKey** (string) - Your QuickBlox Authorization Key.
- **authSecret** (string) - Your QuickBlox Authorization Secret.
- **accountKey** (string) - Your QuickBlox Account Key.

### Request Example
```javascript
var APPLICATION_ID = 41;
var AUTH_KEY = "lkjdueksu7392kj";
var AUTH_SECRET = "iiohfdija792hj";
var ACCOUNT_KEY = "sdjfnksnlk2bk1k34kb";

QB.init(APPLICATION_ID, AUTH_KEY, AUTH_SECRET, ACCOUNT_KEY);
```

<Warning>
  **Security**
  It's not recommended to keep your **authKey** and **authSecret** inside an application in production mode. Consider storing them on your backend and initializing QuickBlox SDK with applicationId and acountKey only. More details can be found in the [Initialize QuickBlox SDK without Authorization Key and Secret](/sdks/js-setup#install-quickblox-sdk-into-your-app) section.
</Warning>
```

--------------------------------

### List Events

Source: https://docs.quickblox.com/reference/list-events

This snippet shows how to make a GET request to the events endpoint to retrieve a list of events. It includes an example of the required Authorization header.

```APIDOC
## GET /events.json

### Description
Retrieves a list of events.

### Method
GET

### Endpoint
https://api.quickblox.com/events.json

### Request Headers
- **QB-Token**: Your QuickBlox authorization token.

### Request Example
```bash cURL
curl -X GET \
  -H "QB-Token: b9c808a7a9d44ca5804f38c43f62d9d0ef8c8020" \
  https://api.quickblox.com/events.json
```

### Response
#### Success Response (200)
- **current_page** (integer) - The current page number of the results.
- **per_page** (integer) - The number of items per page.
- **total_entries** (integer) - The total number of entries found.
- **items** (array of objects) - A list of event objects.
  - **event** (object) - Contains details of a single event.
    - **id** (integer) - The unique identifier for the event.
    - **event_type** (string) - The type of the event (e.g., 'period_date', 'one_shot').
    - **message** (string) - The message associated with the event.
    - **date** (string) - The date of the event.
    - **period** (string) - The period for recurring events.
    - **name** (string) - The name of the event.
    - **occured_count** (integer) - The number of times the event has occurred.
    - **created_at** (string) - The timestamp when the event was created.
    - **updated_at** (string) - The timestamp when the event was last updated.
    - **end_date** (string) - The end date for the event.
    - **active** (boolean) - Indicates if the event is currently active.
    - **application_id** (integer) - The ID of the application this event belongs to.
    - **user_id** (integer) - The ID of the user associated with the event.
    - **kind** (string) - The kind of event (e.g., 'API').
    - **environment** (string) - The environment where the event occurred (e.g., 'development', 'production').
    - **tag_query** (string) - The tag query associated with the event.
    - **notification_channel** (object) - Details about the notification channel.
      - **name** (string) - The name of the notification channel (e.g., 'gcm', 'apns').

#### Response Example (200)
```json
{
  "current_page": 1,
  "per_page": 10,
  "total_entries": 3,
  "items": [
    {
      "event": {
        "id": 30528610,
        "event_type": "period_date",
        "message": "data.message=JTdCJTIyYXBzJTIyJTNBJTdCJTIyc291bmQlMjIlM0ElMjJkZWZhdWx0JTIyJTJDJTIyYWxlcnQlMjIlM0ElMjJZb3UraGF2ZStqdXN0K3JlY2VpdmVkK2ErbmV3K21lc3NhZ2UrZnJvbStZdWxpYStTeWRvcmVua28uJTIyJTdEJTJDJTIyeCUyMiUzQSU3QiUyMmRhdGElMjIlM0ElMjIlN0IlNUMlMjJ0eXBlJTVDJTIyJTNBJTVDJTIybWVzc2FnZSU1QyUyMiUyQyU1QyUyMmZyb21fbmFtZSU1QyUyMiUzQSU1QyUyMll1bGlhK1N5ZG9yZW5rbyU1QyUyMiUyQyU1QyUyMmZyb21fbmFkIElkJTVDJTIyJTNBJTVDJTIyODU3NTE1JTVDJTIyJTJDJTVDJTIyZnJvbV9mYWNlYm9vayU1QyUyMiUzQSU1QyUyMTAwMDAwMzQ5MDgyNjAzJTVDJTIyJTdEJTdE",
        "date": 1568359375,
        "period": 86400,
        "name": null,
        "occured_count": 0,
        "created_at": "2019-09-01T17:38:56Z",
        "updated_at": "2019-09-01T17:38:56Z",
        "end_date": 1569359375,
        "active": true,
        "application_id": 76730,
        "user_id": 91141808,
        "kind": "API",
        "environment": "development",
        "tag_query": null,
        "notification_channel": {
          "name": "gcm"
        }
      }
    },
    {
      "event": {
        "id": 30528641,
        "event_type": "period_date",
        "message": "payload=eyJhcHMiOnsiYWxlcnQiOiJ7XCJhcHNcIjp7XCJzb3VuZFwiOlwiZGVmYXVsdFwiLFwiYWxlcnRcIjpcIllvdSBoYXZlIGp1c3QgcmVjZWl2ZWQgYSBuZXcgbWVzc2FnZSBmcm9tIFl1bGlhIFN5ZG9yZW5rby5cIn0sXCJ4XCI6e1wiZGF0YVwiOlwie1xcXCJ0eXBlXFxcIjpcXFwibWVzc2FnZVxcXCIsXFxcImZyb21fbmFtZVxcXCI6XFxcIll1bGlhIFN5ZG9yZW5rby5cXCIsXFxcImZyb21faWRcXFwiOlxcXCI4NTc1MTFcXFwiLFxcXCJmcm9tX2ZhY2Vib29rXFxcIjpcXFwiMTAwMDAwMzQ5MDgyNjAzXFxcIn19Iiwic291bmQiOiJkZWZhdWx0In19",
        "date": 1568359375,
        "period": 86400,
        "name": null,
        "occured_count": 0,
        "created_at": "2019-09-01T17:47:30Z",
        "updated_at": "2019-09-01T17:47:30Z",
        "end_date": 1569359375,
        "active": true,
        "application_id": 76730,
        "user_id": 91141808,
        "kind": "API",
        "environment": "production",
        "tag_query": null,
        "notification_channel": {
          "name": "apns"
        }
      }
    },
    {
      "event": {
        "id": 30529135,
        "event_type": "one_shot",
        "message": "data.message=UHVzaCUyMG5vdGlmaWNhdGlvbiUyMGZyb20lMjBhdXRvdGVzdA==",
        "date": null,
        "period": null,
        "name": "test",
        "occured_count": 1,
        "created_at": "2019-09-01T19:52:01Z",
        "updated_at": "2019-09-01T19:52:01Z",
        "end_date": null,
        "active": false,
        "application_id": 76730,
        "user_id": 91141808,
        "kind": "API",
        "environment": "development",
        "tag_query": null,
        "notification_channel": {
        }
      }
    }
  ]
}
```

#### Error Response (400)
An error response is returned if the request is invalid.
```

--------------------------------

### Initialize QuickBlox SDK with Full Credentials

Source: https://docs.quickblox.com/sdks/react-native-setup

Initialize the SDK with your application ID, authorization key, authorization secret, and account key. This is the standard initialization method.

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

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

--------------------------------

### Get Count of Movie Records with Rating > 5.5 (Java)

Source: https://docs.quickblox.com/sdks/android-custom-objects

Use the countObjects() method with a QBRequestGetBuilder to specify filtering conditions. This example retrieves the count of 'Movie' records where the 'rating' is greater than 5.5.

```Java
String className = "Movie";

QBRequestGetBuilder requestBuilder = new QBRequestGetBuilder();
requestBuilder.gt("rating", "5.5");

QBCustomObjects.countObjects(className, requestBuilder).performAsync(new QBEntityCallback<Integer>() {
    @Override
    public void onSuccess(Integer count, Bundle bundle) {
        // objects successfully loaded
    }

    @Override
    public void onError(QBResponseException exception) {
        // handle error
    }
});
```

--------------------------------

### Sign Up User in Java

Source: https://docs.quickblox.com/sdks/android-authentication

Use this method to create a new user account in QuickBlox. Ensure the QBUser object is properly initialized with login and password.

```Java
final QBUser user = new QBUser();
user.setLogin("johnsmith");
user.setPassword("johnPassword");

QBUsers.signUp(user).performAsync(new QBEntityCallback<QBUser>() {
    @Override
    public void onSuccess(QBUser user, Bundle bundle) {

    }

    @Override
    public void onError(QBResponseException exception) {

    }
});
```

--------------------------------

### Get user by external user id with API key

Source: https://docs.quickblox.com/reference/get-user-by-external-user-id

This example demonstrates how to retrieve a user's information using their external user ID and an API key for authentication. The API key should be passed in the 'Authorization' header.

```APIDOC
## GET /users/external/{external_user_id}.json

### Description
Retrieves a user's details using their unique external identifier.

### Method
GET

### Endpoint
https://api.quickblox.com/users/external/{external_user_id}.json

### Parameters
#### Path Parameters
- **external_user_id** (integer) - Required - ID of the user in the external system.

#### Headers
- **Authorization** (string) - Required - API key from Dashboard. Expected format: `ApiKey {your_api_key}`.
- **QB-Token** (string) - Required - A user session token. Use either QB-Token or Authorization.

### Request Example
```curl
curl -X GET \
  -H "Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI" \
  https://api.quickblox.com/users/external/1236672.json
```

### Response
#### Success Response (200)
- **user** (object) - Contains user details.
  - **id** (integer) - User's internal ID.
  - **external_user_id** (string) - User's external ID.
  - **email** (string) - User's email address.
  - **full_name** (string) - User's full name.

#### Response Example
```json
{
  "user": {
    "id": 1234567,
    "external_user_id": "1236672",
    "email": "user@example.com",
    "full_name": "John Doe"
  }
}
```
```

--------------------------------

### Get Session

Source: https://docs.quickblox.com/llms.txt

Gets information about a current session.

```APIDOC
## Get Session

### Description
Gets information about a current session.

### Method
GET

### Endpoint
/session.json
```

--------------------------------

### Run Development Server

Source: https://docs.quickblox.com/ui-kits/react-uikit-send-your-first-message

Execute the npm run start command to launch the development server.

```bash
npm run start
```

--------------------------------

### Get File by ID

Source: https://docs.quickblox.com/llms.txt

Get information about a file by ID.

```APIDOC
## GET /files/{file_id}/info

### Description
Retrieves metadata and information about a file by its ID.

### Method
GET

### Endpoint
/files/{file_id}/info

### Parameters
#### Path Parameters
- **file_id** (string) - Required - The ID of the file to get information for.
```

--------------------------------

### Initialize QuickBlox SDK

Source: https://docs.quickblox.com/sdks/android-quick-start

Initialize the SDK with your application credentials. Ensure this is done before calling any other SDK methods. For production, consider storing auth keys on your backend.

```Java
static final String APPLICATION_ID = "67895";
static final String AUTH_KEY = "lkjdueksu7392kj";
static final String AUTH_SECRET = "BTFsj7Rtt27DAmT";
static final String ACCOUNT_KEY = "9yvTe17TmjNPqDoYtfqp";
//
QBSettings.getInstance().init(getApplicationContext(), APPLICATION_ID, AUTH_KEY, AUTH_SECRET);
QBSettings.getInstance().setAccountKey(ACCOUNT_KEY);
```

```Kotlin
private const val APPLICATION_ID = "67895"
private const val AUTH_KEY = "lkjdueksu7392kj"
private const val AUTH_SECRET = "BTFsj7Rtt27DAmT"
private const val ACCOUNT_KEY = "9yvTe17TmjNPqDoYtfqp"
//
QBSettings.getInstance().init(applicationContext, APPLICATION_ID, AUTH_KEY, AUTH_SECRET)
QBSettings.getInstance().accountKey = ACCOUNT_KEY
```

--------------------------------

### API Response Example

Source: https://docs.quickblox.com/reference/create-event

This is an example of the API response when an event is successfully created.

```APIDOC
## Response Example

```json
{
  "event": {
    "id": 30962142,
    "event_type": "one_shot",
    "message": "payload=eyJhcHMiOnsiYWxlcnQiOiJIZWxsbywgV29ybGQhIiwiYmFkZ2UiOjc3Nywic291bmQiOiJkZWZhdWx0In19",
    "date": null,
    "period": null,
    "name": null,
    "occured_count": 0,
    "created_at": "2019-11-09T20:40:25Z",
    "updated_at": "2019-11-09T20:40:25Z",
    "end_date": null,
    "active": true,
    "application_id": 76730,
    "user_id": 91142495,
    "kind": "API",
    "environment": "production",
    "tag_query": "{\"any\":\"web,android\"}",
    "notification_channel": {
      "name": "apns"
    }
  }
}
```
```

--------------------------------

### Include Dependencies for Browser

Source: https://docs.quickblox.com/sdks/js-video-conference

Include the webrtc-adapter and the QuickBlox multiparty video conferencing client script in your HTML before initializing the client. Ensure the adapter is loaded first.

```html
<script src="https://webrtc.github.io/adapter/adapter-latest.js"></script>
<script src="quickblox-multiparty-video-conferencing-client-0.8.6.min.js"></script>
```

--------------------------------

### Initialize QuickBlox SDK

Source: https://docs.quickblox.com/sdks/flutter-sdk-reference

Initializes the Quickblox SDK with your application credentials. This step is crucial before making any other SDK calls.

```APIDOC
## Initialize QuickBlox SDK

Initializes the framework with your application credentials. Pass `appId`, `authKey`, `authSecret`, `accountKey` to the `QB.settings.init` method. As a result, your application details are stored in the server database and can be subsequently identified on the server.

```dart
const String APP_ID = "XXXXX";
const String AUTH_KEY = "XXXXXXXXXXXX";
const String AUTH_SECRET = "XXXXXXXXXXXX";
const String ACCOUNT_KEY = "XXXXXXXXXXXX";
const String API_ENDPOINT = ""; //optional
const String CHAT_ENDPOINT = ""; //optional

try {
      await QB.settings.init(APP_ID, AUTH_KEY, AUTH_SECRET, ACCOUNT_KEY,
          apiEndpoint: API_ENDPOINT, chatEndpoint: CHAT_ENDPOINT);
    } on PlatformException catch (e) {
        // Some error occured, look at the exception message for more details 
    }

```
```

--------------------------------

### Install SVG Loader Dependency

Source: https://docs.quickblox.com/ui-kits/react-uikit-send-your-first-message

Install the @svgr/webpack dependency for handling SVG files.

```bash
npm install --save-dev @svgr/webpack
```

--------------------------------

### Initialize QuickBlox SDK

Source: https://docs.quickblox.com/sdks/react-native-quick-start

Initialize the SDK with your application credentials before using any other SDK methods. Ensure you provide your appId, authKey, authSecret, and accountKey.

```APIDOC
## Initialize QuickBlox SDK

Initialize the SDK with your application credentials. Set the `appId`, `authKey`, `authSecret`, `accountKey` properties of the `appSettings` object. Call the `init()` method and pass the `appSettings` as an argument to it.

```JavaScript
const appSettings = {
  appId: '76730',
  authKey: 'XydaWcf8OO9xhGT',
  authSecret: 'iiohfdija792hjt',
  accountKey: '7yvNe17TnjNUqDoPwfqp',
};

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

**Warning**: You must initialize SDK before calling any methods through the SDK, except for the `init()` method. If you attempt to call a method without initializing SDK previously, the error will be returned.

**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](/sdks/react-native-setup#initialize-quickblox-sdk-without-authorization-key-and-secret) section.
```

--------------------------------

### Install CocoaPods Dependencies

Source: https://docs.quickblox.com/sdks/ios-quick-start

Execute this command in your project directory to install dependencies defined in your Podfile.

```Bash
pod install
```

--------------------------------

### Initialize QuickBlox SDK

Source: https://docs.quickblox.com/sdks/js-quick-start

Initialize the SDK with your application credentials. It's recommended to store sensitive auth keys on your backend for production environments.

```JavaScript
var APPLICATION_ID = 41;
var AUTH_KEY = "lkjdueksu7392kj";
var AUTH_SECRET = "iiohfdija792hj";
var ACCOUNT_KEY = "sdjfnksnlk2bk1k34kb";

QB.init(APPLICATION_ID, AUTH_KEY, AUTH_SECRET, ACCOUNT_KEY);
```

--------------------------------

### Sign Up User in Kotlin

Source: https://docs.quickblox.com/sdks/android-authentication

Use this method to create a new user account in QuickBlox. Ensure the QBUser object is properly initialized with login and password.

```Kotlin
val user = QBUser()
user.login = "johnsmith"
user.password = "johnPassword"

QBUsers.signUp(user).performAsync(object : QBEntityCallback<QBUser> {
    override fun onSuccess(user: QBUser?, bundle: Bundle?) {

    }

    override fun onError(exception: QBResponseException?) {

    }
})
```

--------------------------------

### Initialize QuickBlox SDK with Credentials

Source: https://docs.quickblox.com/sdks/js-setup

Initialize the SDK with your application ID, authorization key, authorization secret, and account key. For production, store authKey and authSecret on your backend.

```javascript
var APPLICATION_ID = 41;
var AUTH_KEY = "lkjdueksu7392kj";
var AUTH_SECRET = "iiohfdija792hj";
var ACCOUNT_KEY = "sdjfnksnlk2bk1k34kb";
var CONFIG = { debug: true };

QB.init(APPLICATION_ID, AUTH_KEY, AUTH_SECRET, ACCOUNT_KEY, CONFIG);
```

--------------------------------

### Initialize CocoaPods and Podfile

Source: https://docs.quickblox.com/docs/ios-setup

Create and open a Podfile to manage your project's dependencies using CocoaPods. Ensure CocoaPods is installed.

```bash
pod init
touch Podfile
open -e Podfile

```

--------------------------------

### Error Response Example (403)

Source: https://docs.quickblox.com/reference/custom-objects-delete-file

This example shows a typical error response when the request lacks proper permissions to delete the file.

```json
{
  "errors": [
    "Wrong permission"
  ]
}
```

--------------------------------

### Initialize Podfile for CocoaPods

Source: https://docs.quickblox.com/sdks/ios-quick-start

Configure your Podfile to include the QuickBlox and Quickblox-WebRTC libraries with specified versions.

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

--------------------------------

### Install React Project Dependencies

Source: https://docs.quickblox.com/ui-kits/react-uikit-send-your-first-message

Install core React libraries, TypeScript, Webpack, and necessary loaders for building the React application.

```bash
# Application dependencies
npm install react react-dom

# TypeScript and types
npm install --save-dev typescript @types/react @types/react-dom @types/node

# Webpack and its core plugins
npm install --save-dev webpack webpack-cli webpack-dev-server html-webpack-plugin copy-webpack-plugin

# Loaders for styles and scripts
npm install --save-dev ts-loader style-loader css-loader sass-loader sass

# Babel support
npm install --save-dev babel-loader @babel/core @babel/preset-env @babel/preset-react @babel/preset-typescript
```

--------------------------------

### Initialize QuickBlox SDK

Source: https://docs.quickblox.com/sdks/react-native-quick-start

Initialize the SDK with your application credentials before calling any other methods. Ensure all required properties are set in the appSettings object.

```JavaScript
const appSettings = {
  appId: '76730',
  authKey: 'XydaWcf8OO9xhGT',
  authSecret: 'iiohfdija792hjt',
  accountKey: '7yvNe17TnjNUqDoPwfqp',
};

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

--------------------------------

### Initialize React Project

Source: https://docs.quickblox.com/ui-kits/react-uikit-send-your-first-message

Initialize a new React project with TypeScript and npm. This sets up the basic project structure for integrating the QuickBlox UIKit.

```bash
mkdir react-chat-ui-kit-init-sample
cd react-chat-ui-kit-init-sample
npm init -y
```

--------------------------------

### Create User with Swift

Source: https://docs.quickblox.com/sdks/ios-users

Use `signUp()` to create a new user. Only login and password are required; other fields are optional. Recommended for POCs or development.

```Swift
let user = QBUUser()
user.login = "myLogin"
user.fullName = "myFullName"
user.password = "myPassword"

QBRequest.signUp(user, successBlock: { (response, user) in

}, errorBlock: { (response) in

})
```

--------------------------------

### Setup Custom AI Assist Settings

Source: https://docs.quickblox.com/ui-kits/ios-uikit-ai-features

Customize AI Assist settings such as organization, model, temperature, and token limits. Import QBAIAnswerAssistant to use these configurations.

```swift
import QBAIAnswerAssistant
// Setup custom settings for QBAIAnswerAssistant.
QuickBloxUIKit.feature.ai.answerAssist.organization = "CustomDev"
QuickBloxUIKit.feature.ai.answerAssist.model = .gpt4
QuickBloxUIKit.feature.ai.answerAssist.temperature = 0.8
QuickBloxUIKit.feature.ai.answerAssist.maxRequestTokens = 3500
```

--------------------------------

### Start Private Chat Info Activity

Source: https://docs.quickblox.com/ui-kits/android-uikit-screens

Use the `show()` method of `PrivateChatInfoActivity` to start the activity. Requires context and dialog ID.

```Kotlin
PrivateChatInfoActivity.show(context, dialogId)
```

--------------------------------

### Start Group Chat Info Activity

Source: https://docs.quickblox.com/ui-kits/android-uikit-screens

Use the `show()` method of `GroupChatInfoActivity` to start the activity. Requires context and dialog ID.

```Kotlin
GroupChatInfoActivity.show(context, dialogId)
```

--------------------------------

### Initialize QuickBlox SDK with Credentials

Source: https://docs.quickblox.com/docs/ios-setup

Initialize the framework with your application's Application ID, Authorization Key, Authorization Secret, and Account Key. This is typically done in the AppDelegate file.

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

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

--------------------------------

### Sign Up User (Objective-C)

Source: https://docs.quickblox.com/docs/ios-authentication

Create a new user account with QuickBlox using Objective-C. This method handles user creation and provides callbacks for success or failure.

```objective-c
QBUUser *userInfo = [[QBUUser alloc] init];
userInfo.login = @"myLogin";
userInfo.fullName = @"myFullName";
userInfo.password = @"myPassword";

[QBRequest signUp:userInfo successBlock:^(QBResponse * _Nonnull response, QBUUser * _Nonnull user) {

} errorBlock:^(QBResponse * _Nonnull response) {
}];
```

--------------------------------

### Universal Push Notification - Simple Text Example

Source: https://docs.quickblox.com/reference/push-notification-formats

This example shows how to send a simple text-only universal push notification. The message is Base64 encoded.

```text
I love M&M's! Especially red one!
```

```text
SSBsb3ZlIE0mTSdzISBFc3BlY2lhbGx5IHJlZCBvbmUh
```

```text
event.message=SSBsb3ZlIE0mTSdzISBFc3BlY2lhbGx5IHJlZCBvbmUh
```

--------------------------------

### Initialize QuickBlox SDK with Full Credentials

Source: https://docs.quickblox.com/sdks/flutter-setup

Initializes the QuickBlox SDK using your application ID, authorization key, authorization secret, and account key. This is the standard initialization method.

```APIDOC
## Initialize QuickBlox SDK

Initialize the framework with your application credentials. Pass **Application ID**, **Authorization Key**, **Authorization Secret**, and **Account Key** to the `init()` method.

```Dart Dart theme={null}
String appId = 76730;
String authKey = "XydaWcf8OO9xhGT";
String authSecret = "iiohfdija792hjt";
String accountKey = "7yvNe17TnjNUqDoPwfqp";

void init() async {
  try {
    await QB.settings.init(appId, authKey, authSecret, accountKey);
  } on PlatformException catch (e) {
    // Some error occurred, look at the exception message for more details
  }
}
```

| Argument   | Required | Description                                                               |
| ---------- | -------- | ------------------------------------------------------------------------- |
| appId      | yes      | Application identifier.                                                   |
| authKey    | yes      | Authorization key.                                                        |
| authSecret | yes      | Authorization secret.                                                     |
| accountKey | yes      | Required to get actual apiEndpoint and chatEndpoint for the right server. |

**Security Note**: It's not recommended to keep your **authKey** and **authSecret** inside an application in production mode. Store them on your backend instead.
```

--------------------------------

### Error Response Example (404 Not Found)

Source: https://docs.quickblox.com/reference/download-file

An example of a 404 error response, which may occur due to incorrect arguments or if the file or record does not exist.

```json
{
  "errors": [
    "Wrong arguments"
  ]
}
```

--------------------------------

### Create a Basic Event

Source: https://docs.quickblox.com/reference/create-event

This example demonstrates how to create a basic event with user tags. Ensure you have a valid QB-Token.

```curl
curl -X POST \
        -H "Content-Type: application/json" \
        -H "QB-Token: 519c40c31072fe5dcbe0c24651c7489fab012bba" \
        -d '{  
          "event":{
            "notification_type":"push",
            "environment":"production",
            "user":{
              "tags":{
                "any":"web,android"
              }  
            }
          },
        }' \
        https://api.quickblox.com/events.json
```

--------------------------------

### Get Session Information (cURL)

Source: https://docs.quickblox.com/reference/get-session

Use this cURL command to make a GET request to retrieve session details. Ensure you include a valid QB-Token in the headers.

```bash
curl -X GET \
  -H "QB-Token: 8b75a6c7191285499d890a81df4ee7fe49bc732a" \
  https://api.quickblox.com/session.json
```

--------------------------------

### Initialize QuickBlox SDK with Full Credentials

Source: https://docs.quickblox.com/docs/android-setup

Initialize the SDK with Application ID, Authorization Key, Authorization Secret, and Account Key. This method must be called before any other SDK methods.

```java
static final String APPLICATION_ID = "67895";
static final String AUTH_KEY = "lkjdueksu7392kj";
static final String AUTH_SECRET = "BTFsj7Rtt27DAmT";
static final String ACCOUNT_KEY = "9yvTe17TmjNPqDoYtfqp";

QBSettings.getInstance().init(getApplicationContext(), APPLICATION_ID, AUTH_KEY, AUTH_SECRET);
QBSettings.getInstance().setAccountKey(ACCOUNT_KEY);
```

```kotlin
private const val APPLICATION_ID = "67895"
private const val AUTH_KEY = "lkjdueksu7392kj"
private const val AUTH_SECRET = "BTFsj7Rtt27DAmT"
private const val ACCOUNT_KEY = "9yvTe17TmjNPqDoYtfqp"

QBSettings.getInstance().init(applicationContext, APPLICATION_ID, AUTH_KEY, AUTH_SECRET)
QBSettings.getInstance().accountKey = ACCOUNT_KEY
```

--------------------------------

### Update Movie Record Example

Source: https://docs.quickblox.com/reference/update-record

This JSON shows an example of an updated movie record after a successful API operation. It reflects changes made to the 'movie' array.

```json
{
  "_id": "5f60e245a28f9a78e6c07322",
  "_parent_id": null,
  "created_at": 1600184901,
  "movie": [
    "Star Wars",
    "Titanic"
  ],
  "updated_at": 1600184901,
  "user_id": 102433734,
  "permissions": {
    "read": {
      "access": "open"
    },
    "update": {
      "access": "owner"
    },
    "delete": {
      "access": "owner"
    }
  }
}
```

--------------------------------

### Create Record with QB-Token

Source: https://docs.quickblox.com/reference/create-record

This example demonstrates how to create a new record using the QB-Token for authentication. It includes setting various fields such as score, progress, game mode, user location, date, and completed levels. Permissions can also be configured to control access.

```APIDOC
## POST https://api.quickblox.com/data/ScoreTable.json

### Description
Creates a new record in the ScoreTable.

### Method
POST

### Endpoint
https://api.quickblox.com/data/ScoreTable.json

### Parameters
#### Headers
- **QB-Token** (string) - Required - Authentication token.
- **Content-Type** (string) - Required - Must be application/json.

#### Request Body
- **score_value** (integer) - Optional - The score value for the record.
- **progress** (string) - Optional - The progress value, e.g., "0.12".
- **expert_mode** (boolean) - Optional - Indicates if expert mode is enabled.
- **game_mode_name** (string) - Optional - The name of the game mode.
- **user_location** (string) - Optional - User's location in "latitude,longitude" format.
- **date** (string) - Optional - The date and time of the record in "YYYY-MM-DD HH:MM:SS" format.
- **completed_levels** (array of integers) - Optional - A list of completed level IDs.
- **permissions** (object) - Optional - Object to define access permissions.
  - **read** (object) - Defines read permissions.
    - **access** (string) - Required - Access level (e.g., "owner", "open_for_groups").
  - **update** (object) - Defines update permissions.
    - **access** (string) - Required - Access level (e.g., "owner", "open_for_groups").
    - **user_groups** (array of strings) - Optional - List of user groups allowed to update.

### Request Example
```json
{
  "score_value":665,
  "progress":"0.12",
  "expert_mode":false,
  "game_mode_name":"deathmatch",
  "user_location":"11.13, 45.52",
  "date":"2019-09-21 21:21:00",
  "completed_levels":[
    1,
    2,
    3
  ],
  "permissions": {
    "read": {
      "access":"owner"
    },
    "update": {
      "access":"open_for_groups",
      "user_groups":[
        "world"
      ]
    }
  }
}
```

### Response
#### Success Response (200)
- **_id** (string) - The unique identifier of the created record.
- **_parent_id** (null) - Parent ID, typically null for new records.
- **completed_levels** (array of integers) - List of completed level IDs.
- **created_at** (integer) - Timestamp when the record was created.
- **date** (string) - The date and time of the record.
- **expert_mode** (boolean) - Indicates if expert mode was enabled.
- **game_mode_name** (string) - The name of the game mode.
- **progress** (number) - The progress value.
- **score_value** (integer) - The score value.
- **updated_at** (integer) - Timestamp when the record was last updated.
- **user_avatar** (null) - User avatar URL, typically null.
- **user_id** (integer) - The ID of the user who created the record.
- **user_location** (array of numbers) - User's location as [latitude, longitude].
- **permissions** (object) - The permissions configured for the record.

#### Response Example
```json
{
  "_id": "5d866b53a28f9a5ad51cb562",
  "_parent_id": null,
  "completed_levels": [
    1,
    2,
    3
  ],
  "created_at": 1569090387,
  "date": "2019-09-21T21:21:00Z",
  "expert_mode": false,
  "game_mode_name": "deathmatch",
  "progress": 0.12,
  "score_value": 665,
  "updated_at": 1569090387,
  "user_avatar": null,
  "user_id": 96753878,
  "user_location": [
    11.13,
    45.52
  ],
  "permissions": {
    "read": {
      "access": "owner"
    },
    "update": {
      "access": "open_for_groups",
      "user_groups": [
        "world"
      ]
    },
    "delete": {
      "access": "owner"
    }
  }
}
```
```

--------------------------------

### Initialize QuickBlox SDK

Source: https://docs.quickblox.com/sdks/flutter-quick-start

Initialize the framework with your application credentials. This must be done before calling any other SDK methods except init().

```Dart
String appId = 76730;
String authKey = "XydaWcf8OO9xhGT";
String authSecret = "iiohfdija792hjt";
String accountKey = "7yvNe17TnjNUqDoPwfqp";

void init() async {
  try {
    await QB.settings.init(appId, authKey, authSecret, accountKey);
  } on PlatformException catch (e) {
    // Some error occurred, look at the exception message for more details
  }
}
```

--------------------------------

### Example DELETE Request

Source: https://docs.quickblox.com/reference/delete-records

This is a cURL example demonstrating how to send a DELETE request to the QuickBlox API to remove a specific record. It includes the necessary authentication token.

```bash
curl -X DELETE \
-H "QB-Token: d9c91a69e552145f6fe24dbb40b50ac575012bba" \
https://api.quickblox.com/data/ScoreTable/5d87d2f4a28f9a48631cb55b.json
```

--------------------------------

### Create User with Objective-C

Source: https://docs.quickblox.com/sdks/ios-users

Use `signUp:` to create a new user. Only login and password are required; other fields are optional. Recommended for POCs or development.

```Objective-C
QBUUser *user = [[QBUUser alloc] init];
user.login = @"myLogin";
user.fullName = @"myFullName";
user.password = @"myPassword";

[QBRequest signUp:user successBlock:^(QBResponse * _Nonnull response, QBUUser * _Nonnull user) {

} errorBlock:^(QBResponse * _Nonnull response) {

}];
```

--------------------------------

### Example public/index.html

Source: https://docs.quickblox.com/ui-kits/react-uikit-send-your-first-message

Basic HTML structure for the React application, including a root div for mounting the app.

```html
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>React UIKit Example</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  </head>
  <body>
    <div id="root"></div>
  </body>
</html>
```
Tokens:
Raw