Custom Objects - QuickBlox

Custom Objects module provides flexibility to define any data structure (schema) you need, build one-to-many relations between schemas and control permissions for all operations made on data. Schema is defined in QuickBlox Dashboard. There are two key concepts in Custom Objects: - Class represents your schema and contains field names and types. - Record represents the data you put into your schema. Class and Record are similar to table and row in relational database. Every class in Custom Object module comes with five mandatory predefined fields: _id, user_id, parent_id, created_at, and updated_at. Allowed data types: Integer (or Array of Integer); String (or Array of String); Float (or Array of Float); Boolean (or Array of Boolean); Location (Array of [< longitude >, < latitude >]); File; Date. Visit Key Concepts page to learn the most important QuickBlox concepts.

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 Setup page for more details.
Create a user session to be able to use QuickBlox functionality. See Authentication page to learn how to do it.

Create class

To start using Custom Objects module, create a class:

Go to QuickBlox Dashboard.
Follow Custom => Add => Add new class direction. As a result, Add new class popup will appear.
Enter a class name, add any fields you want.

Click Create class button to create a new class.

Create records

Here is the easiest way to create a new record from the QuickBlox Dashboard:

Follow Custom => Current class => Your Class direction.
Click Add => Add record button.
Fill in any fields you want.
Click Add record button and a new record will be added and shown in the table.

You can also create a new record/records using the create() method. To create a single record, use the code snippet below.

JavaScript

var className = 'GameOfThrones';
var data = {
  name: 'John',
  age: 20,
  family: [ 'Stark', 'Targaryen' ]
};

QB.data.create(className, data, function (error, result) {
  // ...
});

To create multiple records, use the code snippet below.

JavaScript

var className = "GameOfThrones/multi";
var data = {
  record: {
    0: {
      name: "John",
      age: 20,
      family: ["Stark", "Targaryen"],
    },
    1: {
      name: "Daenerys",
      age: 21,
      family: ["Targaryen"],
    },
  },
};

QB.data.create(className, data, function (error, result) {
  // ...
});

Argument	Required	Description
className	yes	A name of a custom object class.
data	yes	Data records that will be created.
function()	yes	Specifies a callback function that accepts an error and result.

Retrieve records by IDs

You can get records with a particular record ID using the list() method.

JavaScript

var className = "Note";
var ids = ["53aaa06f535c12cea9007496", "53aaa06f535c12cea9007495"];
// use filter or ids to get records:
QB.data.list(className, ids, function (error, result) {
  if (error) {
    console.log(error);
  } else {
    console.log(result);
  }
});

Argument	Required	Descriptions
className	yes	A name of a custom object class.
ids	yes	Records IDs.
function()	yes	Specifies a callback function that accepts an error and result.

Retrieve records

You can search for records of a particular class. The request below will return records of the Note class with specific IDs in the array.

JavaScript

var className = "Note";
var filter = {
  _id: {
    in: ["5f59b10fa0eb4772bd5e9976", "5f59a76ca28f9a28032944d3"],
  },
};

QB.data.list(className, filter, function (error, result) {
  if (error) {
  } else {
  }
});

Argument	Required	Description
className	yes	A name of a custom object class.
filter	yes	Specifies filtering criteria for the field.
function()	yes	Specifies a callback function that accepts an error and result.

If you want to retrieve only records updated after some specific date time and order the search results, you can apply operators. Thus, you can apply search and sort operators to list records on the page so that it is easier to view specific records. If you want to get a paginated list of dialogs from the server, you can set the following fields of the filter:

Field	Required	Description
skip	no	Skip N records in search results. Useful for pagination. Default (if not specified): 0. Should be an Integer.
limit	no	Limit search results to N records. Useful for pagination. Default value: 100.

Search operators

You can use search operators to get more specific search results. The request below will return two records of the GameOfThrones by the age field with a value greater than 20, limited to 2 records on the page.

JavaScript

let className = "GameOfThrones";
let filter = {
  'age': {
    'gt': 20
  },
  limit:2
};

QB.data.list(className, filter, function(err, result){

});

Here are the search operators that you can use to search for the exact data that you need.

Search operators	Applicable to types	Description
lt	integer, float	Less Than operator.
lte	integer, float	Less Than or Equal to operator.
gt	integer, float	Greater Than operator.
gte	integer, float	Greater Than or Equal to operator.
ne	integer, float, string, boolean	Not Equal to operator.
in	integer, float, string	IN array operator.
nin	integer, float, string	Not IN array operator.
all	array	ALL are contained in array.
or	integer, float, string	All records that contain a value 1 or value 2.
ctn	string	All records that contain a particular substring.

Sort operators

You can use sort operators to order the search results. The request below will return records of GameOfThrones class sorted in descending order by the created_at field.

JavaScript

let className = "GameOfThrones";
let filter = {
  sort_desc: "created_at"
};

QB.data.list(className, filter, function(err, result){

});

Here are the sort options that you can use to sort the search results.

Sort options	Applicable to types	Description
sort_asc	All types	Search results will be sorted in ascending order by the specified field.
sort_desc	All types	Search results will be sorted in descending order by the specified field.

Aggregation operators

You can use an aggregation operator to count search results. The request below will return a count of all records of the GameOfThrones class.

JavaScript

let className = "GameOfThrones";
let filter = {
  count:1
};

QB.data.list(className, filter, function(err, result){

});

Here are the aggregation operators you can use to count records:

Aggregation operator	Description
count	Count search results. The response will contain only a count of records found. Set count to 1 to apply.

Update records

You can update a single record using the update() method. You should know the record ID in this case.

JavaScript

var className = 'GameOfThrones';
var data = {
  _id: '53aaa06f535c12cea9007496',
  name: 'John',
  age: 21,
  family: ['Stark']
};

QB.data.update(className, data, function(error, result) {
  // ...
});

You can update multiple records using the code snippet below.

JavaScript

var className = 'GameOfThrones/multi';
var data = {
  "record":{
    "0":{
      name: 'John',
      age: 20,
      family: [ 'Stark', 'Targaryen' ]
    },
    "1":{
      name: 'Daenerys',
      age: 21,
      family: [ 'Targaryen' ]
    }
  }
};

QB.data.update(className, data, function (error, result) {
  // ...
});

Delete records

To delete a record/records, use the delete() method. To delete a single record, use the code snippet below.

JavaScript

var className = "Movie";

// By ID
var id = "502f7c4036c9ae2163000002";
QB.data.delete(className, id, function(error, result) {
  // ...
});

Argument	Required	Description
className	yes	A name of a custom object class.
id	yes	ID of the record.
function()	yes	Specifies a callback function that accepts an error and result.

To delete multiple records, use the code snippet below.

JavaScript

var className = "Movie";

// By IDs
var ids = ["502f7c4036c9ae2163000002", "502f7c4036c9ae2163000003"];
QB.data.delete(className, ids, function(error, result) {
  // ...
});

Argument	Required	Description
className	yes	A name of a custom object class.
ids	yes	Records IDs.
function()	yes	Specifies a callback function that accepts an error and result.

To delete a record by criteria, use the code snippet below.

JavaScript

var className = "Movie";

// By criteria
var criteria = {
  price: { gt: 100 }
};

QB.data.delete(className, criteria, function(error, result) {
  // ...
});

Argument	Required	Description
className	yes	A name of a custom object class.
criteria	yes	Specifies criteria fields that should be set.
function()	yes	Specifies a callback function that accepts an error and result.

Relations

It is possible to create a relation between objects of two different classes via _parent_id field. For example, we have the class Rating that contains score, review, and comment fields. We also have a Movie class. So we can create a record of class Rating that will point to the record of the class Movie via its _parent_id field, so the _parent_id field will contain the ID of record from class Movie.

This is not a simple soft link. This is actually a hard link. When you delete the Movie class record then all its children (records of class Rating with _parent_id field set to the Movie class record ID) will be automatically deleted as well.

If you need to retrieve all children, you can retrieve records with the filter _parent_id=<id_of_parent_class_record>.

Permissions

Access control list (ACL) is a list of permissions attached to some object. An ACL specifies which users have access to objects as well as what operations are allowed on given objects. Each entry in a typical ACL specifies a subject and an operation. ACL models may be applied to collections of objects as well as to individual entities within the system hierarchy.

Access Control list available only for Custom Objects module.

Permission schema

QuickBlox Permission schema contains five permissions levels:

Open (open) Such permission schema means that any user within the application can access the record/records in the class and is allowed to perform an action with the current permission level.
Owner (owner) Owner permission level means that only Owner (a user who created a record) is allowed to perform action with the current permission level.
Not allowed (not_allowed) No one (except for the Account Administrator) can make a chosen action.
Open for groups (open_for_groups) Users having a specified tag/tags (see more info about how to set tags for the user in Users will be included in the group that is allowed to perform an action with the current permission level. The current permission level can consist of one or several groups (number of groups is not limited). Tags can be added/deleted in the user’s profile.
Open for user ids (open_for_users_ids) Only users that are specified in the permission level can make a required action with a record. One or several users can be specified (the number of users is not limited).

Actions available for the entity

Create Create a record.
Read Retrieve and read the info about the chosen record.
Update Update any parameter for the chosen record (only those parameters that can be set by the user can be updated).
Delete Delete a record.

Permission levels

There are two access levels in the Permissions schema: Class and Record.

Class entity

Only the Account Administrator can create a class in the Custom object module and make all possible actions with it. Operations with Class entity are not allowed in API. All actions (Create, Read, Update, and Delete) are available for the class entity and are applicable for all records in the class. Every action has a separate permission level available. The exception is a Create action that is not available for the Owner permission level. To set a permission schema for the Class, do the following:

Go to the Custom Objects tab.
Open a required class.
Click Edit permissions button to open a class and edit it.

Default Class permission schema is used while creating a class:

Create: Open
Read: Open
Update: Owner
Delete: Owner

Mark checkboxes to enable class permissions.

Record entity

A record is an entity within the class in the Custom Objects module that has its own permission levels. You can create a record in the Dashboard and API (see Create Record request for more details). All permission levels except for the Not Allowed are available for the record and there are only three actions available and applicable for the record: Read, Update, and Delete. Default Record permission schema is used while creating a class:

Read: Open
Update: Owner
Delete: Owner

To set a permission level open the required Class and click the record to edit it.

Choosing a permission schema

Only one permission level can be applicable to the record: class permission schema or record permission schema. To apply class permission levels to all records in the class, tick the checkbox in the Use Class permissions column near the required Action in the Dashboard.

Using a class permission schema means that a record permission schema will not affect a reсord.

In case, the Admin does not tick the checkbox in the Dashboard a user has a possibility to change permission levels for every separate record in the table or create a new one with the ACL that a user requires.

Create record with permissions

Let’s create a record with the next permissions:

READ: Open.
UPDATE: Users in groups golf, man.
DELETE: Users with IDs 3060, 63635.

JavaScript

var className = "Blog";
var permissions = {
  read: { access: "open" },
  update: { access: "open_for_groups", groups: ["golf", "man"] },
  delete: { access: "open_for_users_ids", ids: [3060, 63635] }
};

var params = {
  name: "Star Wars",
  genre: "fantasy",
  permissions: permissions
};

QB.data.create(className, params, function(error, result) {
  if (error) {
    console.log(error);
  } else {
    console.log(result);
  }
});

Update record permissions

Let’s update record permissions to next:

READ: Users in groups car, developers.
UPDATE: Owner.
DELETE: Owner.

JavaScript

var className = "Blog";
var permissions = {
  read: { access: "open_for_groups", groups: ["car", "developers"] ,
  update: { access: "owner" },
  delete: { access: "owner" }
};
var payload = {
  name: "Star Wars",
  genre: "fantasy",
  permissions: permissions
};
QB.data.update(className, payload, function(error, result) {
  // ...
});

Argument	Required	Description
className	yes	A name of a custom object class.
payload	yes	Specifies payload fileds that should be set.
function()	yes	Specifies a callback function that accepts an error and result.

Files

Custom Objects module supports the File field type. It is created to work easily with content from the Custom Objects module. There is an ability to upload, download, update and delete the content of file fields.

Upload/Update file

Use the code lines below to upload/update a file.

JavaScript

var className = "Blog";
var recordId = "42453312753abce36783882222";
var fileInput = document.querySelector("input[type=file]");
var file = fileInput.files[0];

var params = {
  id: recordId,
  field_name: "user_avatar",
  file: file,
  name: file.name
};

QB.data.uploadFile(className, params, function(error, result) {
  if (error) {
    console.log(error);
  } else {
    console.log(result);
  }
});

Download file

To download a file, use the code snippet below.

JavaScript

var className = "Movie";

var paramsFor = {
  id: "1734252234523893bae6739922339984a3bb",
  field_name: "poster"
};

var fileUrl = QB.data.fileUrl(className, paramsFor);

var anchorHTML = '<a href="' + fileUrl + '" download>Download</a>';

Delete file

To delete a file, use the code snippet below.

JavaScript

var className = "Blog";
var recordId = "42453312753abce36783882222";
var params = {
  id: recordId,
  field_name: "user_avatar"
};

QB.data.deleteFile(className, params, function(error, result){
    if (error) {
        console.log(error);
    } else {
        console.log(result);
    }
});

​Before you begin

​Create class

​Create records

​Retrieve records by IDs

​Retrieve records

​Search operators

​Sort operators

​Aggregation operators

​Update records

​Delete records

​Relations

​Permissions

​Permission schema

​Actions available for the entity

​Permission levels

​Class entity

​Record entity

​Choosing a permission schema

​Create record with permissions

​Update record permissions

​Files

​Upload/Update file

​Download file

​Delete file

Before you begin

Create class

Create records

Retrieve records by IDs

Retrieve records

Search operators

Sort operators

Aggregation operators

Update records

Delete records

Relations

Permissions

Permission schema

Actions available for the entity

Permission levels

Class entity

Record entity

Choosing a permission schema

Create record with permissions

Update record permissions

Files

Upload/Update file

Download file

Delete file