diff options
Diffstat (limited to 'Firestore/Source/Model/FSTDatabaseID.h')
-rw-r--r-- | Firestore/Source/Model/FSTDatabaseID.h | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/Firestore/Source/Model/FSTDatabaseID.h b/Firestore/Source/Model/FSTDatabaseID.h new file mode 100644 index 0000000..442e764 --- /dev/null +++ b/Firestore/Source/Model/FSTDatabaseID.h @@ -0,0 +1,48 @@ +/* + * 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> + +NS_ASSUME_NONNULL_BEGIN + +/** FSTDatabaseID represents a particular database in the datastore. */ +@interface FSTDatabaseID : NSObject + +/** + * Creates and returns a new FSTDatabaseID. + * @param projectID The project for the database. + * @param databaseID The database in the project to use. + * @return A new instance of FSTDatabaseID. + */ ++ (instancetype)databaseIDWithProject:(NSString *)projectID database:(NSString *)databaseID; + +/** The project. */ +@property(nonatomic, copy, readonly) NSString *projectID; + +/** The database. */ +@property(nonatomic, copy, readonly) NSString *databaseID; + +/** Whether this is the default database of the project. */ +- (BOOL)isDefaultDatabase; + +- (NSComparisonResult)compare:(FSTDatabaseID *)other; +- (BOOL)isEqualToDatabaseId:(FSTDatabaseID *)databaseID; + +@end + +extern NSString *const kDefaultDatabaseID; + +NS_ASSUME_NONNULL_END |