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 user
It’s recommended to manage user creation at your backend for production. To learn more you can refer to QuickBlox API documentation. For POCs/MVPs or during development you may want to create users on the fly, you can usecreateUser()
method.
Create a user using the code snippet below. Only login (or email) and password are required. Other fields are optional.
Dart
Argument | Required | Description |
---|---|---|
login | yes | User login. |
password | yes | User password. |
no | User email. | |
blobId | no | User blob ID. |
externalUserId | no | User external ID. |
facebookId | no | User facebook ID. |
twitterId | no | User twitter ID. |
fullName | no | User full name. |
phone | no | User phone. |
website | no | User website. |
customData | no | User custom data. |
tagList | no | User tag list. |
Security & PrivacyIt’s recommended to disable permission to create users with application session on production apps once user creation is implemented on your backend.Email, full name, facebookId and phone number are PII, configure session permissions according to your privacy requirements.
Retrieve users
Get a list of users using thegetUsers()
method. The code snippet below shows how to get a list of users created between the two given dates, sorted in descending order, and limited to 100 users on the page.
Dart
getUsers()
accepts two (optional) arguments of the object type that can have the following fields:
Field | Required | |
---|---|---|
filter | no | Specifies filtering criteria for the field. |
sort | no | Specifies sorting criteria for the field. |
page | no | Number of pages with results to be returned. |
perPage | no | Number of records to return in one page. |
Search operators
You can use search operators to get more specific search results. The request below will return a list of users with a login other than the one specified.Dart
Search operators | Applicable to types | Applicable to fields | Description |
---|---|---|---|
lt | number, string, date | id, created_at, updated_at, last_request_at, external_user_id, facebook_id | Less Than operator. |
gt | number, string, date | id, created_at, updated_at, last_request_at, external_user_id, facebook_id | Greater Than operator. |
ge | number, string, date | id, created_at, updated_at, last_request_at, external_user_id, facebook_id | Greater Than or Equal to operator. |
le | number, string, date | id, created_at, updated_at, last_request_at, external_user_id, facebook_id | Less or Equal to operator |
eq | number, string, date | id, full_name, email, login, phone, created_at, updated_at, last_request_at, external_user_id, facebook_id | Equal to operator. |
ne | number, string, date | id, full_name, email, login, phone, created_at, updated_at, last_request_at, external_user_id, facebook_id | Not Equal to operator. |
between | number, string, date | id, created_at, updated_at, last_request_at, external_user_id, facebook_id | Contained between values operator. |
in | number, string, date | id, full_name, email, login, phone, created_at, updated_at, last_request_at, external_user_id, facebook_id | IN array operator. |
Sort operators
You can use sort operators to order the search results. The request below will return a list of users with the login sorted in descending order.Dart
Sort options | Applicable to types | Applicable to fields | Description |
---|---|---|---|
ascending | All types | id, full_name, email, login, phone, website, created_at, updated_at,last_request_at, external_user_id | Sort results in ascending order by setting the ascending as true. |
descending | All types | id, full_name, email, login, phone, website, created_at, updated_at,last_request_at, external_user_id | Sort results in descending order by setting the ascending as false. |
Retrieve users by full name
To get a list of users by full name for a current account, user the following code snippet.Dart
Argument | Required | Description |
---|---|---|
fullName | yes | A string of fullName |
page | no | Number of pages with results to be returned. Default: 1. |
perPage | no | Number of records to return in one page. Min: 1. Default: 100. |
Retrieve users by tag
To get a list of users by tag for a current account, use the following code snippet.Dart
Argument | Required | Description |
---|---|---|
tags | yes | An array of tags. Min: 1. |
page | no | Number of pages with results to be returned. Default: 1. |
perPage | no | Number of records to return in one page. Min: 1. Default: 100. |
Reset user password
This feature is coming soon. Please check back later. For more updates and questions, feel free to contact our Customer Support Team.
Update user
Update a user profile by calling theupdateUser()
method. If you want to change your password, you need to provide 2 parameters: password
and newPassword
. The updated user
entity will be returned. You can also update any other field of the user using the updateUser()
method. Thus, the snippet below shows how to update a tagList
and customData
fields.
Dart
Argument | Required | Description |
---|---|---|
login | yes | User login. |
customData | no | User custom data. Should be a String. You can convert any data types to String, for example, JSON, XML , etc. |
tagList | no | User tags. A comma separated String without any spaces. A tag should contain alphanumeric characters and start with a letter. For example, the “tagOne” format is correct while the “tag one” format is incorrect. If more that 10 tags are provided, an error is returned: tag list should contain maximum 10 tags. |
Set user avatar
To set a user avatar, just upload a file to the QuickBlox cloud storage and connect it to the user. To upload the file to the QuickBlox cloud storage, call theupload()
method and pass the imageFileUrl
to it. The imageFileUrl
is a path to the file in the device filesystem. Now that the file is uploaded, get the ID of the uploaded file.
To connect the file to the user, set the ID of the uploaded file to the blobId
field of the user
and call the updateUser()
method. As a result, the user avatar gets updated.
Dart
updateUser()
method:
Argument | Required | Description |
---|---|---|
userLogin | yes | User login. |
blobId | no | User blob ID. |
Get user avatar
Now, other users can get access to your avatar by calling thegetPrivateURL()
method. As a result, you will receive a private URL in the response. See this section to learn more about file URLs.
Dart
Delete user
A user can delete himself from the platform.Dart