firebase-ios-sdk/Firestore/Source/Public/FirebaseFirestore/FIRAggregateQuerySnapshot.h

/*
 * Copyright 2022 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#import <Foundation/Foundation.h>

NS_ASSUME_NONNULL_BEGIN

@class FIRAggregateQuery;
@class FIRAggregateField;

/**
 * The results of executing an `AggregateQuery`.
 */
NS_SWIFT_SENDABLE
NS_SWIFT_NAME(AggregateQuerySnapshot)
@interface FIRAggregateQuerySnapshot : NSObject

/** :nodoc: */
- (instancetype)init
    __attribute__((unavailable("FIRAggregateQuerySnapshot cannot be created directly.")));

/** The query that was executed to produce this result. */
@property(nonatomic, readonly) FIRAggregateQuery* query;

/** The number of documents in the result set of the underlying query. */
@property(nonatomic, readonly) NSNumber* count;

/**
 * Gets the aggregate result for the specified aggregate field without loss of precision. No
 * coercion of data types or values is performed.
 *
 * See the `AggregateField` class for the expected aggregate result values and types. Numeric
 * aggregate results will be boxed in an `NSNumber`.
 *
 * @param aggregateField An instance of `AggregateField` that specifies which aggregate result to
 * return.
 * @return Returns the aggregate result from the server without loss of precision.
 * @warning Throws an `InvalidArgument` exception if the aggregate field was not requested in the
 * `AggregateQuery`.
 * @see `AggregateField`
 */
- (id)valueForAggregateField:(FIRAggregateField*)aggregateField NS_SWIFT_NAME(get(_:));

@end

NS_ASSUME_NONNULL_END