devsite/tools/jazzy/templates

FirebaseFirestore Framework Reference

Protocols

The following protocols are available globally.

  • Represents a listener that can be removed by calling remove.

    Declaration

    Swift

    protocol ListenerRegistration : NSObjectProtocol

  • Marker protocol implemented by all supported cache settings.

    The two cache types supported are PersistentCacheSettings and MemoryCacheSettings. Custom implementation is not supported.

    Declaration

    Swift

    protocol LocalCacheSettings

  • Marker protocol implemented by all supported garbage collector settings.

    The two cache types supported are MemoryEagerGCSettings and MemoryLRUGCSettings. Custom implementation is not supported.

    Declaration

    Swift

    protocol MemoryGarbageCollectorSettings

  • 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.

    Declaration

    Swift

    public protocol DocumentIDWrappable

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

    Firestore includes extensions that make Timestamp and Date conform to ServerTimestampWrappable.

    Declaration

    Swift

    public protocol ServerTimestampWrappable