FieldPath class
AFieldPath refers to a field in a document. The path may consist of a single field name (referring to a top-level field in the document), or a list of field names (referring to a nested field in the document).
Create aFieldPath by providing field names. If more than one field name is provided, the path will point to a nested field in a document.
Signature:
exportdeclareclassFieldPathConstructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(fieldNames) | Creates aFieldPath from the provided field names. If more than one field name is provided, the path will point to a nested field in a document. |
Methods
| Method | Modifiers | Description |
|---|---|---|
| isEqual(other) | Returns true if thisFieldPath is equal to the provided one. |
FieldPath.(constructor)
Creates aFieldPath from the provided field names. If more than one field name is provided, the path will point to a nested field in a document.
Signature:
constructor(...fieldNames:string[]);Parameters
| Parameter | Type | Description |
|---|---|---|
| fieldNames | string[] | A list of field names. |
FieldPath.isEqual()
Returns true if thisFieldPath is equal to the provided one.
Signature:
isEqual(other:FieldPath):boolean;Parameters
| Parameter | Type | Description |
|---|---|---|
| other | FieldPath | TheFieldPath to compare against. |
Returns:
boolean
true if thisFieldPath is equal to the provided one.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-01-19 UTC.