Einstieg

Installieren

bun add @capgo/capacitor-firebase-firestore
bunx cap sync

Importieren

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

API Übersicht

addDocument

Fügt einem Sammlung einen neuen Dokument mit den angegebenen Daten hinzu.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.addDocument({} as AddDocumentOptions);

setDocument

Schreibt in das Dokument, das durch die angegebene Referenz bezeichnet wird. Wenn das Dokument noch nicht existiert, wird es erstellt.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.setDocument({} as SetDocumentOptions);

getDocument

Liest das Dokument, das durch die angegebene Referenz bezeichnet wird.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.getDocument({} as GetDocumentOptions);

updateDocument

Aktualisiert Felder im Dokument, das durch die angegebene Referenz bezeichnet wird.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.updateDocument({} as UpdateDocumentOptions);

deleteDocument

Löscht das Dokument, das durch die angegebene Referenz bezeichnet wird.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.deleteDocument({} as DeleteDocumentOptions);

writeBatch

Ausführen Sie mehrere Schreibvorgänge als einzelnen Batch.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.writeBatch({} as WriteBatchOptions);

getCollection

Liest die von der angegebenen Referenz referenzierte Sammlung.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.getCollection({} as GetCollectionOptions);

getCollectionGroup

Liest die von der angegebenen Referenz referenzierte Sammlung.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.getCollectionGroup({} as GetCollectionGroupOptions);

getCountFromServer

Holt die Anzahl der Dokumente in einer Sammlung.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.getCountFromServer({} as GetCountFromServerOptions);

clearPersistence

Löscht die persistenten Speicher. Dies umfasst ausstehende Schreibvorgänge und gecachte Dokumente.

Muss nach dem Herunterfahren der App oder bei der ersten Initialisierung der App aufgerufen werden.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.clearPersistence();

enableNetwork

Aktiviert die Nutzung des Netzwerks.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.enableNetwork();

disableNetwork

Deaktiviert die Nutzung des Netzwerks.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.disableNetwork();

useEmulator

Instrumentiert Ihre App, um mit dem Firestore-Emulator zu kommunizieren.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.useEmulator({} as UseEmulatorOptions);

addDocumentSnapshotListener

Fügt einem Listener für Dokument-Snapshot-Ereignisse hinzu.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.addDocumentSnapshotListener({} as AddDocumentSnapshotListenerOptions, {} as AddDocumentSnapshotListenerCallback<T>);

addCollectionSnapshotListener

Fügt einem Listener für Sammlung-Snapshot-Ereignisse hinzu.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.addCollectionSnapshotListener({} as AddCollectionSnapshotListenerOptions, {} as AddCollectionSnapshotListenerCallback<T>);

addCollectionGroupSnapshotListener

Fügt einem Listener für Sammlungsgruppen-Snapshot-Ereignisse hinzu.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.addCollectionGroupSnapshotListener({} as AddCollectionGroupSnapshotListenerOptions, {} as AddCollectionGroupSnapshotListenerCallback<T>);

removeSnapshotListener

Entfernt einen Listener für Dokument- oder Sammlungs-Snapshot-Ereignisse.

import { FirebaseFirestore } from '@capgo/capacitor-firebase-firestore';

await FirebaseFirestore.removeSnapshotListener({} as RemoveSnapshotListenerOptions);

Typenreferenz

AddDocumentOptions

export interface AddDocumentOptions {
  /**
   * The reference as a string, with path components separated by a forward slash (`/`).
   *
   * @since 5.2.0
   * @example 'users'
   */
  reference: string;
  /**
   * An object containing the data for the new document.
   *
   * @since 5.2.0
   * @example { first: 'Alan', last: 'Turing', born: 1912 }
   */
  data: DocumentData;
}

AddDocumentResult

export interface AddDocumentResult {
  /**
   * The reference of the newly added document.
   *
   * @since 5.2.0
   */
  reference: DocumentReference;
}

SetDocumentOptions

export interface SetDocumentOptions {
  /**
   * The reference as a string, with path components separated by a forward slash (`/`).
   *
   * @since 5.2.0
   * @example 'users/Aorq09lkt1ynbR7xhTUx'
   */
  reference: string;
  /**
   * An object containing the data for the new document.
   *
   * @since 5.2.0
   * @example { first: 'Alan', last: 'Turing', born: 1912 }
   */
  data: DocumentData;
  /**
   * Whether to merge the provided data with an existing document.
   *
   * @since 5.2.0
   * @example true
   * @default false
   */
  merge?: boolean;
}

DocumentData

export interface DocumentData {
  /**
   * A mapping between a field and its value.
   *
   * @since 5.2.0
   */
  [field: string]: any;
}

GetDocumentOptions

export interface GetDocumentOptions {
  /**
   * The reference as a string, with path components separated by a forward slash (`/`).
   *
   * @since 5.2.0
   */
  reference: string;
}

GetDocumentResult

export interface GetDocumentResult<T> {
  /**
   * The current document contents.
   *
   * @since 5.2.0
   */
  snapshot: DocumentSnapshot<T>;
}

UpdateDocumentOptions

export interface UpdateDocumentOptions {
  /**
   * The reference as a string, with path components separated by a forward slash (`/`).
   *
   * @since 5.2.0
   */
  reference: string;
  /**
   * An object containing the data for the new document.
   *
   * @since 5.2.0
   * @example { first: 'Alan', last: 'Turing', born: 1912 }
   */
  data: DocumentData;
}

DeleteDocumentOptions

export interface DeleteDocumentOptions {
  /**
   * The reference as a string, with path components separated by a forward slash (`/`).
   *
   * @since 5.2.0
   */
  reference: string;
}

WriteBatchOptions

export interface WriteBatchOptions {
  /**
   * The operations to execute in the batch.
   *
   * @since 6.1.0
   */
  operations: WriteBatchOperation[];
}

GetCollectionOptions

export interface GetCollectionOptions {
  /**
   * The reference as a string, with path components separated by a forward slash (`/`).
   *
   * @since 5.2.0
   */
  reference: string;
  /**
   * The filter to apply.
   *
   * @since 5.2.0
   */
  compositeFilter?: QueryCompositeFilterConstraint;
  /**
   * Narrow or order the set of documents to retrieve, but do not explicitly filter for document fields.
   *
   * @since 5.2.0
   */
  queryConstraints?: QueryNonFilterConstraint[];
}

GetCollectionResult

export interface GetCollectionResult<T> {
  /**
   * The documents in the collection.
   *
   * @since 5.2.0
   */
  snapshots: DocumentSnapshot<T>[];
}

GetCollectionGroupOptions

export interface GetCollectionGroupOptions {
  /**
   * The reference as a string, with path components separated by a forward slash (`/`).
   *
   * @since 5.2.0
   */
  reference: string;
  /**
   * The filter to apply.
   *
   * @since 5.2.0
   */
  compositeFilter?: QueryCompositeFilterConstraint;
  /**
   * Narrow or order the set of documents to retrieve, but do not explicitly filter for document fields.
   *
   * @since 5.2.0
   */
  queryConstraints?: QueryNonFilterConstraint[];
}

Quellwahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.tsRe-run the sync when the public API ändert sich upstream.