blob: fae884fe21b3933e8a3a63e3ee9961843787898f (
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
|
/*
* 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>
@class FSTDatabaseID;
NS_ASSUME_NONNULL_BEGIN
/** FSTDatabaseInfo contains data about the database. */
@interface FSTDatabaseInfo : NSObject
/**
* Creates and returns a new FSTDatabaseInfo.
*
* @param databaseID The project/database to use.
* @param persistenceKey A unique identifier for this Firestore's local storage. Usually derived
* from -[FIRApp appName].
* @param host The hostname of the datastore backend.
* @param sslEnabled Whether to use SSL when connecting.
* @return A new instance of FSTDatabaseInfo.
*/
+ (instancetype)databaseInfoWithDatabaseID:(FSTDatabaseID *)databaseID
persistenceKey:(NSString *)persistenceKey
host:(NSString *)host
sslEnabled:(BOOL)sslEnabled;
/** The database info. */
@property(nonatomic, strong, readonly) FSTDatabaseID *databaseID;
/** The application name, taken from FIRApp. */
@property(nonatomic, copy, readonly) NSString *persistenceKey;
/** The hostname of the backend. */
@property(nonatomic, copy, readonly) NSString *host;
/** Whether to use SSL when connecting. */
@property(nonatomic, readonly, getter=isSSLEnabled) BOOL sslEnabled;
@end
NS_ASSUME_NONNULL_END
|
