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
static FieldPath
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

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
)

Equals

bool Equals(
  FieldPath other
)

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