AggregateSource

enum AggregateSource

The sources from which an AggregateQuery can retrieve its results.

See also
get

Summary

Enum Values
SERVER

Perform the aggregation on the server and download the result.

Public functions
java-static AggregateSource!
valueOf(name: String!)

Returns the enum constant of this type with the specified name.
java-static Array<AggregateSource!>!

Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

SERVER

val AggregateSource.SERVER: AggregateSource

Perform the aggregation on the server and download the result.

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every request using this source necessarily involves a round trip to the server.

The AggregateQuery will fail if the server cannot be reached, such as if the client is offline.

Public functions

valueOf

java-static fun valueOf(name: String!): AggregateSource!

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Returns
AggregateSource!

the enum constant with the specified name
Throws
java.lang.IllegalArgumentException: java.lang.IllegalArgumentException

if this enum type has no constant with the specified name

values

java-static fun values(): Array<AggregateSource!>!

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.

Returns
Array<AggregateSource!>!

an array containing the constants of this enum type, in the order they're declared