cloud_firestore_tvos

The tvOS (Apple TV) implementation of cloud_firestore, provided by the flutter-tvos toolchain.

Generated by flutter-tvos plugin port from cloud_firestore, then completed by hand. See PORTING_REPORT.md for the full list of what was changed.

Usage

This is a federated plugin implementation. An app that already depends on cloud_firestore and targets Apple TV only needs to add this package alongside it:

dependencies:
  cloud_firestore: ^6.6.0
  cloud_firestore_tvos: ^0.0.1

The native plugin registers automatically through flutter-tvos' plugin registrant — no extra imports or setup in app code. Use the normal cloud_firestore API; it routes to the Apple TV native side.

tvOS support

The Firebase Apple SDK exposes the full Firestore surface on tvOS, so no Firestore features are disabled here:

Capability tvOS
Reads / writes / queries / filters
Real-time snapshot listeners
Transactions & batched writes
Aggregate queries (count, sum, average)
Offline persistence
Bundles & the Pipeline API ✅ (see note)

The newest parts of the SDK surface (the Pipeline API) compile and link on tvOS but have had the least real-device verification — exercise them on actual Apple TV hardware before relying on them. See PORTING_REPORT.md.

Requirements

  • Apple TV running tvOS 15.0 or later (the Firebase Apple SDK's minimum).
  • firebase_core_tvos (pulled in automatically).

License

fluttertv, under a BSD-3-Clause license. See LICENSE for the full text.