FieldPath | Doclava
public final class

FieldPath

extends Object
java.lang.Object
   ↳ com.google.firebase.firestore.FieldPath

Class Overview

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

Summary

Public Methods
static FieldPath documentId()
Returns A special sentinel FieldPath to refer to the ID of a document.
boolean equals(Object o)
int hashCode()
static FieldPath of(String... fieldNames)
Creates a FieldPath from the provided field names.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public static FieldPath documentId ()

Returns A special sentinel FieldPath to refer to the ID of a document. It can be used in queries to sort or filter by the document ID.

Returns
FieldPath

public boolean equals (Object o)

Parameters
o Object
Returns
boolean

public int hashCode ()

Returns
int

public static FieldPath of (String... fieldNames)

Creates a FieldPath from the provided field names. If more than one field name is provided, the path will point to a nested field in a document.

Parameters
fieldNames String: A list of field names.
Returns
FieldPath A FieldPath that points to a field location in a document.

public String toString ()

Returns
String