FirebaseFirestore Framework Reference

FIRFieldPath

@interfaceFIRFieldPath:NSObject<NSCopying>

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 nestedfield in the document).

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

    Declaration

    Objective-C

    -(nonnullinstancetype)initWithFields:(nonnullNSArray<NSString*>*)fieldNames;

    Parameters

    fieldNames

    A list of field names.

    Return Value

    AFieldPath that points to a field location in a document.

  • A special sentinelFieldPath to refer to the ID of a document. It can be used in queries tosort or filter by the document ID.

    Declaration

    Objective-C

    +(nonnullinstancetype)documentID;

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 2025-03-11 UTC.