com.quickblox.customobjects

Class QBCustomObjects

java.lang.Object

com.quickblox.auth.session.BaseService

com.quickblox.customobjects.QBCustomObjects

public class QBCustomObjects
extends BaseService

Constructor Summary

Constructors

Constructor and Description
QBCustomObjects()

Method Summary

Modifier and Type	Method and Description
static Performer<java.lang.Integer>	countObjects(java.lang.String className) Retrieve records count with search parameters
static Performer<java.lang.Integer>	countObjects(java.lang.String className, QBRequestGetBuilder requestBuilder) Retrieve records count with search parameters
static Performer<QBCustomObject>	createObject(QBCustomObject customObject) Create record
static Performer<java.util.ArrayList<QBCustomObject>>	createObjects(java.util.List<QBCustomObject> customObjects) Create records
static Performer<java.lang.Void>	deleteObject(QBCustomObject customObject) Delete record by identifier
static Performer<java.lang.Void>	deleteObject(java.lang.String className, java.lang.String customObjectId) Delete records
static Performer<java.util.ArrayList<java.lang.String>>	deleteObjects(java.lang.String className, <any> customObjectIds) Delete records
static Performer<java.util.ArrayList<java.lang.String>>	deleteObjects(java.lang.String className, <any> customObjectIds, Bundle callback) Delete records
static Performer<java.util.ArrayList<QBAggregationItem>>	getAggregationObjects(java.lang.String className, QBAggregationRequestBuilder aggregationRule, QBRequestGetBuilder requestBuilder) Retrieve records by aggregation operators :avg, min, max, sum.
static Performer<QBCustomObject>	getObject(QBCustomObject customObject) Retrieve object with ID
static Performer<QBCustomObject>	getObject(QBCustomObject customObject, java.util.List<java.lang.Object> outputParams) Retrieve object with ID
static Performer<QBCustomObject>	getObject(java.lang.String className, java.lang.String customObjectId) Retrieve object with ID
static Performer<QBCustomObject>	getObject(java.lang.String className, java.lang.String customObjectId, java.util.List<java.lang.Object> outputParams) Retrieve object with ID
static Performer<QBPermissions>	getObjectPermissions(java.lang.String className, java.lang.String customObjectId) Retrieve permissions for object with ID
static Performer<java.util.ArrayList<QBCustomObject>>	getObjects(java.lang.String className) Retrieve objects
static Performer<java.util.ArrayList<QBCustomObject>>	getObjects(java.lang.String className, java.util.List<java.lang.String> outputParams) Retrieve objects
static Performer<java.util.ArrayList<QBCustomObject>>	getObjects(java.lang.String className, java.util.List<java.lang.String> outputParams, Bundle addParams) Retrieve objects
static Performer<java.util.ArrayList<QBCustomObject>>	getObjects(java.lang.String className, QBRequestGetBuilder requestBuilder) Retrieve objects
static Performer<java.util.ArrayList<QBCustomObject>>	getObjects(java.lang.String className, QBRequestGetBuilder requestBuilder, Bundle bundle) Retrieve objects
static Performer<java.util.ArrayList<QBCustomObject>>	getObjectsByIds(java.lang.String className, <any> coIDs) Retrieve objects by Ids
static Performer<java.util.ArrayList<QBCustomObject>>	getObjectsByIds(java.lang.String className, <any> coIDs, java.util.List<java.lang.String> outputParams) Retrieve objects by Ids
static Performer<QBCustomObject>	updateObject(QBCustomObject customObject) Update record with Special update operators
static Performer<QBCustomObject>	updateObject(QBCustomObject customObject, QBRequestUpdateBuilder requestBuilder) Update record with Special update operators
static Performer<java.util.ArrayList<QBCustomObject>>	updateObjects(java.util.List<QBCustomObject> customObjects) Update records
static Performer<java.util.ArrayList<QBCustomObject>>	updateObjects(java.util.List<QBCustomObject> customObjects, Bundle params) Update records

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

Constructor Detail

QBCustomObjects

public QBCustomObjects()

Method Detail

createObject

public static Performer<QBCustomObject> createObject(QBCustomObject customObject)

Create record

Parameters:

customObject - instance of object that will be created

Returns:

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

Since:

3.0

createObjects

public static Performer<java.util.ArrayList<QBCustomObject>> createObjects(java.util.List<QBCustomObject> customObjects)

Create records

Parameters:

customObjects - list of instances of objects that will be created

Returns:

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

Since:

3.0

getObject

public static Performer<QBCustomObject> getObject(QBCustomObject customObject,
                                                  java.util.List<java.lang.Object> outputParams)

Retrieve object with ID

Parameters:

customObject - instance of object with ID that will be retrieved

outputParams - Object in response will contain only specified in outputParams fields

Returns:

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

Since:

3.0

getObject

public static Performer<QBCustomObject> getObject(QBCustomObject customObject)

Retrieve object with ID

Parameters:

customObject - instance of object with ID that will be retrieved

Returns:

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

Since:

3.0

getObjectPermissions

public static Performer<QBPermissions> getObjectPermissions(java.lang.String className,
                                                            java.lang.String customObjectId)

Retrieve permissions for object with ID

Parameters:

className - Name of class

customObjectId - Identifier of object which permissions will be retrieved

Returns:

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

Since:

3.0

getObject

public static Performer<QBCustomObject> getObject(java.lang.String className,
                                                  java.lang.String customObjectId,
                                                  java.util.List<java.lang.Object> outputParams)

Retrieve object with ID

Parameters:

className - Name of class

customObjectId - Identifier of object that will be retrieved

outputParams - Object in response will contain only specified in outputParams fields

Returns:

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

Since:

3.0

getObject

public static Performer<QBCustomObject> getObject(java.lang.String className,
                                                  java.lang.String customObjectId)

Retrieve object with ID

Parameters:

className - Name of class

customObjectId - Identifier of object that will be retrieved

Returns:

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

Since:

3.0

getObjects

public static Performer<java.util.ArrayList<QBCustomObject>> getObjects(java.lang.String className)

Retrieve objects

Parameters:

className - Name of class

Returns:

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

Since:

3.0

getObjects

public static Performer<java.util.ArrayList<QBCustomObject>> getObjects(java.lang.String className,
                                                                        java.util.List<java.lang.String> outputParams)

Retrieve objects

Parameters:

className - Name of class

outputParams - Records in response will contain only specified in outputParams fields

Returns:

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

Since:

3.0

getObjects

public static Performer<java.util.ArrayList<QBCustomObject>> getObjects(java.lang.String className,
                                                                        java.util.List<java.lang.String> outputParams,
                                                                        Bundle addParams)

Retrieve objects

Parameters:

className - Name of class

outputParams - Records in response will contain only specified in outputParams fields

Returns:

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

Since:

3.0

getObjects

public static Performer<java.util.ArrayList<QBCustomObject>> getObjects(java.lang.String className,
                                                                        QBRequestGetBuilder requestBuilder)

Retrieve objects

Parameters:

className - Name of class

requestBuilder - instance of QBCustomObjectRequestBuilder. It allows to specify search parameters

Returns:

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

Since:

3.0

getObjects

public static Performer<java.util.ArrayList<QBCustomObject>> getObjects(java.lang.String className,
                                                                        QBRequestGetBuilder requestBuilder,
                                                                        Bundle bundle)

Retrieve objects

Parameters:

className - Name of class

requestBuilder - instance of QBCustomObjectRequestBuilder. It allows to specify search parameters

Returns:

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

Since:

3.0

getObjectsByIds

public static Performer<java.util.ArrayList<QBCustomObject>> getObjectsByIds(java.lang.String className,
                                                                             <any> coIDs)

Retrieve objects by Ids

Parameters:

className - Name of class

coIDs - array list of identifiers of objects to be retrieved

Returns:

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

Since:

3.0

getObjectsByIds

public static Performer<java.util.ArrayList<QBCustomObject>> getObjectsByIds(java.lang.String className,
                                                                             <any> coIDs,
                                                                             java.util.List<java.lang.String> outputParams)

Retrieve objects by Ids

Parameters:

className - Name of class

coIDs - array list of identifiers of objects to be retrieved

outputParams - Records in response will contain only specified in outputParams fields

Returns:

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

Since:

3.0

getAggregationObjects

public static Performer<java.util.ArrayList<QBAggregationItem>> getAggregationObjects(java.lang.String className,
                                                                                      QBAggregationRequestBuilder aggregationRule,
                                                                                      QBRequestGetBuilder requestBuilder)

Retrieve records by aggregation operators :avg, min, max, sum. (synchronous)

Parameters:

className - Name of class

aggregationRule - builder for aggregation operators

Returns:

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

Since:

3.0

updateObject

public static Performer<QBCustomObject> updateObject(QBCustomObject customObject,
                                                     QBRequestUpdateBuilder requestBuilder)

Update record with Special update operators

Parameters:

customObject - An instance of object that will be updated

requestBuilder - instance of QBCustomObjectRequestBuilder. It allows to specify Special update operators: link

Returns:

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

Since:

3.0

updateObject

public static Performer<QBCustomObject> updateObject(QBCustomObject customObject)

Update record with Special update operators

Parameters:

customObject - An instance of object that will be updated

Returns:

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

Since:

3.0

updateObjects

public static Performer<java.util.ArrayList<QBCustomObject>> updateObjects(java.util.List<QBCustomObject> customObjects)

Update records

Parameters:

customObjects - list of instances of objects that will be updated

Returns:

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

Since:

3.0

updateObjects

public static Performer<java.util.ArrayList<QBCustomObject>> updateObjects(java.util.List<QBCustomObject> customObjects,
                                                                           Bundle params)

Update records

Parameters:

customObjects - list of instances of objects that will be updated

params - Bundle which will contain additional response data (In this request it will contain list of not found identifiers. To retrieve their just call params.getStringArrayList(Consts.NOT_FOUND_IDS);)

Returns:

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

Since:

3.0

deleteObject

public static Performer<java.lang.Void> deleteObject(java.lang.String className,
                                                     java.lang.String customObjectId)

Delete records

Parameters:

className - Name of class

customObjectId - Identifier of object that will be deleted

Returns:

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

Since:

3.0

deleteObject

public static Performer<java.lang.Void> deleteObject(QBCustomObject customObject)

Delete record by identifier

Parameters:

customObject - Instance of object with identifier that will be deleted

Returns:

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

Since:

3.0

deleteObjects

public static Performer<java.util.ArrayList<java.lang.String>> deleteObjects(java.lang.String className,
                                                                             <any> customObjectIds)

Delete records

Parameters:

className - Name of class

customObjectIds - Array list of IDs of objects to be removed.

Returns:

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

Since:

3.0

deleteObjects

public static Performer<java.util.ArrayList<java.lang.String>> deleteObjects(java.lang.String className,
                                                                             <any> customObjectIds,
                                                                             Bundle callback)

Delete records

Parameters:

className - Name of class

customObjectIds - Array list of IDs of objects to be removed.

Returns:

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

Since:

3.0

countObjects

public static Performer<java.lang.Integer> countObjects(java.lang.String className,
                                                        QBRequestGetBuilder requestBuilder)

Retrieve records count with search parameters

Parameters:

className - Name of class

requestBuilder - instance of QBCustomObjectRequestBuilder. It allows to specify search operators: link

Returns:

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

Since:

3.0

countObjects

public static Performer<java.lang.Integer> countObjects(java.lang.String className)

Retrieve records count with search parameters

Parameters:

className - Name of class

Returns:

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

Since:

3.0