AdamE.Firebase.iOS.CloudFirestore

.NET bindings for Cloud Firestore on Apple platforms, for use from .NET iOS and Mac Catalyst apps.

What this package provides

This package binds the Cloud Firestore Apple SDK surface exposed in the Firebase.CloudFirestore namespace. It provides access to Firestore, collections, documents, queries, listeners, field values, batch writes, transactions, aggregate queries, and Firestore settings.

Use this package when you need:

• document and collection access from C#
• Firestore queries and snapshot listeners
• document writes, updates, deletes, and batch writes
• Firestore field values such as server timestamps and array operations

Most apps using this package also reference AdamE.Firebase.iOS.Core for Firebase app initialization.

Official Firebase documentation comes first

These packages are thin .NET bindings over the official Firebase Apple SDKs.

Use the official Firebase documentation as the starting point for:

• Firebase configuration and platform setup
• feature usage and behavioral guidance
• troubleshooting and best practices

These bindings primarily:

• expose the native Firebase Apple SDK APIs to .NET through C#

• deliver the packaged native Firebase SDK artifacts through NuGet

• Firebase documentation: https://firebase.google.com/docs

• Firebase Apple platform setup: https://firebase.google.com/docs/ios/setup

• Cloud Firestore documentation: https://firebase.google.com/docs/firestore/

Supported target frameworks

This package is intended for Apple platform TFMs such as:

• net9.0-ios
• net10.0-ios
• net9.0-maccatalyst
• net10.0-maccatalyst

When multi-targeting, condition the package reference so it only restores for Apple targets.

<ItemGroup Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'ios' Or $([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'maccatalyst'">
  <PackageReference Include="AdamE.Firebase.iOS.CloudFirestore" Version="12.6.0" />
</ItemGroup>

Installation

dotnet add package AdamE.Firebase.iOS.CloudFirestore

Basic usage

This package does not itself perform Firebase app initialization; call Firebase.Core.App.Configure() from the app before using Firebase feature APIs.

using System;
using System.Collections.Generic;
using Firebase.CloudFirestore;
using Firebase.Core;

App.Configure();

var firestore = Firestore.SharedInstance;
var document = firestore.GetCollection("notes").GetDocument("welcome");

document.SetData(new Dictionary<object, object>
{
    { "title", "Hello from Firestore" },
    { "updatedAt", FieldValue.ServerTimestamp },
});

document.GetDocument((snapshot, error) =>
{
    if (error is not null)
    {
        Console.WriteLine(error.LocalizedDescription);
        return;
    }

    Console.WriteLine(snapshot?.Exists);
});

Common companion packages

• AdamE.Firebase.iOS.Core - Firebase app initialization.
• AdamE.Firebase.iOS.Auth - commonly used when Firestore security rules depend on Firebase Authentication.

Firebase app configuration

Firebase apps commonly require app-specific configuration from your own Firebase project, such as GoogleService-Info.plist.

Keep app-specific Firebase configuration in the application project or sample app, not in reusable library projects.

If the official Firebase docs for this feature require additional setup, follow those docs first.

Package versioning rules (important)

Because Firebase Apple SDKs are packaged as native xcframeworks and distributed here through NuGet, consumers should explicitly pin package versions.

Due to packaging differences between CocoaPods and NuGet, it is highly recommended that applications follow these rules:

1. Keep the MAJOR.MINOR version aligned across all Firebase packages in the app, for example 12.6.*.*.
2. Then use the latest available PATCH.REVISION for each individual package.

Example:

<ItemGroup>
  <PackageReference Include="AdamE.Firebase.iOS.Core" Version="12.6.0.3" />
  <PackageReference Include="AdamE.Firebase.iOS.Auth" Version="12.6.0.2" />
  <PackageReference Include="AdamE.Firebase.iOS.CloudFirestore" Version="12.6.0.5" />
</ItemGroup>

Avoid mixing mismatched Firebase package lines such as 12.6.x.x with 12.5.x.x, or 12.x.x.x with 11.x.x.x. Doing so can lead to native dependency conflicts, duplicate symbols, runtime failures, or other undefined behavior.

Notes on native dependency conflicts

Google and Firebase Apple SDKs share native dependencies. Avoid mixing multiple unrelated binding packages that embed overlapping Google/Firebase native SDK binaries in the same app unless you are certain they are compatible.

API surface notes

The public namespace is Firebase.CloudFirestore. API names closely mirror the native Cloud Firestore SDK surface and expose Apple-native concepts such as NSDictionary, NSError, listeners, and callback-based completion handlers.

Repository / support

• Repository: https://github.com/AdamEssenmacher/GoogleApisForiOSComponents
• Issues: https://github.com/AdamEssenmacher/GoogleApisForiOSComponents/issues

Support the project

Keeping Firebase Apple bindings current for .NET requires ongoing work across SDK updates, native dependency changes, and API surface maintenance.

If this package is valuable in your app or organization, sponsorship helps support continued maintenance and updates.

• GitHub Sponsors: https://github.com/sponsors/AdamEssenmacher