DocumentReference

class DocumentReference : NSObject

A FIRDocumentReference refers to a document location in a Firestore database and can be used to write, read, or listen to the location. The document at the referenced location may or may not exist. A FIRDocumentReference can also be used to create a FIRCollectionReference to a subcollection.

  • The ID of the document referred to.

    Declaration

    Swift

    var documentID: String { get }
  • A reference to the collection to which this DocumentReference belongs.

    Declaration

    Swift

    var parent: FIRCollectionReference { get }
  • The FIRFirestore for the Firestore database (useful for performing transactions, etc.).

    Declaration

    Swift

    var firestore: FIRFirestore { get }
  • A string representing the path of the referenced document (relative to the root of the database).

    Declaration

    Swift

    var path: String { get }
  • Gets a FIRCollectionReference referring to the collection at the specified path, relative to this document.

    Declaration

    Swift

    func collection(_ collectionPath: String) -> FIRCollectionReference

    Parameters

    collectionPath

    The slash-separated relative path of the collection for which to get a FIRCollectionReference.

    Return Value

    The FIRCollectionReference at the specified collectionPath.

  • Writes to the document referred to by FIRDocumentReference. If the document doesn’t yet exist, this method creates it and then sets the data. If the document exists, this method overwrites the document data with the new values.

    Declaration

    Swift

    func setData(_ documentData: [String : Any])

    Parameters

    documentData

    An NSDictionary that contains the fields and data to write to the document.

  • Writes to the document referred to by this DocumentReference. If the document does not yet exist, it will be created. If you pass merge:YES, the provided data will be merged into any existing document.

    Declaration

    Swift

    func setData(_ documentData: [String : Any], merge: Bool)

    Parameters

    documentData

    An NSDictionary that contains the fields and data to write to the document.

    merge

    Whether to merge the provided data into any existing document.

  • Writes to the document referred to by document and only replace the fields specified under mergeFields. Any field that is not specified in mergeFields is ignored and remains untouched. If the document doesn’t yet exist, this method creates it and then sets the data.

    It is an error to include a field in mergeFields that does not have a corresponding value in the data dictionary.

    Declaration

    Swift

    func setData(_ documentData: [String : Any], mergeFields: [Any])

    Parameters

    documentData

    An NSDictionary containing the fields that make up the document to be written.

    mergeFields

    An NSArray that contains a list of NSString or FIRFieldPath elements specifying which fields to merge. Fields can contain dots to reference nested fields within the document.

  • Overwrites the document referred to by this FIRDocumentReference. If no document exists, it is created. If a document already exists, it is overwritten.

    Declaration

    Swift

    func setData(_ documentData: [String : Any], completion: ((Error?) -> Void)? = nil)

    Parameters

    documentData

    An NSDictionary containing the fields that make up the document to be written.

    completion

    A block to execute once the document has been successfully written to the server. This block will not be called while the client is offline, though local changes will be visible immediately.

  • Writes to the document referred to by this DocumentReference. If the document does not yet exist, it will be created. If you pass merge:YES, the provided data will be merged into any existing document.

    Declaration

    Swift

    func setData(_ documentData: [String : Any], merge: Bool, completion: ((Error?) -> Void)? = nil)

    Parameters

    documentData

    An NSDictionary containing the fields that make up the document to be written.

    merge

    Whether to merge the provided data into any existing document.

    completion

    A block to execute once the document has been successfully written to the server. This block will not be called while the client is offline, though local changes will be visible immediately.

  • Writes to the document referred to by document and only replace the fields specified under mergeFields. Any field that is not specified in mergeFields is ignored and remains untouched. If the document doesn’t yet exist, this method creates it and then sets the data.

    It is an error to include a field in mergeFields that does not have a corresponding value in the data dictionary.

    Declaration

    Swift

    func setData(_ documentData: [String : Any], mergeFields: [Any], completion: ((Error?) -> Void)? = nil)

    Parameters

    documentData

    An NSDictionary containing the fields that make up the document to be written.

    mergeFields

    An NSArray that contains a list of NSString or FIRFieldPath elements specifying which fields to merge. Fields can contain dots to reference nested fields within the document.

    completion

    A block to execute once the document has been successfully written to the server. This block will not be called while the client is offline, though local changes will be visible immediately.

  • Updates fields in the document referred to by this FIRDocumentReference. If the document does not exist, the update fails (specify a completion block to be notified).

    Declaration

    Swift

    func updateData(_ fields: [AnyHashable : Any])

    Parameters

    fields

    An NSDictionary containing the fields (expressed as an NSString or FIRFieldPath) and values with which to update the document.

  • Updates fields in the document referred to by this FIRDocumentReference. If the document does not exist, the update fails and the specified completion block receives an error.

    Declaration

    Swift

    func updateData(_ fields: [AnyHashable : Any], completion: ((Error?) -> Void)? = nil)

    Parameters

    fields