Files
firebase-ios-sdk/Firebase/Auth/Source/RPCs/FIRCreateAuthURIRequest.h
T
Xiangtian Dai 925a1cc0a2 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.
2017-07-28 17:43:33 -07:00

89 lines
3.2 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"
#import "FIRIdentityToolkitRequest.h"
NS_ASSUME_NONNULL_BEGIN
/** @class FIRCreateAuthURIRequest
@brief Represents the parameters for the createAuthUri endpoint.
@see https://developers.google.com/identity/toolkit/web/reference/relyingparty/createAuthUri
*/
@interface FIRCreateAuthURIRequest : FIRIdentityToolkitRequest <FIRAuthRPCRequest>
/** @property identifier
@brief The email or federated ID of the user.
*/
@property(nonatomic, copy) NSString *identifier;
/** @property continueURI
@brief The URI to which the IDP redirects the user after the federated login flow.
*/
@property(nonatomic, copy) NSString *continueURI;
/** @property openIDRealm
@brief Optional realm for OpenID protocol. The sub string "scheme://domain:port" of the param
"continueUri" is used if this is not set.
*/
@property(nonatomic, copy, nullable) NSString *openIDRealm;
/** @property providerID
@brief The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com,
live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
*/
@property(nonatomic, copy, nullable) NSString *providerID;
/** @property clientID
@brief The relying party OAuth client ID.
*/
@property(nonatomic, copy, nullable) NSString *clientID;
/** @property context
@brief The opaque value used by the client to maintain context info between the authentication
request and the IDP callback.
*/
@property(nonatomic, copy, nullable) NSString *context;
/** @property appID
@brief The iOS client application's bundle identifier.
*/
@property(nonatomic, copy, nullable) NSString *appID;
/** @fn initWithEndpoint:requestConfiguration:requestConfiguration.
@brief Please use initWithIdentifier:continueURI:requestConfiguration: instead.
*/
- (nullable instancetype)initWithEndpoint:(NSString *)endpoint
requestConfiguration:(FIRAuthRequestConfiguration *)requestConfiguration
NS_UNAVAILABLE;
/** @fn initWithIdentifier:continueURI:requestConfiguration:
@brief Designated initializer.
@param identifier The email or federated ID of the user.
@param continueURI The URI to which the IDP redirects the user after the federated login flow.
@param requestConfiguration An object containing configurations to be added to the request.
*/
- (nullable instancetype)initWithIdentifier:(NSString *)identifier
continueURI:(NSString *)continueURI
requestConfiguration:(FIRAuthRequestConfiguration *)requestConfiguration
NS_DESIGNATED_INITIALIZER;
@end
NS_ASSUME_NONNULL_END