blob: fe1c29ad2364d243162ed3ec830aabc5f06c3447 (
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
/*
* Copyright 2018 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>
@class FIRAuthRequestConfiguration;
NS_ASSUME_NONNULL_BEGIN
/** @typedef FIRFetchAuthDomainCallback
@brief The callback invoked at the end of the flow to fetch the Auth domain.
@param authDomain The Auth domain.
@param error The error that occured while fetching the auth domain, if any.
*/
typedef void (^FIRFetchAuthDomainCallback)(NSString *_Nullable authDomain,
NSError *_Nullable error);
/** @class FIRAuthURLUtils
@brief A utility class used to facilitate the creation of auth related URLs.
*/
@interface FIRAuthWebUtils : NSObject
/** @fn randomStringWithLength:
@brief Generates a random string of a specified length.
*/
+ (NSString *)randomStringWithLength:(NSUInteger)length;
/** @fn isCallbackSchemeRegisteredForCustomURLScheme:
@brief Checks whether or not the provided custom URL scheme has been registered by the app.
@param URLScheme The custom URL scheme to be checked against all custom URL schemes registered by the app.
@return whether or not the provided custom URL scheme has been registered by the app.
*/
+ (BOOL)isCallbackSchemeRegisteredForCustomURLScheme:(NSString *)URLScheme;
/** @fn isExpectedCallbackURL:eventID:authType
@brief Parses a URL into all available query items.
@param URL The actual callback URL.
@param eventID The expected event ID.
@param authType The expected auth type.
@param callbackScheme The expected callback custom scheme.
@return Whether or not the actual callback URL matches the expected callback URL.
*/
+ (BOOL)isExpectedCallbackURL:(nullable NSURL *)URL
eventID:(NSString *)eventID
authType:(NSString *)authType
callbackScheme:(NSString *)callbackScheme;
/** @fn fetchAuthDomainWithCompletion:completion:
@brief Fetches the auth domain associated with the Firebase Project.
@param completion The callback invoked after the auth domain has been constructed or an error
has been encountered.
*/
+ (void)fetchAuthDomainWithRequestConfiguration:(FIRAuthRequestConfiguration *)requestConfiguration
completion:(FIRFetchAuthDomainCallback)completion;
/** @fn queryItemValue:from:
@brief Utility function to get a value from a NSURLQueryItem array.
@param name The key.
@param queryList The NSURLQueryItem array.
@return The value for the key.
*/
+ (NSString *)queryItemValue:(NSString *)name from:(NSArray<NSURLQueryItem *> *)queryList;
@end
NS_ASSUME_NONNULL_END
|
