FieldPath

class FieldPath

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 functions
`java-static FieldPath`	`documentId()` Returns A special sentinel `FieldPath` to refer to the ID of a document.
`Boolean`	`equals(o: Any!)`
`Int`	`hashCode()`
`java-static FieldPath`	`of(fieldNames: Array<String!>!)` Creates a `FieldPath` from the provided field names.
`String!`	`toString()`

Public functions

documentId

java-static fun documentId(): FieldPath

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.

equals

fun equals(o: Any!): Boolean

hashCode

fun hashCode(): Int

of

java-static fun of(fieldNames: Array<String!>!): FieldPath

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: Array<String!>!`	A list of field names.

Returns
`FieldPath`	A `FieldPath` that points to a field location in a document.

toString

fun toString(): String!