mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-10 22:45:59 +05:45
Xiangtian Dai
925a1cc0a2
* 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.
114 lines
4.3 KiB
Objective-C
114 lines
4.3 KiB
Objective-C
/*
|
|
* 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/LICENSE-2.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>
|
|
|
|
#import "FIRAuthRPCRequest.h"
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/** @enum FIRSecureTokenRequestGrantType
|
|
@brief Represents the possible grant types for a token request.
|
|
*/
|
|
typedef NS_ENUM(NSUInteger, FIRSecureTokenRequestGrantType) {
|
|
/** @var FIRSecureTokenRequestGrantTypeAuthorizationCode
|
|
@brief Indicates an authorization code request.
|
|
@remarks Exchanges a Gitkit "ID Token" for an STS Access Token and Refresh Token.
|
|
*/
|
|
FIRSecureTokenRequestGrantTypeAuthorizationCode,
|
|
|
|
/** @var FIRSecureTokenRequestGrantTypeRefreshToken
|
|
@brief Indicates an refresh token request.
|
|
@remarks Uses an existing Refresh Token to create a new Access Token.
|
|
*/
|
|
FIRSecureTokenRequestGrantTypeRefreshToken,
|
|
};
|
|
|
|
/** @class FIRSecureTokenRequest
|
|
@brief Represents the parameters for the token endpoint.
|
|
*/
|
|
@interface FIRSecureTokenRequest : NSObject <FIRAuthRPCRequest>
|
|
|
|
/** @property grantType
|
|
@brief The type of grant requested.
|
|
@see FIRSecureTokenRequestGrantType
|
|
*/
|
|
@property(nonatomic, assign, readonly) FIRSecureTokenRequestGrantType grantType;
|
|
|
|
/** @property scope
|
|
@brief The scopes requested (a comma-delimited list of scope strings.)
|
|
*/
|
|
@property(nonatomic, copy, readonly, nullable) NSString *scope;
|
|
|
|
/** @property refreshToken
|
|
@brief The client's refresh token.
|
|
*/
|
|
@property(nonatomic, copy, readonly, nullable) NSString *refreshToken;
|
|
|
|
/** @property code
|
|
@brief The client's authorization code (legacy Gitkit "ID Token").
|
|
*/
|
|
@property(nonatomic, copy, readonly, nullable) NSString *code;
|
|
|
|
/** @property APIKey
|
|
@brief The client's API Key.
|
|
*/
|
|
@property(nonatomic, copy, readonly) NSString *APIKey;
|
|
|
|
/** @fn authCodeRequestWithCode:
|
|
@brief Creates an authorization code request with the given code (legacy Gitkit "ID Token").
|
|
@param code The authorization code (legacy Gitkit "ID Token").
|
|
@param requestConfiguration An object containing configurations to be added to the request.
|
|
@return An authorization request.
|
|
*/
|
|
+ (FIRSecureTokenRequest *)authCodeRequestWithCode:(NSString *)code
|
|
requestConfiguration:(FIRAuthRequestConfiguration *)
|
|
requestConfiguration;
|
|
|
|
/** @fn refreshRequestWithCode:
|
|
@brief Creates a refresh request with the given refresh token.
|
|
@param refreshToken The refresh token.
|
|
@param requestConfiguration An object containing configurations to be added to the request.
|
|
@return A refresh request.
|
|
*/
|
|
+ (FIRSecureTokenRequest *)refreshRequestWithRefreshToken:(NSString *)refreshToken
|
|
requestConfiguration:(FIRAuthRequestConfiguration *)
|
|
requestConfiguration;
|
|
|
|
/** @fn init
|
|
@brief Please use initWithGrantType:scope:refreshToken:code:
|
|
*/
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
|
|
/** @fn initWithGrantType:scope:refreshToken:code:APIKey:
|
|
@brief Designated initializer.
|
|
@param grantType The type of request.
|
|
@param scope The scopes requested.
|
|
@param refreshToken The client's refresh token (for refresh requests.)
|
|
@param code The client's authorization code (Gitkit ID Token) (for authorization code requests.)
|
|
@param requestConfiguration An object containing configurations to be added to the request.
|
|
*/
|
|
- (nullable instancetype)initWithGrantType:(FIRSecureTokenRequestGrantType)grantType
|
|
scope:(nullable NSString *)scope
|
|
refreshToken:(nullable NSString *)refreshToken
|
|
code:(nullable NSString *)code
|
|
requestConfiguration:(FIRAuthRequestConfiguration *)requestConfiguration
|
|
NS_DESIGNATED_INITIALIZER;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|