Firebase.Firestore.FieldPath

An immutable path of field names, used to identify parts of a document.

Summary

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).

Inheritance

Inherits from: IEquatable< FieldPath >

Constructors and Destructors

FieldPath(params string[] segments)
Creates a path from multiple segments.

Properties

DocumentId
staticFieldPath
Sentinel field path to refer to the ID of a document.

Public functions

Equals(object obj)
override bool
Equals(FieldPath other)
bool
GetHashCode()
override int
ToString()
override string

Properties

DocumentId

staticFieldPathDocumentId

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

overrideboolEquals(objectobj)

Equals

boolEquals(FieldPathother)

FieldPath

FieldPath(paramsstring[]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 benull or empty, and it must not contain anynull or empty elements.

GetHashCode

overrideintGetHashCode()

ToString

overridestringToString()

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 2021-06-17 UTC.