FIRCollectionReference


@interface FIRCollectionReference : FIRQuery

A FIRCollectionReference object can be used for adding documents, getting document references, and querying for documents (using the methods inherited from FIRQuery).

  • ID of the referenced collection.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic) NSString *_Nonnull collectionID;
  • For subcollections, parent returns the containing FIRDocumentReference. For root collections, nil is returned.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable) FIRDocumentReference *parent;
  • A string containing the slash-separated path to this this FIRCollectionReference (relative to the root of the database).

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic) NSString *_Nonnull path;
  • Returns a FIRDocumentReference pointing to a new document with an auto-generated ID.

    Declaration

    Objective-C

    - (nonnull FIRDocumentReference *)documentWithAutoID;

    Return Value

    A FIRDocumentReference pointing to a new document with an auto-generated ID.

  • Gets a FIRDocumentReference referring to the document at the specified path, relative to this collection’s own path.

    Declaration

    Objective-C

    - (nonnull FIRDocumentReference *)documentWithPath:
        (nonnull NSString *)documentPath;

    Parameters

    documentPath

    The slash-separated relative path of the document for which to get a FIRDocumentReference.

    Return Value

    The FIRDocumentReference for the specified document path.

  • Adds a new document to this collection with the specified data, assigning it a document ID automatically.

    Declaration

    Objective-C

    - (nonnull FIRDocumentReference *)addDocumentWithData:
        (nonnull NSDictionary<NSString *, id> *)data;

    Parameters

    data

    An NSDictionary containing the data for the new document.

    Return Value

    A FIRDocumentReference pointing to the newly created document.