FirebaseFirestore Framework Reference
Stay organized with collections Save and categorize content based on your preferences.

DocumentIDWrappable

public protocol DocumentIDWrappable

A type that can initialize itself from a Firestore DocumentReference, which makes it suitable for use with the @DocumentID property wrapper.

Firestore includes extensions that make String and DocumentReference conform to DocumentIDWrappable.

Note that Firestore ignores fields annotated with @DocumentID when writing so there is no requirement to convert from the wrapped type back to a DocumentReference.

wrap(_:)
Creates a new instance by converting from the given DocumentReference.
Declaration
Swift

static func wrap(_ documentReference: DocumentReference) throws -> Self

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-03-11 UTC.

FirebaseFirestore Framework Reference Stay organized with collections Save and categorize content based on your preferences.

DocumentIDWrappable

wrap(_:)

Declaration

FirebaseFirestore Framework Reference
Stay organized with collections Save and categorize content based on your preferences.