com.quickblox.content

Class QBContent

java.lang.Object

com.quickblox.auth.session.BaseService

com.quickblox.content.QBContent

public class QBContent
extends BaseService

QBContent is the main entry point for operations with Content module.

Method Summary

Modifier and Type	Method and Description
static Performer<QBFile>	createFile(QBFile file) Create a file entity.
static Performer<java.lang.Void>	declareFileUploaded(int fileId, int fileSize) Declare file uploaded.
static Performer<java.lang.Void>	deleteFile(int fileId) Delete a file.
static Performer<java.io.InputStream>	downloadFile(java.lang.String uid) Download file by uid.
static Performer<java.io.InputStream>	downloadFile(java.lang.String uid, Bundle returnedBundle) Download file by uid.
static Performer<java.io.InputStream>	downloadFile(java.lang.String uid, QBProgressCallback progressCallback, Bundle bundle) Download file by uid.
static Performer<java.io.InputStream>	downloadFileById(int fileID, Bundle returnedBundle, QBProgressCallback progressCallback) Download file by id.
static Performer<java.io.InputStream>	downloadFileById(int fileID, QBProgressCallback progressCallback) Download file by id.
static Performer<QBFile>	getFile(int fileId) Get file info.
static Performer<QBFile>	getFile(QBFile file) Get file info.
static Performer<QBFileObjectAccess>	getFileObjectAccess(int fileId) Get file's object access entity with read access
static Performer<java.util.ArrayList<QBFile>>	getFiles(QBPagedRequestBuilder paginationParameters) Get list of users files.
static Performer<java.util.ArrayList<QBFile>>	getFiles(QBPagedRequestBuilder paginationParameters, Bundle returnedBundle) Get list of users files.
static Performer<java.util.ArrayList<QBFile>>	getTaggedList(QBPagedRequestBuilder paginationParameters) Get list of tagged files.
static Performer<java.util.ArrayList<QBFile>>	getTaggedList(QBPagedRequestBuilder paginationParameters, Bundle returnedBundle) Get list of tagged files.
static Performer<QBFile>	updateFile(QBFile file) Update a file (only wrapper).
static Performer<QBFile>	updateFileBlob(QBFile file) Update a file wrapper and also initiates a process to upload new version file to cloud (synchronous).
static Performer<QBFile>	updateFileTask(java.io.File file, int fileId, java.lang.String tags, QBProgressCallback progressCallback) Update file task.
static Performer<java.lang.Void>	uploadFile(java.io.File file, java.lang.String params, QBProgressCallback progressCallback) Upload a file to cloud.
static Performer<QBFile>	uploadFileTask(java.io.File file, boolean publicAccess, java.lang.String tags) Upload File task.
static Performer<QBFile>	uploadFileTask(java.io.File file, boolean publicAccess, java.lang.String tags, QBProgressCallback progressCallback) Upload File task.

Methods inherited from class com.quickblox.auth.session.BaseService

createBaseService, createFromExistentToken, getBaseService, getToken, getTokenExpirationDate, resetCredentials, setToken, setTokenExpirationDate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createFile

public static Performer<QBFile> createFile(QBFile file)

Create a file entity. QBFile is a wrapper around real file data.

Parameters:

file - The file instance to create.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

uploadFile

public static Performer<java.lang.Void> uploadFile(java.io.File file,
                                                   java.lang.String params,
                                                   QBProgressCallback progressCallback)

Upload a file to cloud.

Parameters:

file - The file to be uploaded.

params - QBFileObjectAccess.params value

progressCallback - A QBProgressCallback callback.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

declareFileUploaded

public static Performer<java.lang.Void> declareFileUploaded(int fileId,
                                                            int fileSize)

Declare file uploaded.

Parameters:

fileId - The file id to mark as uploaded.

fileSize - Size of uploaded file, in bytes

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

getFile

public static Performer<QBFile> getFile(int fileId)

Get file info.

Parameters:

fileId - The file id get info about.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

getFile

public static Performer<QBFile> getFile(QBFile file)

Get file info.

Parameters:

file - The file get info about.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

getFiles

public static Performer<java.util.ArrayList<QBFile>> getFiles(QBPagedRequestBuilder paginationParameters)

Get list of users files.

Parameters:

paginationParameters - The pagination parameters.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

getFiles

public static Performer<java.util.ArrayList<QBFile>> getFiles(QBPagedRequestBuilder paginationParameters,
                                                              Bundle returnedBundle)

Get list of users files.

Parameters:

paginationParameters - The pagination parameters.

returnedBundle - The bundle with response additional information.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

getTaggedList

public static Performer<java.util.ArrayList<QBFile>> getTaggedList(QBPagedRequestBuilder paginationParameters)

Get list of tagged files.

Parameters:

paginationParameters - The pagination parameters.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

getTaggedList

public static Performer<java.util.ArrayList<QBFile>> getTaggedList(QBPagedRequestBuilder paginationParameters,
                                                                   Bundle returnedBundle)

Get list of tagged files.

Parameters:

paginationParameters - The pagination parameters.

returnedBundle - The bundle with response additional information.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

downloadFileById

public static Performer<java.io.InputStream> downloadFileById(int fileID,
                                                              QBProgressCallback progressCallback)

Download file by id.

Parameters:

fileID - The id of file to download.

progressCallback - A QBProgressCallback callback.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

downloadFileById

public static Performer<java.io.InputStream> downloadFileById(int fileID,
                                                              Bundle returnedBundle,
                                                              QBProgressCallback progressCallback)

Download file by id.

Parameters:

fileID - The id of file to download.

returnedBundle - The bundle with response additional information.

progressCallback - A QBProgressCallback callback.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

downloadFile

public static Performer<java.io.InputStream> downloadFile(java.lang.String uid)

Download file by uid.

Parameters:

uid - The uid of file to download.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

downloadFile

public static Performer<java.io.InputStream> downloadFile(java.lang.String uid,
                                                          QBProgressCallback progressCallback,
                                                          Bundle bundle)

Download file by uid.

Parameters:

uid - The uid of file to download.

progressCallback - A QBProgressCallback callback.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

downloadFile

public static Performer<java.io.InputStream> downloadFile(java.lang.String uid,
                                                          Bundle returnedBundle)

Download file by uid.

Parameters:

uid - The uid of file to download.

returnedBundle - The bundle with response additional information.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

deleteFile

public static Performer<java.lang.Void> deleteFile(int fileId)

Delete a file.

Parameters:

fileId - The id of file to delete.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

updateFile

public static Performer<QBFile> updateFile(QBFile file)

Update a file (only wrapper).

Parameters:

file - The file entity to update, should contain an id and fields to update.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

updateFileBlob

public static Performer<QBFile> updateFileBlob(QBFile file)

Update a file wrapper and also initiates a process to upload new version file to cloud (synchronous).

Parameters:

file - The file entity to update, should contain an id and fields to update.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

getFileObjectAccess

public static Performer<QBFileObjectAccess> getFileObjectAccess(int fileId)

Get file's object access entity with read access

Parameters:

fileId - A file identifier

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

uploadFileTask

public static Performer<QBFile> uploadFileTask(java.io.File file,
                                               boolean publicAccess,
                                               java.lang.String tags,
                                               QBProgressCallback progressCallback)

Upload File task.

Parameters:

file - The file to be uploaded.

publicAccess - Is file publicly accessible (without session token) (by default: false)

tags - Coma separated string with users' tags to share a file with

progressCallback - A QBProgressCallback callback.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

uploadFileTask

public static Performer<QBFile> uploadFileTask(java.io.File file,
                                               boolean publicAccess,
                                               java.lang.String tags)

Upload File task.

Parameters:

file - The file to be uploaded.

publicAccess - Is file publicly accessible (without session token) (by default: false)

tags - Coma separated string with users' tags to share a file with

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

updateFileTask

public static Performer<QBFile> updateFileTask(java.io.File file,
                                               int fileId,
                                               java.lang.String tags,
                                               QBProgressCallback progressCallback)

Update file task.

Parameters:

file - The new file to be uploaded.

fileId - The id of file to update.

tags - Coma separated string with users' tags to share a file with.

progressCallback - A QBProgressCallback callback.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0