CollectionReference

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

Subclassing Note: Cloud Firestore classes are not meant to be subclassed except for use in test mocks. Subclassing is not supported in production code and new SDK releases may break code that does so.

Public Method Summary

Task<DocumentReference>	add(Object data) Adds a new document to this collection with the specified data, assigning it a document ID automatically.
DocumentReference	document() Returns a `DocumentReference` pointing to a new document with an auto-generated ID within this collection.
DocumentReference	document(String documentPath) Gets a `DocumentReference` instance that refers to the document at the specified path within this collection.
String	getId()
DocumentReference	getParent() Gets a `DocumentReference` to the document that contains this collection.
String	getPath() Gets the path of this collection (relative to the root of the database) as a slash-separated string.

Inherited Method Summary

From class com.google.firebase.firestore.Query

ListenerRegistration	addSnapshotListener(Activity activity, EventListener<QuerySnapshot> listener) Starts listening to this query using an Activity-scoped listener.
ListenerRegistration	addSnapshotListener(MetadataChanges metadataChanges, EventListener<QuerySnapshot> listener) Starts listening to this query with the given options.
ListenerRegistration	addSnapshotListener(Executor executor, EventListener<QuerySnapshot> listener) Starts listening to this query.
ListenerRegistration	addSnapshotListener(Executor executor, MetadataChanges metadataChanges, EventListener<QuerySnapshot> listener) Starts listening to this query with the given options.
ListenerRegistration	addSnapshotListener(Activity activity, MetadataChanges metadataChanges, EventListener<QuerySnapshot> listener) Starts listening to this query with the given options, using an Activity-scoped listener.
ListenerRegistration	addSnapshotListener(EventListener<QuerySnapshot> listener) Starts listening to this query.
Query	endAt(DocumentSnapshot snapshot) Creates and returns a new `Query` that ends at the provided document (inclusive).
Query	endAt(Object... fieldValues) Creates and returns a new `Query` that ends at the provided fields relative to the order of the query.
Query	endBefore(DocumentSnapshot snapshot) Creates and returns a new `Query` that ends before the provided document (exclusive).
Query	endBefore(Object... fieldValues) Creates and returns a new `Query` that ends before the provided fields relative to the order of the query.
boolean	equals(Object o)
Task<QuerySnapshot>	get() Executes the query and returns the results as a `QuerySnapshot`.
Task<QuerySnapshot>	get(Source source) Executes the query and returns the results as a `QuerySnapshot`.
FirebaseFirestore	getFirestore() Gets the Cloud Firestore instance associated with this query.
int	hashCode()
Query	limit(long limit) Creates and returns a new `Query` that only returns the first matching documents up to the specified number.
Query	limitToLast(long limit) Creates and returns a new `Query` that only returns the last matching documents up to the specified number.
Query	orderBy(String field, Query.Direction direction) Creates and returns a new `Query` that's additionally sorted by the specified field, optionally in descending order instead of ascending.
Query	orderBy(FieldPath fieldPath) Creates and returns a new `Query` that's additionally sorted by the specified field.
Query	orderBy(FieldPath fieldPath, Query.Direction direction) Creates and returns a new `Query` that's additionally sorted by the specified field, optionally in descending order instead of ascending.
Query	orderBy(String field) Creates and returns a new `Query` that's additionally sorted by the specified field.
Query	startAfter(Object... fieldValues) Creates and returns a new `Query` that starts after the provided fields relative to the order of the query.
Query	startAfter(DocumentSnapshot snapshot) Creates and returns a new `Query` that starts after the provided document (exclusive).
Query	startAt(Object... fieldValues) Creates and returns a new `Query` that starts at the provided fields relative to the order of the query.
Query	startAt(DocumentSnapshot snapshot) Creates and returns a new `Query` that starts at the provided document (inclusive).
Query	whereArrayContains(FieldPath fieldPath, Object value) Creates and returns a new `Query` with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain the provided value.
Query	whereArrayContains(String field, Object value) Creates and returns a new `Query` with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain the provided value.
Query	whereArrayContainsAny(FieldPath fieldPath, List<? extends Object> values) Creates and returns a new `Query` with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain at least one value from the provided list.
Query	whereArrayContainsAny(String field, List<? extends Object> values) Creates and returns a new `Query` with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain at least one value from the provided list.
Query	whereEqualTo(String field, Object value) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value should be equal to the specified value.
Query	whereEqualTo(FieldPath fieldPath, Object value) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value should be equal to the specified value.
Query	whereGreaterThan(FieldPath fieldPath, Object value) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value should be greater than the specified value.
Query	whereGreaterThan(String field, Object value) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value should be greater than the specified value.
Query	whereGreaterThanOrEqualTo(String field, Object value) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value should be greater than or equal to the specified value.
Query	whereGreaterThanOrEqualTo(FieldPath fieldPath, Object value) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value should be greater than or equal to the specified value.
Query	whereIn(FieldPath fieldPath, List<? extends Object> values) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value must equal one of the values from the provided list.
Query	whereIn(String field, List<? extends Object> values) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value must equal one of the values from the provided list.
Query	whereLessThan(String field, Object value) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value should be less than the specified value.
Query	whereLessThan(FieldPath fieldPath, Object value) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value should be less than the specified value.
Query	whereLessThanOrEqualTo(FieldPath fieldPath, Object value) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value should be less than or equal to the specified value.
Query	whereLessThanOrEqualTo(String field, Object value) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value should be less than or equal to the specified value.
Query	whereNotEqualTo(FieldPath fieldPath, Object value) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value does not equal the specified value.
Query	whereNotEqualTo(String field, Object value) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value does not equal the specified value.
Query	whereNotIn(String field, List<? extends Object> values) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value does not equal any of the values from the provided list.
Query	whereNotIn(FieldPath fieldPath, List<? extends Object> values) Creates and returns a new `Query` with the additional filter that documents must contain the specified field and the value does not equal any of the values from the provided list.

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Methods

public Task<DocumentReference> add (Object data)

Adds a new document to this collection with the specified data, assigning it a document ID automatically.

Parameters

data	The data to write to the document (e.g. a Map or a POJO containing the desired document contents).

Returns

A Task that will be resolved with the DocumentReference of the newly created document.

public DocumentReference document ()

Returns a DocumentReference pointing to a new document with an auto-generated ID within this collection.

Returns

A DocumentReference pointing to a new document with an auto-generated ID.

public DocumentReference document (String documentPath)

Gets a DocumentReference instance that refers to the document at the specified path within this collection.

Parameters

documentPath	A slash-separated relative path to a document.

Returns

The DocumentReference instance.

public String getId ()

Returns

The ID of the collection.

public DocumentReference getParent ()

Gets a DocumentReference to the document that contains this collection. Only subcollections are contained in a document. For root collections, returns null.

Returns

The DocumentReference that contains this collection or null if this is a root collection.

public String getPath ()

Gets the path of this collection (relative to the root of the database) as a slash-separated string.

Returns

The path of this collection.