| 1 |
efrain |
1 |
/*
|
|
|
2 |
* Copyright 2017 Google
|
|
|
3 |
*
|
|
|
4 |
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
5 |
* you may not use this file except in compliance with the License.
|
|
|
6 |
* You may obtain a copy of the License at
|
|
|
7 |
*
|
|
|
8 |
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
9 |
*
|
|
|
10 |
* Unless required by applicable law or agreed to in writing, software
|
|
|
11 |
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
12 |
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
13 |
* See the License for the specific language governing permissions and
|
|
|
14 |
* limitations under the License.
|
|
|
15 |
*/
|
|
|
16 |
|
|
|
17 |
#import <Foundation/Foundation.h>
|
|
|
18 |
|
|
|
19 |
NS_ASSUME_NONNULL_BEGIN
|
|
|
20 |
|
|
|
21 |
/**
|
|
|
22 |
* This class provides constant fields of Google APIs.
|
|
|
23 |
*/
|
|
|
24 |
NS_SWIFT_NAME(FirebaseOptions)
|
|
|
25 |
@interface FIROptions : NSObject <NSCopying>
|
|
|
26 |
|
|
|
27 |
/**
|
|
|
28 |
* Returns the default options. The first time this is called it synchronously reads
|
|
|
29 |
* GoogleService-Info.plist from disk.
|
|
|
30 |
*/
|
|
|
31 |
+ (nullable FIROptions *)defaultOptions NS_SWIFT_NAME(defaultOptions());
|
|
|
32 |
|
|
|
33 |
/**
|
|
|
34 |
* An iOS API key used for authenticating requests from your app, e.g.
|
|
|
35 |
* The key must begin with "A" and contain exactly 39 alphanumeric characters, used to identify your
|
|
|
36 |
* app to Google servers.
|
|
|
37 |
*/
|
|
|
38 |
@property(nonatomic, copy, nullable) NSString *APIKey NS_SWIFT_NAME(apiKey);
|
|
|
39 |
|
|
|
40 |
/**
|
|
|
41 |
* The bundle ID for the application. Defaults to `Bundle.mainBundle.bundleID()` when not set
|
|
|
42 |
* manually or in a plist.
|
|
|
43 |
*/
|
|
|
44 |
@property(nonatomic, copy) NSString *bundleID;
|
|
|
45 |
|
|
|
46 |
/**
|
|
|
47 |
* The OAuth2 client ID for iOS application used to authenticate Google users, for example
|
|
|
48 |
* @"12345.apps.googleusercontent.com", used for signing in with Google.
|
|
|
49 |
*/
|
|
|
50 |
@property(nonatomic, copy, nullable) NSString *clientID;
|
|
|
51 |
|
|
|
52 |
/**
|
|
|
53 |
* The tracking ID for Google Analytics, e.g. @"UA-12345678-1", used to configure Google Analytics.
|
|
|
54 |
*/
|
|
|
55 |
@property(nonatomic, copy, nullable) NSString *trackingID;
|
|
|
56 |
|
|
|
57 |
/**
|
|
|
58 |
* The Project Number from the Google Developer's console, for example @"012345678901", used to
|
|
|
59 |
* configure Google Cloud Messaging.
|
|
|
60 |
*/
|
|
|
61 |
@property(nonatomic, copy) NSString *GCMSenderID NS_SWIFT_NAME(gcmSenderID);
|
|
|
62 |
|
|
|
63 |
/**
|
|
|
64 |
* The Project ID from the Firebase console, for example @"abc-xyz-123".
|
|
|
65 |
*/
|
|
|
66 |
@property(nonatomic, copy, nullable) NSString *projectID;
|
|
|
67 |
|
|
|
68 |
/**
|
|
|
69 |
* The Android client ID used in Google AppInvite when an iOS app has its Android version, for
|
|
|
70 |
* example @"12345.apps.googleusercontent.com".
|
|
|
71 |
*/
|
|
|
72 |
@property(nonatomic, copy, nullable) NSString *androidClientID;
|
|
|
73 |
|
|
|
74 |
/**
|
|
|
75 |
* The Google App ID that is used to uniquely identify an instance of an app.
|
|
|
76 |
*/
|
|
|
77 |
@property(nonatomic, copy) NSString *googleAppID;
|
|
|
78 |
|
|
|
79 |
/**
|
|
|
80 |
* The database root URL, e.g. @"http://abc-xyz-123.firebaseio.com".
|
|
|
81 |
*/
|
|
|
82 |
@property(nonatomic, copy, nullable) NSString *databaseURL;
|
|
|
83 |
|
|
|
84 |
/**
|
|
|
85 |
* The URL scheme used to set up Durable Deep Link service.
|
|
|
86 |
*/
|
|
|
87 |
@property(nonatomic, copy, nullable) NSString *deepLinkURLScheme;
|
|
|
88 |
|
|
|
89 |
/**
|
|
|
90 |
* The Google Cloud Storage bucket name, e.g. @"abc-xyz-123.storage.firebase.com".
|
|
|
91 |
*/
|
|
|
92 |
@property(nonatomic, copy, nullable) NSString *storageBucket;
|
|
|
93 |
|
|
|
94 |
/**
|
|
|
95 |
* The App Group identifier to share data between the application and the application extensions.
|
|
|
96 |
* The App Group must be configured in the application and on the Apple Developer Portal. Default
|
|
|
97 |
* value `nil`.
|
|
|
98 |
*/
|
|
|
99 |
@property(nonatomic, copy, nullable) NSString *appGroupID;
|
|
|
100 |
|
|
|
101 |
/**
|
|
|
102 |
* Initializes a customized instance of FirebaseOptions from the file at the given plist file path.
|
|
|
103 |
* This will read the file synchronously from disk.
|
|
|
104 |
* For example:
|
|
|
105 |
* ```swift
|
|
|
106 |
* if let path = Bundle.main.path(forResource:"GoogleServices-Info", ofType:"plist") {
|
|
|
107 |
* let options = FirebaseOptions(contentsOfFile: path)
|
|
|
108 |
* }
|
|
|
109 |
* ```
|
|
|
110 |
* Note that it is not possible to customize `FirebaseOptions` for Firebase Analytics which expects
|
|
|
111 |
* a static file named `GoogleServices-Info.plist` -
|
|
|
112 |
* https://github.com/firebase/firebase-ios-sdk/issues/230.
|
|
|
113 |
* Returns `nil` if the plist file does not exist or is invalid.
|
|
|
114 |
*/
|
|
|
115 |
- (nullable instancetype)initWithContentsOfFile:(NSString *)plistPath NS_DESIGNATED_INITIALIZER;
|
|
|
116 |
|
|
|
117 |
/**
|
|
|
118 |
* Initializes a customized instance of `FirebaseOptions` with required fields. Use the mutable
|
|
|
119 |
* properties to modify fields for configuring specific services. Note that it is not possible to
|
|
|
120 |
* customize `FirebaseOptions` for Firebase Analytics which expects a static file named
|
|
|
121 |
* `GoogleServices-Info.plist` - https://github.com/firebase/firebase-ios-sdk/issues/230.
|
|
|
122 |
*/
|
|
|
123 |
- (instancetype)initWithGoogleAppID:(NSString *)googleAppID
|
|
|
124 |
GCMSenderID:(NSString *)GCMSenderID
|
|
|
125 |
NS_SWIFT_NAME(init(googleAppID:gcmSenderID:))NS_DESIGNATED_INITIALIZER;
|
|
|
126 |
|
|
|
127 |
/** Unavailable. Please use `init(contentsOfFile:)` or `init(googleAppID:gcmSenderID:)` instead. */
|
|
|
128 |
- (instancetype)init NS_UNAVAILABLE;
|
|
|
129 |
|
|
|
130 |
@end
|
|
|
131 |
|
|
|
132 |
NS_ASSUME_NONNULL_END
|