java.lang.Object | |
↳ | com.google.firebase.firestore.SetOptions |
An options object that configures the behavior of set() calls. By providing one of the SetOptions
objects returned by merge()
, mergeFields(String...)
and mergeFieldPaths(List
, the set()
calls in DocumentReference
, WriteBatch
and Transaction
can be configured
to perform granular merges instead of overwriting the target documents in their entirety.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Changes the behavior of set() calls to only replace the values specified in its data argument.
| |||||||||||
Changes the behavior of set() calls to only replace the fields under fieldPaths.
| |||||||||||
Changes the behavior of set() calls to only replace the fields under fieldPaths.
| |||||||||||
Changes the behavior of set() calls to only replace the fields under fieldPaths.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Parameters | |
---|---|
o |
Object |
Returns | |
---|---|
boolean |
Returns | |
---|---|
int |
Changes the behavior of set() calls to only replace the values specified in its data argument. Fields omitted from the set() call will remain untouched.
Returns | |
---|---|
SetOptions |
Changes the behavior of set() calls to only replace the fields under fieldPaths. Any field that is not specified in fieldPaths is ignored and remains untouched.
It is an error to pass a SetOptions object to a set() call that is missing a value for any of the fields specified here in its to data argument.
Parameters | |
---|---|
fields |
List : The list of fields to merge.
|
Returns | |
---|---|
SetOptions |
Changes the behavior of set() calls to only replace the fields under fieldPaths. Any field that is not specified in fieldPaths is ignored and remains untouched.
It is an error to pass a SetOptions object to a set() call that is missing a value for any of the fields specified here.
Parameters | |
---|---|
fields |
List : The list of fields to merge. Fields can contain dots to reference nested fields
within the document.
|
Returns | |
---|---|
SetOptions |
Changes the behavior of set() calls to only replace the fields under fieldPaths. Any field that is not specified in fieldPaths is ignored and remains untouched.
It is an error to pass a SetOptions object to a set() call that is missing a value for any of the fields specified here.
Parameters | |
---|---|
fields |
String : The list of fields to merge. Fields can contain dots to reference nested fields
within the document.
|
Returns | |
---|---|
SetOptions |