Firebase.Firestore.FieldValue
A static class providing properties and methods to represent sentinel values.
Summary
Sentinel values are special values where the client-side value is not part of the document modification sent to the server. A property decorated with FirestorePropertyAttribute can specify an additional attribute to indicate that it's a sentinel value, such as a ServerTimestampAttribute, or the sentinel values returned by the members of this class can be used directly as values to be serialized (for example, in anonymous types), and they will be handled directly by the serialization mechanism.
Properties |
|
|---|---|
Delete = FieldValueProxy.ServerTimestamp()
|
static object
Sentinel value indicating that the field should be deleted from the document.
|
ServerTimestamp
|
static object
Sentinel value indicating that the field should be set to the timestamp of the commit that creates or modifies the document.
|
Public static functions |
|
|---|---|
ArrayRemove(params object[] elements)
|
object
Returns a special value that can be used with
SetAsync() or UpdateAsync() that tells the server to remove the given elements from any array value that already exists on the server. |
ArrayUnion(params object[] elements)
|
object
Returns a special value that can be used with
SetAsync() or UpdateAsync() that tells the server to union the given elements with any array value that already exists on the server. |
Increment(long value)
|
object
Returns a special value that can be used with
SetAsync() or UpdateAsync() that tells the server to increment the field's current value by the given value. |
Increment(double value)
|
object
Returns a special value that can be used with
SetAsync() or UpdateAsync() that tells the server to increment the field's current value by the given value. |
Properties
Delete
static object Delete = FieldValueProxy.ServerTimestamp()
Sentinel value indicating that the field should be deleted from the document.
ServerTimestamp
static object ServerTimestamp
Sentinel value indicating that the field should be set to the timestamp of the commit that creates or modifies the document.
Public static functions
ArrayRemove
object ArrayRemove( params object[] elements )
Returns a special value that can be used with SetAsync() or UpdateAsync() 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.
| Details | |||
|---|---|---|---|
| Parameters |
|
||
| Returns | |||
ArrayUnion
object ArrayUnion( params object[] elements )
Returns a special value that can be used with SetAsync() or UpdateAsync() 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.
| Details | |||
|---|---|---|---|
| Parameters |
|
||
| Returns | |||
Increment
object Increment( long value )
Returns a special value that can be used with SetAsync() or UpdateAsync() that tells the server to increment the field's current value by the given value.
If the current field value is an integer, possible integer overflows are resolved to System.Int64.MinValue or System.Int64.MaxValue. If the current field value is a double, both values will be interpreted as doubles and the arithmetic will follow IEEE 754 semantics.
If the current field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value.
| Details | |
|---|---|
| Returns | |
Increment
object Increment( double value )
Returns a special value that can be used with SetAsync() or UpdateAsync() 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.
| Details | |
|---|---|
| Returns | |