FIRServerValue_unreleased.h 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. /*
  2. * Copyright 2019 Google
  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. #ifndef FIRServerValue_unreleased_h
  17. #define FIRServerValue_unreleased_h
  18. #import "FIRServerValue.h"
  19. @interface FIRServerValue (Unreleased)
  20. /**
  21. * Adds the given delta to the current value at a location.
  22. *
  23. * The delta must be an long or a double value. If the current value is not an
  24. * integer or double, or if the data does not yet exist, the transformation will
  25. * set the data to the delta value. If either of the delta value or the existing
  26. * data are doubles, both values will be interpreted as doubles. Double
  27. * arithmetic and representation of double values follow IEEE 754 semantics. If
  28. * there is positive/negative integer overflow, the sum is calculated as a a
  29. * double.
  30. *
  31. * @param delta the amount to modify the current value atomically.
  32. * @return a placeholder value for modifying data atomically server-side.
  33. */
  34. + (NSDictionary *)increment:(NSNumber *)delta NS_SWIFT_NAME(increment(_:));
  35. @end
  36. #endif /* FIRServerValue_unreleased_h */