com.quickblox.core.request

Class QBRequestUpdateBuilder

java.lang.Object

QBRequestBuilder

com.quickblox.core.request.QBLimitedRequestBuilder

com.quickblox.core.request.QBRequestUpdateBuilder

Direct Known Subclasses:

QBDialogRequestBuilder

public class QBRequestUpdateBuilder
extends QBLimitedRequestBuilder

The QBRequestUpdateBuilder allows to set parameters for an update request. More info about special update operators.

Constructor Summary

Constructors

Constructor and Description
QBRequestUpdateBuilder() Constructs a new QBRequestUpdateBuilder object

Method Summary

Modifier and Type	Method and Description
QBRequestUpdateBuilder	addRule(java.lang.String fieldName, java.lang.String rule, java.lang.Object value) Add a custom rule to the request.
QBRequestUpdateBuilder	addToSet(java.lang.String fieldName, java.lang.Object value) Adds a value to an array only if the value is not in the array already
QBRequestUpdateBuilder	inc(java.lang.String fieldName, java.lang.Object value) Increment operator
QBRequestUpdateBuilder	pop(java.lang.String fieldName, java.lang.Object value) Removes last element from array.
QBRequestUpdateBuilder	pull(java.lang.String fieldName, java.lang.Object value) Operator removes specified value from array field
QBRequestUpdateBuilder	pullAll(java.lang.String fieldName, java.lang.Object... values) Operator removes all specified values from array field
QBRequestUpdateBuilder	pullWithFilter(java.lang.String fieldName, java.lang.String filterOperator, java.lang.Object value) Operator removes all values from array field which filtered by filter operator
QBRequestUpdateBuilder	push(java.lang.String fieldName, java.lang.Object... values) Deprecated. As of release 2.5, replaced by pushAll(String, Object...)
QBRequestUpdateBuilder	push(java.lang.String fieldName, java.lang.Object value) Appends specified value to array.
QBRequestUpdateBuilder	pushAll(java.lang.String fieldName, java.lang.Object... values) Appends specified values to array.
QBRequestUpdateBuilder	updateArrayValue(java.lang.String fieldName, int index, java.lang.Object value) Update array's element by index

Methods inherited from class com.quickblox.core.request.QBLimitedRequestBuilder

getLimit, getPagesLimit, getPagesSkip, getSkip, setLimit, setPagesLimit, setPagesSkip, setSkip

Methods inherited from class java.lang.Object

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

Constructor Detail

QBRequestUpdateBuilder

public QBRequestUpdateBuilder()

Constructs a new QBRequestUpdateBuilder object

Method Detail

addRule

public QBRequestUpdateBuilder addRule(java.lang.String fieldName,
                                      java.lang.String rule,
                                      java.lang.Object value)

Add a custom rule to the request.

Parameters:

fieldName - The field name to apply the operator for

rule - The rule

value - The rule value

Returns:

QBRequestUpdateBuilder instance

inc

public QBRequestUpdateBuilder inc(java.lang.String fieldName,
                                  java.lang.Object value)

Increment operator

Parameters:

fieldName - The field name to apply the operator for

value - The operator value

Returns:

QBRequestUpdateBuilder instance

pull

public QBRequestUpdateBuilder pull(java.lang.String fieldName,
                                   java.lang.Object value)

Operator removes specified value from array field

Parameters:

fieldName - The field name to apply the operator for

value - The operator value

Returns:

QBRequestUpdateBuilder instance

pullAll

public QBRequestUpdateBuilder pullAll(java.lang.String fieldName,
                                      java.lang.Object... values)

Operator removes all specified values from array field

Parameters:

fieldName - The field name to apply the operator for

values - The operator values

Returns:

QBRequestUpdateBuilder instance

pullWithFilter

public QBRequestUpdateBuilder pullWithFilter(java.lang.String fieldName,
                                             java.lang.String filterOperator,
                                             java.lang.Object value)

Operator removes all values from array field which filtered by filter operator

Parameters:

fieldName - The field name to apply the operator for

filterOperator - The filter operator

value - The operator value

Returns:

QBRequestUpdateBuilder instance

pop

public QBRequestUpdateBuilder pop(java.lang.String fieldName,
                                  java.lang.Object value)

Removes last element from array. The value should be equal to 1. To remove first element the value should be equal to -1.

Parameters:

fieldName - The field name to apply the operator for

value - The operator value

Returns:

QBRequestUpdateBuilder instance

push

public QBRequestUpdateBuilder push(java.lang.String fieldName,
                                   java.lang.Object value)

Appends specified value to array.

Parameters:

fieldName - The field name to apply the operator for

value - The operator value

Returns:

QBRequestUpdateBuilder instance

push

@Deprecated
public QBRequestUpdateBuilder push(java.lang.String fieldName,
                                               java.lang.Object... values)

Deprecated. As of release 2.5, replaced by pushAll(String, Object...)

pushAll

public QBRequestUpdateBuilder pushAll(java.lang.String fieldName,
                                      java.lang.Object... values)

Appends specified values to array.

Parameters:

fieldName - The field name to apply the operator for

values - The operator values

Returns:

QBRequestUpdateBuilder instance

addToSet

public QBRequestUpdateBuilder addToSet(java.lang.String fieldName,
                                       java.lang.Object value)

Adds a value to an array only if the value is not in the array already

Parameters:

fieldName - The field name to apply the operator for

value - The operator value

Returns:

QBRequestUpdateBuilder instance

updateArrayValue

public QBRequestUpdateBuilder updateArrayValue(java.lang.String fieldName,
                                               int index,
                                               java.lang.Object value)

Update array's element by index

Parameters:

fieldName - The field name to apply the operator for

index - The index af an element to update

value - The operator value

Returns:

QBRequestUpdateBuilder instance