aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firebase/Auth/Source/Public/FIREmailAuthProvider.h
blob: 4fb5ea0cd4896caff99923c37c8c14cc3b7b80ef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/*
 * 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 "FIRAuthSwiftNameSupport.h"

@class FIRAuthCredential;

NS_ASSUME_NONNULL_BEGIN

/**
    @brief A string constant identifying the email & password identity provider.
 */
extern NSString *const FIREmailAuthProviderID FIR_SWIFT_NAME(EmailAuthProviderID);

/**
    @brief please use @c FIREmailAuthProviderID instead.
 */
extern NSString *const FIREmailPasswordAuthProviderID __attribute__((deprecated));

/** @class FIREmailAuthProvider
    @brief A concrete implementation of @c FIRAuthProvider for Email & Password Sign In.
 */
FIR_SWIFT_NAME(EmailAuthProvider)
@interface FIREmailAuthProvider : NSObject

/** @typedef FIREmailPasswordAuthProvider
    @brief Please use @c FIREmailAuthProvider instead.
 */
typedef FIREmailAuthProvider FIREmailPasswordAuthProvider __attribute__((deprecated));


/** @fn credentialWithEmail:password:
    @brief Creates an @c FIRAuthCredential for an email & password sign in.

    @param email The user's email address.
    @param password The user's password.
    @return A FIRAuthCredential containing the email & password credential.
 */
+ (FIRAuthCredential *)credentialWithEmail:(NSString *)email password:(NSString *)password;

/** @fn init
    @brief This class is not meant to be initialized.
 */
- (instancetype)init NS_UNAVAILABLE;

@end

NS_ASSUME_NONNULL_END