You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

89 lines
3.4 KiB

6 years ago
6 years ago
6 years ago
  1. /*
  2. * Copyright 2017 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/LICENSE2.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 FIRActionCodeSettings
  19. @brief Used to set and retrieve settings related to handling action codes.
  20. */
  21. NS_SWIFT_NAME(ActionCodeSettings)
  22. @interface FIRActionCodeSettings : NSObject
  23. /** @property URL
  24. @brief This URL represents the state/Continue URL in the form of a universal link.
  25. @remarks This URL can should be contructed as a universal link that would either directly open
  26. the app where the action code would be handled or continue to the app after the action code
  27. is handled by Firebase.
  28. */
  29. @property(nonatomic, copy, nullable) NSURL *URL;
  30. /** @property handleCodeInApp
  31. @brief Indicates whether the action code link will open the app directly or after being
  32. redirected from a Firebase owned web widget.
  33. */
  34. @property(assign, nonatomic) BOOL handleCodeInApp;
  35. /** @property iOSBundleID
  36. @brief The iOS bundle ID, if available. The default value is the current app's bundle ID.
  37. */
  38. @property(copy, nonatomic, readonly, nullable) NSString *iOSBundleID;
  39. /** @property androidPackageName
  40. @brief The Android package name, if available.
  41. */
  42. @property(nonatomic, copy, readonly, nullable) NSString *androidPackageName;
  43. /** @property androidMinimumVersion
  44. @brief The minimum Android version supported, if available.
  45. */
  46. @property(nonatomic, copy, readonly, nullable) NSString *androidMinimumVersion;
  47. /** @property androidInstallIfNotAvailable
  48. @brief Indicates whether the Android app should be installed on a device where it is not
  49. available.
  50. */
  51. @property(nonatomic, assign, readonly) BOOL androidInstallIfNotAvailable;
  52. /** @property dynamicLinkDomain
  53. @brief The Firebase Dynamic Link domain used for out of band code flow.
  54. */
  55. @property(copy, nonatomic, nullable) NSString *dynamicLinkDomain;
  56. /** @fn setIOSBundleID
  57. @brief Sets the iOS bundle Id.
  58. @param iOSBundleID The iOS bundle ID.
  59. */
  60. - (void)setIOSBundleID:(NSString *)iOSBundleID;
  61. /** @fn setAndroidPackageName:installIfNotAvailable:minimumVersion:
  62. @brief Sets the Android package name, the flag to indicate whether or not to install the app
  63. and the minimum Android version supported.
  64. @param androidPackageName The Android package name.
  65. @param installIfNotAvailable Indicates whether or not the app should be installed if not
  66. available.
  67. @param minimumVersion The minimum version of Android supported.
  68. @remarks If installIfNotAvailable is set to YES and the link is opened on an android device, it
  69. will try to install the app if not already available. Otherwise the web URL is used.
  70. */
  71. - (void)setAndroidPackageName:(NSString *)androidPackageName
  72. installIfNotAvailable:(BOOL)installIfNotAvailable
  73. minimumVersion:(nullable NSString *)minimumVersion;
  74. @end
  75. NS_ASSUME_NONNULL_END