Stay organized with collections
Save and categorize content based on your preferences.
Firebase.Firestore.FieldPath
An immutable path of field names, used to identify parts of a document.
Summary
A FieldPath 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).
Inheritance
Inherits from: IEquatable< FieldPath >
Constructors and Destructors
|
FieldPath(params string[] segments)
Creates a path from multiple segments.
|
Properties
|
DocumentId
|
Sentinel field path to refer to the ID of a document.
|
Properties
DocumentId
static FieldPath DocumentId
Sentinel field path to refer to the ID of a document.
Used in queries to sort or filter by the document ID.
Public functions
Equals
override bool Equals(
object obj
)
FieldPath
FieldPath(
params string[] segments
)
Creates a path from multiple segments.
Each segment is treated verbatim: it may contain dots, which will lead to the segment being escaped in the path's string representation.
| Details |
| Parameters |
segments
|
The segments of the path. This must not be null or empty, and it must not contain any null or empty elements.
|
|
GetHashCode
override int GetHashCode()
ToString
override string ToString()
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2021-06-17 UTC.
[null,null,["Last updated 2021-06-17 UTC."],[],[],null,["# Firebase.Firestore.FieldPath Class Reference\n\nFirebase.Firestore.FieldPath\n============================\n\nAn immutable path of field names, used to identify parts of a document.\n\nSummary\n-------\n\nA [FieldPath](/docs/reference/unity/class/firebase/firestore/field-path#class_firebase_1_1_firestore_1_1_field_path) 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).\n\n### Inheritance\n\nInherits from: IEquatable\\\u003c FieldPath \\\u003e\n\n| ### Constructors and Destructors ||\n|---|---|\n| [FieldPath](#class_firebase_1_1_firestore_1_1_field_path_1a8e1c019e47216d1cdea6641a71a4c917)`(params string[] segments)` Creates a path from multiple segments. ||\n\n| ### Properties ||\n|-----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [DocumentId](#class_firebase_1_1_firestore_1_1_field_path_1ac055d7d976ed8eaa6a8df8f709df50e1) | `static `[FieldPath](/docs/reference/unity/class/firebase/firestore/field-path#class_firebase_1_1_firestore_1_1_field_path) Sentinel field path to refer to the ID of a document. |\n\n| ### Public functions ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|\n| [Equals](#class_firebase_1_1_firestore_1_1_field_path_1aa908f5781cce570163c7446c8d66098a)`(object obj)` | `override bool` |\n| [Equals](#class_firebase_1_1_firestore_1_1_field_path_1a804f334ffd7d95f1384f2defc0fc63af)`(`[FieldPath](/docs/reference/unity/class/firebase/firestore/field-path#class_firebase_1_1_firestore_1_1_field_path)` other)` | `bool` |\n| [GetHashCode](#class_firebase_1_1_firestore_1_1_field_path_1abb2513401647dbf4fe2b6c927edea6be)`()` | `override int` |\n| [ToString](#class_firebase_1_1_firestore_1_1_field_path_1ab7679b2bed5536e7ab094b0d88aa62aa)`()` | `override string` |\n\nProperties\n----------\n\n### DocumentId\n\n```c#\nstatic FieldPath DocumentId\n``` \nSentinel field path to refer to the ID of a document.\n\nUsed in queries to sort or filter by the document ID.\n\nPublic functions\n----------------\n\n### Equals\n\n```c#\noverride bool Equals(\n object obj\n)\n``` \n\n### Equals\n\n```c#\nbool Equals(\n FieldPath other\n)\n``` \n\n### FieldPath\n\n```c#\n FieldPath(\n params string[] segments\n)\n``` \nCreates a path from multiple segments.\n\nEach segment is treated verbatim: it may contain dots, which will lead to the segment being escaped in the path's string representation.\n\n\u003cbr /\u003e\n\n| Details ||\n|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Parameters | |------------|-------------------------------------------------------------------------------------------------------------------| | `segments` | The segments of the path. This must not be `null` or empty, and it must not contain any `null` or empty elements. | |\n\n### GetHashCode\n\n```c#\noverride int GetHashCode()\n``` \n\n### ToString\n\n```c#\noverride string ToString()\n```"]]
