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.
Session token rights
There are different types of session tokens to support different use cases.Application session token | Description |
---|---|
Application session token | This kind of access token is needed to read the app data. Has only READ access to resources. The expiration time after the last REST API request is 2 hours. |
User session token | The user token is the most commonly used type of token. This kind of access token is needed any time the app calls an API to read, modify or write a specific user’s data on their behalf. Has READ/WRITE access to resources. The expiration time after the last REST API request is 2 hours. |
Get session
You can check whether you have a session or not.Dart
Sign up user
Before you log in the user, you must create the user on QuickBlox. Recommendations are below:- For POCs/MVPs: Create the user using the QuickBlox Dashboard or in client app with application session token.
- For production apps: Use the QuickBlox Create User API with API key on your backend to create the user when your user signs up in your app.
SecurityIt’s recommended to disable permission to create users with application session on production apps once user creation is implemented on your backend.
createUser()
method.
Bash
Log in user
If you have an application session, you can upgrade it to a user session by callinglogin()
method.
Dart
Log out user
If you have a user session, you can downgrade it to an application session by callinglogout()
method.
Dart
Session expiration
The expiration time for a session token is 2 hours. If you will perform a query with an expired token, you will receive an error:Required session does not exist
. In this case, you have to recreate the session token.
In Flutter SDK since version 0.9.0, we have a listener to find if the session token has expired.
Dart
Set existing session
Typically, a session token is stored in SDK after successful login and used for every subsequent API call. However, you may want to obtain and store the session on your server for better security. In this case, you can set application or user token into SDK using thestartSessionWithToken()
method, also before calling the method to get notified that the session has expired you need to add session expiration listener. Don’t forget to log in user if you pass the application token.
Dart
If you have a version lower than 0.9.0, you can set the existing session token into SDK using the setSession() method.
Dart
qbSession
.
Field | Required | Description |
---|---|---|
applicationId | yes | Application ID. |
userId | yes | User ID. |
expirationDate | yes | Session token expiration date. |
token | yes | QuickBlox session token. |