firestore namespace

関数

関数 説明
onDocumentCreated(ドキュメント, ハンドラ) Firestore でドキュメントが作成されるとトリガーされるイベント ハンドラ。
onDocumentCreated(opts, handler) Firestore でドキュメントが作成されるとトリガーされるイベント ハンドラ。
onDocumentDeleted(document, handler) Firestore でドキュメントが削除されたときにトリガーされるイベント ハンドラ。
onDocumentDeleted(opts, handler) Firestore でドキュメントが削除されたときにトリガーされるイベント ハンドラ。
onDocumentUpdated(document, handler) Firestore でドキュメントが更新されたときにトリガーされるイベント ハンドラ。
onDocumentUpdated(opts, handler) Firestore でドキュメントが更新されたときにトリガーされるイベント ハンドラ。
onDocumentWritten(document, handler) Firestore でドキュメントが作成、更新、削除されたときにトリガーされるイベント ハンドラ。
onDocumentWritten(opts, handler) Firestore でドキュメントが作成、更新、削除されたときにトリガーされるイベント ハンドラ。

クラス

クラス 説明
変更 Realtime Database や Cloud Firestore の onWrite イベントや onUpdate イベントなど、状態を変更するイベント用の Cloud Functions インターフェース。Change オブジェクトの作成に使用される形式の詳細については、以下をご覧ください。

インターフェース

インターフェース 説明
DocumentOptions DocumentOptions は、指定されたドキュメントとオプションのデータベースと名前空間を使用して EventHandlerOptions を拡張します。
FirestoreEvent DocumentSnapshot または変更を含む CloudEvent

型エイリアス

型エイリアス 説明
DocumentSnapshot Firestore DocumentSnapshot
QueryDocumentSnapshot Firestore QueryDocumentSnapshot

firestore.onDocumentCreated()

Firestore でドキュメントが作成されるとトリガーされるイベント ハンドラ。

署名:

export declare function onDocumentCreated<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

パラメータ

パラメータ 型 説明
ドキュメント ドキュメント トリガーする Firestore ドキュメントのパス。
handler （イベント: FirestoreEvent<QueryDocumentSnapshot | 未定義、ParamsOf<Document>>）=>任意 |<任意> を約束する Firestore が作成されるたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot |未定義、ParamsOf<Document>>>

firestore.onDocumentCreated()

Firestore でドキュメントが作成されるとトリガーされるイベント ハンドラ。

署名:

export declare function onDocumentCreated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

パラメータ

パラメータ 型 説明
最適化 DocumentOptions<ドキュメント> 個々のイベント処理関数で設定できるオプション。
handler （イベント: FirestoreEvent<QueryDocumentSnapshot | 未定義、ParamsOf<Document>>）=>任意 |<任意> を約束する Firestore が作成されるたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot |未定義、ParamsOf<Document>>>

firestore.onDocumentDeleted()

Firestore でドキュメントが削除されたときにトリガーされるイベント ハンドラ。

署名:

export declare function onDocumentDeleted<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

パラメータ

パラメータ 型 説明
ドキュメント ドキュメント トリガーする Firestore ドキュメントのパス。
handler （イベント: FirestoreEvent<QueryDocumentSnapshot | 未定義、ParamsOf<Document>>）=>任意 |<任意> を約束する Firestore の削除が行われるたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot |未定義、ParamsOf<Document>>>

firestore.onDocumentDeleted()

Firestore でドキュメントが削除されたときにトリガーされるイベント ハンドラ。

署名:

export declare function onDocumentDeleted<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

パラメータ

パラメータ 型 説明
最適化 DocumentOptions<ドキュメント> 個々のイベント処理関数で設定できるオプション。
handler （イベント: FirestoreEvent<QueryDocumentSnapshot | 未定義、ParamsOf<Document>>）=>任意 |<任意> を約束する Firestore の削除が行われるたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot |未定義、ParamsOf<Document>>>

firestore.onDocumentUpdated()

Firestore でドキュメントが更新されたときにトリガーされるイベント ハンドラ。

署名:

export declare function onDocumentUpdated<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;

パラメータ

パラメータ 型 説明
ドキュメント ドキュメント トリガーする Firestore ドキュメントのパス。
handler （イベント: FirestoreEvent<変更<QueryDocumentSnapshot> | 未定義、ParamsOf<Document>>）=>任意 |<任意> を約束する Firestore の更新が発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<FirestoreEvent<変更<QueryDocumentSnapshot>|未定義、ParamsOf<Document>>>

firestore.onDocumentUpdated()

Firestore でドキュメントが更新されたときにトリガーされるイベント ハンドラ。

署名:

export declare function onDocumentUpdated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;

パラメータ

パラメータ 型 説明
最適化 DocumentOptions<ドキュメント> 個々のイベント処理関数で設定できるオプション。
handler （イベント: FirestoreEvent<変更<QueryDocumentSnapshot> | 未定義、ParamsOf<Document>>）=>任意 |<任意> を約束する Firestore の更新が発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<FirestoreEvent<変更<QueryDocumentSnapshot>|未定義、ParamsOf<Document>>>

firestore.onDocumentWritten()

Firestore でドキュメントが作成、更新、削除されたときにトリガーされるイベント ハンドラ。

署名:

export declare function onDocumentWritten<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

パラメータ

パラメータ 型 説明
ドキュメント ドキュメント トリガーする Firestore ドキュメントのパス。
handler （イベント: FirestoreEvent<変更<DocumentSnapshot> | 未定義、ParamsOf<Document>>）=>任意 |<任意> を約束する Firestore が作成、更新、削除されるたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<FirestoreEvent<変更<DocumentSnapshot>|未定義、ParamsOf<Document>>>

firestore.onDocumentWritten()

Firestore でドキュメントが作成、更新、削除されたときにトリガーされるイベント ハンドラ。

署名:

export declare function onDocumentWritten<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

パラメータ

パラメータ 型 説明
最適化 DocumentOptions<ドキュメント> 個々のイベント処理関数で設定できるオプション。
handler （イベント: FirestoreEvent<変更<DocumentSnapshot> | 未定義、ParamsOf<Document>>）=>任意 |<任意> を約束する Firestore が作成、更新、削除されるたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<FirestoreEvent<変更<DocumentSnapshot>|未定義、ParamsOf<Document>>>

firestore.DocumentSnapshot

Firestore DocumentSnapshot

署名:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

Firestore QueryDocumentSnapshot

署名:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;