FIRVectorValue.h 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. /*
  2. * Copyright 2024 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. /**
  19. * Represents a vector type in Firestore documents.
  20. */
  21. NS_SWIFT_NAME(VectorValue)
  22. @interface FIRVectorValue : NSObject
  23. /** Returns a copy of the raw number array that represents the vector. */
  24. @property(atomic, readonly) NSArray<NSNumber *> *array NS_REFINED_FOR_SWIFT;
  25. /** :nodoc: */
  26. - (instancetype)init NS_UNAVAILABLE;
  27. /**
  28. * Creates a `VectorValue` constructed with a copy of the given array of NSNumbrers.
  29. * @param array An array of NSNumbers that represents a vector.
  30. */
  31. - (instancetype)initWithArray:(NSArray<NSNumber *> *)array NS_REFINED_FOR_SWIFT;
  32. @end
  33. NS_ASSUME_NONNULL_END