Firebase.Firestore.CollectionReference

A reference to a collection in a Firestore database.

Summary

The existence of this object does not imply that the collection currently exists in storage.

A CollectionReference can be used for adding documents, getting document references, and querying for documents (using the methods inherited from Query).

Inheritance

Inherits from: Firebase.Firestore.Query, IEquatable< CollectionReference >

Properties
`Parent`	`DocumentReference` The parent document, or null if this is a root collection.

Public attributes
`Id => Proxy.id()`	`string` The final part of the complete collection path; this is the identity of the collection relative to its parent document.
`Path => Proxy.path()`	`string` The complete collection path, including project and database ID.

Public functions
`AddAsync(object documentData)`	`Task< DocumentReference >` Asynchronously creates a document with the given data in this collection.
`Document()`	`DocumentReference` Creates a DocumentReference for a direct child document of this collection with a random ID.
`Document(string path)`	`DocumentReference` Creates a DocumentReference for a child document of this reference.
`Equals(object obj)`	`override bool`
`Equals(CollectionReference other)`	`bool`
`GetHashCode()`	`override int`
`ToString()`	`override string`

Properties

Parent

DocumentReference Parent

The parent document, or null if this is a root collection.

Public attributes

Id

string Id => Proxy.id()

The final part of the complete collection path; this is the identity of the collection relative to its parent document.

Path

string Path => Proxy.path()

The complete collection path, including project and database ID.

Public functions

AddAsync

Task< DocumentReference > AddAsync(
  object documentData
)

Asynchronously creates a document with the given data in this collection.

The document has a randomly generated ID.

Details

Parameters

documentData

The data for the document. Must not be null.

Returns

The reference for the newly-created document.

Document

DocumentReference Document()

Creates a DocumentReference for a direct child document of this collection with a random ID.

This performs no server-side operations; it only generates the appropriate DocumentReference.

Details
Returns	A DocumentReference to a child document of this collection with a random ID.

Document

DocumentReference Document(
  string path
)

Creates a DocumentReference for a child document of this reference.

Details

Parameters

path

The path to the document, relative to this collection. Must not be null, and must contain an odd number of slash-separated path elements.

Returns

A DocumentReference for the specified document.

Equals

override bool Equals(
  object obj
)

Equals

bool Equals(
  CollectionReference other
)

GetHashCode

override int GetHashCode()

ToString

override string ToString()