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.
Retrieve files
Get a list of files for a current user using the code snippet below.JavaScript
Upload file
Upload a file to the cloud storage using the following code snippet.JavaScript
Basic | Startup | Growth | HIPAA | Enterprise | |
---|---|---|---|---|---|
File size limit | 10 Mb | 25 Mb | 50Mb | 50Mb | Contact our sales team |
Update file
You can update a file name using theupdate()
method.
JavaScript
params
:
Field | Required | Description |
---|---|---|
id | yes | ID of the file. |
name | yes | File name. |
Download file by UID
If the file is public then it’s possible to download it without a session token.JavaScript
Get file info
Get information about a file by ID using thegetInfo()
method below. This method allows to load the file description model from the server, not the content of the file itself.
JavaScript
Argument | Required | Description |
---|---|---|
fileId | yes | ID of the file. |
function() | yes | Specifies a callback function that accepts that accepts an error and result. |
Get file URL
Except for downloading, you can also get URL of each file. There are two types of file URLs that can be obtained: private and public.- Public URL allows anyone to access the file, no authorization token is needed.
- Private URL can be accessed only by QuickBlox user with a session token.
Get public URL
To receive a public URL, use the code snippet below.JavaScript
Argument | Required | Description |
---|---|---|
fileUID | yes | File unique identifier. You can take the fileUID from the object received as a result of the createAndUpload() or getInfo() method. |
Get private URL
To get a private URL of the uploaded file, use the following code snippet.JavaScript
Argument | Required | Description |
---|---|---|
fileUID | yes | File unique identifier. You can take the fileUID from the object received as a result of the createAndUpload() or getInfo() method. |
Delete file
Delete a file by file ID using thedelete()
method below.
JavaScript
Argument | Required | Description |
---|---|---|
fileId | yes | ID of the file. |
function() | yes | Specifies a callback function that accepts that accepts an error and result. |