| Package | com.tuarua.firebase.firestore |
| Class | public class FieldValue |
| Inheritance | FieldValue  Object |
| Subclasses | DeleteFieldValue, NumericIncrementFieldValue, ServerTimestampFieldValue |
| Method | Defined By | ||
|---|---|---|---|
increment(by:Number):FieldValue [static]
Returns a special value that can be used with set() or update() that tells the
server to increment the field's current value by the given value. | FieldValue | ||
[static] Returns a sentinel for use with update() to mark a field for deletion. | FieldValue | ||
[static]
Returns a sentinel for use with set() or update() to include a server-generated
timestamp in the written data. | FieldValue | ||
| increment | () | method |
public static function increment(by:Number):FieldValueReturns a special value that can be used with set() or update() that tells the server to increment the field's current value by the given value.
If the current value is an integer or a double, both the current and the given value will be interpreted as doubles and all arithmetic will follow IEEE 754 semantics. Otherwise, the transformation will set the field to the given value.
Parameters
by:Number |
FieldValue — The FieldValue sentinel for use in a call to set() or update().
|
| remove | () | method |
public static function remove():FieldValueReturns a sentinel for use with update() to mark a field for deletion.
ReturnsFieldValue |
| serverTimestamp | () | method |
public static function serverTimestamp():FieldValueReturns a sentinel for use with set() or update() to include a server-generated timestamp in the written data.
ReturnsFieldValue |