Class FindAggregateRequest<T>
Find request built in order to apply grouping/aggregation functions to entities within a DataStore<T>
Inheritance
System.Object
FindAggregateRequest<T>
Inherited Members
Namespace: Kinvey
Assembly: Kinvey.dll
Syntax
public class FindAggregateRequest<T> : ReadRequest<T, List<GroupAggregationResults>>
Type Parameters
Name | Description |
---|---|
T | The type of an entity. |
Constructors
| Improve this Doc View SourceFindAggregateRequest(AbstractClient, String, EnumReduceFunction, ICache<T>, ReadPolicy, Boolean, KinveyDelegate<List<GroupAggregationResults>>, IQueryable<Object>, String, String)
Initializes a new instance of the FindAggregateRequest<T> class.
Declaration
public FindAggregateRequest(AbstractClient client, string collection, EnumReduceFunction reduceFunction, ICache<T> cache, ReadPolicy policy, bool deltaSetFetchingEnabled, KinveyDelegate<List<GroupAggregationResults>> cacheDelegate, IQueryable<object> query, string groupField, string aggregateField)
Parameters
Type | Name | Description |
---|---|---|
AbstractClient | client | Client that the user is logged in. |
System.String | collection | Collection name. |
EnumReduceFunction | reduceFunction | Reduce function. |
ICache<T> | cache | Cache. |
ReadPolicy | policy | The ReadPolicy to be used for this request. |
System.Boolean | deltaSetFetchingEnabled | If set to |
KinveyDelegate<List<GroupAggregationResults>> | cacheDelegate | Cache delegate. |
IQueryable<System.Object> | query | Query used to filter the results that are to be aggregated. |
System.String | groupField | Property name to be used for grouping. |
System.String | aggregateField | Property name to be used for aggregation. |
Methods
| Improve this Doc View SourceCancel()
Communicates the request for cancellation.
Declaration
public override Task<bool> Cancel()
Returns
Type | Description |
---|---|
Task<System.Boolean> | The async task with the boolean result. If the result is |
Overrides
Kinvey.Request<T, List<Kinvey.GroupAggregationResults>>.Cancel()
|
Improve this Doc
View Source
ExecuteAsync()
Executes the request asynchronously.
Declaration
public override Task<List<GroupAggregationResults>> ExecuteAsync()
Returns
Type | Description |
---|---|
Task<List<GroupAggregationResults>> | The async task with the request result. |
Overrides
Kinvey.Request<T, List<Kinvey.GroupAggregationResults>>.ExecuteAsync()