Skip to content

Commit 1c8e6e1

Browse files
committed
AggregateSource.java: re-write the javadocs
1 parent f302b09 commit 1c8e6e1

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

firebase-firestore/src/main/java/com/google/firebase/firestore/AggregateSource.java

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,23 @@
1414

1515
package com.google.firebase.firestore;
1616

17-
/** Configures the behavior of {@link AggregateQuery#get}. */
17+
/**
18+
* The sources from which an {@link AggregateQuery} can retrieve its results.
19+
*
20+
* @see AggregateQuery#get
21+
*/
1822
public enum AggregateSource {
1923
/**
20-
* Reach to the Firestore backend and surface the result verbatim, that is no local documents or
21-
* mutations in the SDK cache will be included in the surfaced result.
24+
* Perform the aggregation on the server and download the result.
2225
*
23-
* <p>Requires client to be online.
26+
* <p>The result received from the server is presented, unaltered, without considering any local
27+
* state. That is, any documents in the local cache are ignored and any documents that have been
28+
* locally modified but not yet synchronized with the server are not taken into account. The
29+
* result received from the server is not cached for later use: every request using this source
30+
* necessarily involves a round trip to the server and back.
31+
*
32+
* <p>The {@link AggregateQuery} will fail if the server cannot be reached, such as if the client
33+
* is offline.
2434
*/
2535
SERVER,
2636
}

0 commit comments

Comments
 (0)