FIRAggregateQuerySnapshot.h 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. /*
  2. * Copyright 2022 Google LLC
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. #import <Foundation/Foundation.h>
  17. NS_ASSUME_NONNULL_BEGIN
  18. @class FIRAggregateQuery;
  19. /**
  20. * The results of executing an `AggregateQuery`.
  21. */
  22. NS_SWIFT_NAME(AggregateQuerySnapshot)
  23. @interface FIRAggregateQuerySnapshot : NSObject
  24. /** :nodoc: */
  25. - (instancetype)init
  26. __attribute__((unavailable("FIRAggregateQuerySnapshot cannot be created directly.")));
  27. /** The query that was executed to produce this result. */
  28. @property(nonatomic, readonly) FIRAggregateQuery* query;
  29. /** The number of documents in the result set of the underlying query. */
  30. @property(nonatomic, readonly) NSNumber* count;
  31. @end
  32. NS_ASSUME_NONNULL_END