FIRTransactionOptions.h 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  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. /**
  19. * Options to customize the behavior of `Firestore.runTransactionWithOptions()`.
  20. */
  21. NS_SWIFT_NAME(TransactionOptions)
  22. @interface FIRTransactionOptions : NSObject <NSCopying>
  23. /**
  24. * Creates and returns a new `TransactionOptions` object with all properties initialized to their
  25. * default values.
  26. *
  27. * @return The created `TransactionOptions` object.
  28. */
  29. - (instancetype)init NS_DESIGNATED_INITIALIZER;
  30. /** The maximum number of attempts to commit, after which transaction fails. Default is 5. */
  31. @property(nonatomic, assign) NSInteger maxAttempts;
  32. @end
  33. NS_ASSUME_NONNULL_END