| Package | com.myflashlab.air.extensions.firebase.firestore |
| Class | public class FieldValue |
| Inheritance | FieldValue  Object |
| Method | Defined By | ||
|---|---|---|---|
ARRAY_REMOVE($value:Vector.<String>):String [static]
Returns a special value that can be used with set() or update() that tells the server to remove the given
elements from any array value that already exists on the server. | FieldValue | ||
ARRAY_UNION($value:Vector.<String>):String [static]
Returns a special value that can be used with set() or update() that tells the server to union the given
elements with any array value that already exists on the server. | FieldValue | ||
DELETE():String [static]
Returns a sentinel for use with update() to mark a field for deletion. | FieldValue | ||
INCREMENT($value:Number):String [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 | ||
TIMESTAMP():String [static]
Returns a sentinel for use with set() or update() to include a server-generated timestamp in the written data. | FieldValue | ||
| ARRAY_REMOVE | () | method |
public static function ARRAY_REMOVE($value:Vector.<String>):String
Returns a special value that can be used with set() or update() that tells the server to remove the given elements from any array value that already exists on the server. All instances of each element specified will be removed from the array. If the field being modified is not already an array it will be overwritten with an empty array.
Learn more about this feature here: https://firebase.googleblog.com/2018/08/better-arrays-in-cloud-firestore.html
Parameters
$value:Vector.<String> |
String |
| ARRAY_UNION | () | method |
public static function ARRAY_UNION($value:Vector.<String>):String
Returns a special value that can be used with set() or update() that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements.
Learn more about this feature here: https://firebase.googleblog.com/2018/08/better-arrays-in-cloud-firestore.html
Parameters
$value:Vector.<String> |
String |
| DELETE | () | method |
public static function DELETE():StringReturns a sentinel for use with update() to mark a field for deletion.
ReturnsString |
| INCREMENT | () | method |
public static function INCREMENT($value:Number):StringReturns 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.
Parameters
$value:Number |
String |
| TIMESTAMP | () | method |
public static function TIMESTAMP():StringReturns a sentinel for use with set() or update() to include a server-generated timestamp in the written data.
ReturnsString |