Files
firebase-ios-sdk/FirebaseAuth/Sources/Backend/RPC/FIRSignUpNewUserRequest.h
T

72 lines
2.5 KiB
Objective-C
Raw Normal View History

2017-05-15 12:27:07 -07:00
/*
* 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>
2020-04-10 11:54:51 -07:00
#import "FirebaseAuth/Sources/Backend/FIRAuthRPCRequest.h"
#import "FirebaseAuth/Sources/Backend/FIRIdentityToolkitRequest.h"
2017-05-15 12:27:07 -07:00
NS_ASSUME_NONNULL_BEGIN
@interface FIRSignUpNewUserRequest : FIRIdentityToolkitRequest <FIRAuthRPCRequest>
/** @property email
@brief The email of the user.
*/
@property(nonatomic, copy, nullable) NSString *email;
/** @property password
@brief The password inputed by the user.
*/
@property(nonatomic, copy, nullable) NSString *password;
/** @property displayName
@brief The password inputed by the user.
*/
@property(nonatomic, copy, nullable) NSString *displayName;
/** @property returnSecureToken
@brief Whether the response should return access token and refresh token directly.
@remarks The default value is @c YES .
*/
@property(nonatomic, assign) BOOL returnSecureToken;
2017-07-28 17:43:33 -07:00
/** @fn initWithEndpoint:requestConfiguration:
@brief Please use initWithAPIKey:email:password:displayName:requestConfiguration instead.
2017-05-15 12:27:07 -07:00
*/
- (nullable instancetype)initWithEndpoint:(NSString *)endpoint
2017-07-28 17:43:33 -07:00
requestConfiguration:(FIRAuthRequestConfiguration *)requestConfiguration
2020-03-17 10:22:29 -07:00
NS_UNAVAILABLE;
2017-07-28 17:43:33 -07:00
/** @fn initWithEndpoint:requestConfiguration:
2017-05-15 12:27:07 -07:00
@brief initializer for anonymous sign-in.
*/
2017-07-28 17:43:33 -07:00
- (nullable instancetype)initWithRequestConfiguration:
(FIRAuthRequestConfiguration *)requestConfiguration;
2017-05-15 12:27:07 -07:00
2017-07-28 17:43:33 -07:00
/** @fn initWithAPIKey:email:password:displayName:requestConfiguration
2017-05-15 12:27:07 -07:00
@brief Designated initializer.
2017-07-28 17:43:33 -07:00
@param requestConfiguration An object containing configurations to be added to the request.
2017-05-15 12:27:07 -07:00
*/
2017-07-28 17:43:33 -07:00
- (nullable instancetype)initWithEmail:(nullable NSString *)email
password:(nullable NSString *)password
displayName:(nullable NSString *)displayName
requestConfiguration:(FIRAuthRequestConfiguration *)requestConfiguration
2020-03-17 10:22:29 -07:00
NS_DESIGNATED_INITIALIZER;
2017-05-15 12:27:07 -07:00
@end
NS_ASSUME_NONNULL_END