aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firebase/Auth/Source/FIRAuthDataResult.h
blob: e72adf2d95a508ff7113c4783c772122337ccf51 (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
/*
 * 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 FIRAdditionalUserInfo;
@class FIRUser;

NS_ASSUME_NONNULL_BEGIN

/** @class FIRAuthDataResult
    @brief Helper object that contains the result of a successful sign-in, link and reauthenticate.
        It contains a reference to a @c FIRUser and @c FIRAdditionalUserInfo.
 */
FIR_SWIFT_NAME(AuthDataResult)
@interface FIRAuthDataResult : NSObject

/** @fn init
    @brief This class should not be initialized manually. @c FIRAuthDataResult instance is
        returned as part of @c FIRAuthDataResultCallback .
 */
- (instancetype)init NS_UNAVAILABLE;

/** @property user
    @brief The signed in user.
 */
@property(nonatomic, readonly) FIRUser *user;

/** @property additionalUserInfo
    @brief If available contains the additional IdP specific information about signed in user.
 */
@property(nonatomic, readonly, nullable) FIRAdditionalUserInfo *additionalUserInfo;

@end

NS_ASSUME_NONNULL_END