aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firebase/Auth/Source/Public/FIRActionCodeSettings.h
diff options
context:
space:
mode:
authorGravatar Xiangtian Dai <xiangtian@google.com>2017-07-28 17:43:33 -0700
committerGravatar GitHub <noreply@github.com>2017-07-28 17:43:33 -0700
commit925a1cc0a27a3afb17b862a0740b56e56c3ae669 (patch)
treeda6935aa77f50ae17e0b6f60425c8bd0f1c142e6 /Firebase/Auth/Source/Public/FIRActionCodeSettings.h
parent0abd3444344ea134b0593fcaaf428e82cd190e12 (diff)
Merge from private/auth-master (#159)
* Adds passing state and continue URL in OOBCodes actions. (#82) * Adds actionCodeSettings class (#83) * Adds FIRActionCodeSettings class * Removes iOSAppStoreId to reflect update spec. * Adds “reset password in app” to sample app (#84) * Adds “reset password in app” to sample app * Addresses comments * Addresses comments * Adds @param documentation for actionCodeSettings (#85) Adds @param documentation for actionCodeSettings in FIRGetOOBConfirmationCodeRequest. * Adds request configuration class Adds a class that will comprise of all configurations needed to make a request to the Firebase Auth backend; including APIKey and Language code in the future. * Addresses comments. * Adds Setting Language Add Setting Language Feature to Firebase Auth. - Only adds support for two languages (English and Spanish) in this change. (Also supports two languages in test), more to come after this change is accepted. - For now sample app tests language setting only when using “reset password in app” option, the email sent will be in the current app language. Additional tests to come after change is accepted. * Amends code for unit tests Will add more comprehensive testing when code accepted. * Ecodes strings files in UTF-8 * Addresses comments * Addresses comments * Remove comments in .strings * Adds remaining TC languages to Firebase Auth. * Add line break to .strings files * remove language code english fallback Remove the fallback that sends “en” as the language code to the backend if no language code is specified. * addresses comment * Fixes FIRSecureToken Crash Integrates FIRSecureTokenService and FIRSecureTokenRequest with FIRAuthRequestConfiguration. * Addresses comment * Add auth language input Adds Auth language input to the Sample App in preparation for manual testing. * removes unnecessary comment * address comments * Add app language option Allow user to set the current app language code as the auth language code. This is in preparation for manual testing before release. * Addresses Comment * Adds missing continue URI Adds missing continue URL to Firebear error handling. * Remove unused line Removes unused line from FIRPhoneAuthProvider.m * Moves the new public header to the right place. * Fixes broken macOS build. * Removes trailing spaces. * Addresses review comments.
Diffstat (limited to 'Firebase/Auth/Source/Public/FIRActionCodeSettings.h')
-rw-r--r--Firebase/Auth/Source/Public/FIRActionCodeSettings.h83
1 files changed, 83 insertions, 0 deletions
diff --git a/Firebase/Auth/Source/Public/FIRActionCodeSettings.h b/Firebase/Auth/Source/Public/FIRActionCodeSettings.h
new file mode 100644
index 0000000..fef0175
--- /dev/null
+++ b/Firebase/Auth/Source/Public/FIRActionCodeSettings.h
@@ -0,0 +1,83 @@
+/*
+ * Copyright 2017 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+ #import <Foundation/Foundation.h>
+
+ NS_ASSUME_NONNULL_BEGIN
+
+ /** @class FIRActionCodeSettings
+ @brief Used to set and retrieve settings related to the handling action codes.
+ */
+ @interface FIRActionCodeSettings : NSObject
+
+ /** @property URL
+ @brief This URL represents the state/Continue URL in the form of a universal link.
+ @remarks This URL can should be contructed as a universal link that would either directly open
+ the app where the action code would be handled or continue to the app after the action code
+ handled by Firebase.
+ */
+ @property(nonatomic, copy, nullable) NSURL *URL;
+
+ /** @property handleCodeInApp
+ @brief Indicates whether or not the action code link will open the app directly or after being
+ redirected from a Firebase owned web widget.
+ */
+ @property(assign, nonatomic) BOOL handleCodeInApp;
+
+ /** @property iOSBundleID
+ @brief The iOS bundle ID, if available.
+ */
+ @property(copy, nonatomic, readonly, nullable) NSString *iOSBundleID;
+
+ /** @property androidPackageName
+ @brief The Android package name, if available.
+ */
+ @property(nonatomic, copy, readonly, nullable) NSString *androidPackageName;
+
+ /** @property androidMinimumVersion
+ @brief The minimum Android version supported, if available.
+ */
+ @property(nonatomic, copy, readonly, nullable) NSString *androidMinimumVersion;
+
+ /** @property androidInstallIfNotAvailable
+ @brief Indicates whether the Android app should be installed or not on a device where it is not
+ available.
+ */
+ @property(nonatomic, assign, readonly) BOOL androidInstallIfNotAvailable;
+
+ /** @fn setIOSBundleID
+ @brief Sets the iOS bundle Id.
+ @param iOSBundleID The iOS bundle ID.
+ */
+ - (void)setIOSBundleID:(NSString *)iOSBundleID;
+
+ /** @fn setAndroidPackageName:installIfNotAvailable:minimumVersion:
+ @brief Sets the Android package name, the flag to indicate whether or not to install the app and
+ the minimum Android version supported.
+ @param androidPackageName The Android package name.
+ @param installIfNotAvailable Indicates whether or not the app should be installed if not
+ available.
+ @param minimumVersion The minimum version of Android supported.
+ @remarks If installIfNotAvailable is set to YES and the link is opened on an android device, it
+ will try to install the app if not already available. Otherwise the web URL is used.
+ */
+ - (void)setAndroidPackageName:(NSString *)androidPackageName
+ installIfNotAvailable:(BOOL)installIfNotAvailable
+ minimumVersion:(nullable NSString *)minimumVersion;
+
+ @end
+
+ NS_ASSUME_NONNULL_END