diff options
author | Paul Beusterien <paulbeusterien@google.com> | 2017-06-29 12:03:45 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-06-29 12:03:45 -0700 |
commit | c33bdff405b988ffa4e894809db73ade0f21e658 (patch) | |
tree | 3414b99a074290f8707b6aad2df6791f21a5f0a8 /Firebase/Database/Api | |
parent | acb7a32afa4ef10915fd33005ac5e5830cf7dd6c (diff) |
Group public headers into Public directories (#112)
Diffstat (limited to 'Firebase/Database/Api')
-rw-r--r-- | Firebase/Database/Api/FIRDataEventType.h | 39 | ||||
-rw-r--r-- | Firebase/Database/Api/FIRDataSnapshot.h | 148 | ||||
-rw-r--r-- | Firebase/Database/Api/FIRDatabase.h | 148 | ||||
-rw-r--r-- | Firebase/Database/Api/FIRDatabaseQuery.h | 315 | ||||
-rw-r--r-- | Firebase/Database/Api/FIRDatabaseSwiftNameSupport.h | 29 | ||||
-rw-r--r-- | Firebase/Database/Api/FIRMutableData.h | 130 | ||||
-rw-r--r-- | Firebase/Database/Api/FIRServerValue.h | 35 | ||||
-rw-r--r-- | Firebase/Database/Api/FIRTransactionResult.h | 47 | ||||
-rw-r--r-- | Firebase/Database/Api/FirebaseDatabase.h | 29 |
9 files changed, 0 insertions, 920 deletions
diff --git a/Firebase/Database/Api/FIRDataEventType.h b/Firebase/Database/Api/FIRDataEventType.h deleted file mode 100644 index fccc98a..0000000 --- a/Firebase/Database/Api/FIRDataEventType.h +++ /dev/null @@ -1,39 +0,0 @@ -/* - * 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. - */ - -#ifndef Firebase_FIRDataEventType_h -#define Firebase_FIRDataEventType_h - -#import <Foundation/Foundation.h> -#import "FIRDatabaseSwiftNameSupport.h" - -/** - * This enum is the set of events that you can observe at a Firebase Database location. - */ -typedef NS_ENUM(NSInteger, FIRDataEventType) { - /// A new child node is added to a location. - FIRDataEventTypeChildAdded, - /// A child node is removed from a location. - FIRDataEventTypeChildRemoved, - /// A child node at a location changes. - FIRDataEventTypeChildChanged, - /// A child node moves relative to the other child nodes at a location. - FIRDataEventTypeChildMoved, - /// Any data changes at a location or, recursively, at any child node. - FIRDataEventTypeValue -} FIR_SWIFT_NAME(DataEventType); - -#endif diff --git a/Firebase/Database/Api/FIRDataSnapshot.h b/Firebase/Database/Api/FIRDataSnapshot.h deleted file mode 100644 index e615260..0000000 --- a/Firebase/Database/Api/FIRDataSnapshot.h +++ /dev/null @@ -1,148 +0,0 @@ -/* - * 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 "FIRDatabaseSwiftNameSupport.h" - -NS_ASSUME_NONNULL_BEGIN - -@class FIRDatabaseReference; - -/** - * A FIRDataSnapshot contains data from a Firebase Database location. Any time you read - * Firebase data, you receive the data as a FIRDataSnapshot. - * - * FIRDataSnapshots are passed to the blocks you attach with observeEventType:withBlock: or observeSingleEvent:withBlock:. - * They are efficiently-generated immutable copies of the data at a Firebase Database location. - * They can't be modified and will never change. To modify data at a location, - * use a FIRDatabaseReference (e.g. with setValue:). - */ -FIR_SWIFT_NAME(DataSnapshot) -@interface FIRDataSnapshot : NSObject - - -#pragma mark - Navigating and inspecting a snapshot - -/** - * Gets a FIRDataSnapshot for the location at the specified relative path. - * The relative path can either be a simple child key (e.g. 'fred') - * or a deeper slash-separated path (e.g. 'fred/name/first'). If the child - * location has no data, an empty FIRDataSnapshot is returned. - * - * @param childPathString A relative path to the location of child data. - * @return The FIRDataSnapshot for the child location. - */ -- (FIRDataSnapshot *)childSnapshotForPath:(NSString *)childPathString; - - -/** - * Return YES if the specified child exists. - * - * @param childPathString A relative path to the location of a potential child. - * @return YES if data exists at the specified childPathString, else NO. - */ -- (BOOL) hasChild:(NSString *)childPathString; - - -/** - * Return YES if the DataSnapshot has any children. - * - * @return YES if this snapshot has any children, else NO. - */ -- (BOOL) hasChildren; - - -/** - * Return YES if the DataSnapshot contains a non-null value. - * - * @return YES if this snapshot contains a non-null value, else NO. - */ -- (BOOL) exists; - - -#pragma mark - Data export - -/** - * Returns the raw value at this location, coupled with any metadata, such as priority. - * - * Priorities, where they exist, are accessible under the ".priority" key in instances of NSDictionary. - * For leaf locations with priorities, the value will be under the ".value" key. - */ -- (id __nullable) valueInExportFormat; - - -#pragma mark - Properties - -/** - * Returns the contents of this data snapshot as native types. - * - * Data types returned: - * + NSDictionary - * + NSArray - * + NSNumber (also includes booleans) - * + NSString - * - * @return The data as a native object. - */ -@property (strong, readonly, nonatomic, nullable) id value; - - -/** - * Gets the number of children for this DataSnapshot. - * - * @return An integer indicating the number of children. - */ -@property (readonly, nonatomic) NSUInteger childrenCount; - - -/** - * Gets a FIRDatabaseReference for the location that this data came from. - * - * @return A FIRDatabaseReference instance for the location of this data. - */ -@property (nonatomic, readonly, strong) FIRDatabaseReference * ref; - - -/** - * The key of the location that generated this FIRDataSnapshot. - * - * @return An NSString containing the key for the location of this FIRDataSnapshot. - */ -@property (strong, readonly, nonatomic) NSString* key; - - -/** - * An iterator for snapshots of the child nodes in this snapshot. - * You can use the native for..in syntax: - * - * for (FIRDataSnapshot* child in snapshot.children) { - * ... - * } - * - * @return An NSEnumerator of the children. - */ -@property (strong, readonly, nonatomic) NSEnumerator* children; - -/** - * The priority of the data in this FIRDataSnapshot. - * - * @return The priority as a string, or nil if no priority was set. - */ -@property (strong, readonly, nonatomic, nullable) id priority; - -@end - -NS_ASSUME_NONNULL_END diff --git a/Firebase/Database/Api/FIRDatabase.h b/Firebase/Database/Api/FIRDatabase.h deleted file mode 100644 index ebdbf8a..0000000 --- a/Firebase/Database/Api/FIRDatabase.h +++ /dev/null @@ -1,148 +0,0 @@ -/* - * 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 "FIRDatabaseReference.h" -#import "FIRDatabaseSwiftNameSupport.h" - -@class FIRApp; - -NS_ASSUME_NONNULL_BEGIN - -/** - * The entry point for accessing a Firebase Database. You can get an instance by calling - * [FIRDatabase database]. To access a location in the database and read or write data, - * use [FIRDatabase reference]. - */ -FIR_SWIFT_NAME(Database) -@interface FIRDatabase : NSObject - -/** - * The NSObject initializer that has been marked as unavailable. Use the `database` - * method instead - * - * @return An instancetype instance -*/ -+ (instancetype) init __attribute__((unavailable("use the database method instead"))); - -/** - * Gets the instance of FIRDatabase for the default FIRApp. - * - * @return A FIRDatabase instance. - */ -+ (FIRDatabase *) database FIR_SWIFT_NAME(database()); - -/** - * Gets an instance of FIRDatabase for a specific FIRApp. - * - * @param app The FIRApp to get a FIRDatabase for. - * @return A FIRDatabase instance. - */ -+ (FIRDatabase *) databaseForApp:(FIRApp*)app FIR_SWIFT_NAME(database(app:)); - -/** The FIRApp instance to which this FIRDatabase belongs. */ -@property (weak, readonly, nonatomic) FIRApp *app; - -/** - * Gets a FIRDatabaseReference for the root of your Firebase Database. - */ -- (FIRDatabaseReference *) reference; - -/** - * Gets a FIRDatabaseReference for the provided path. - * - * @param path Path to a location in your Firebase Database. - * @return A FIRDatabaseReference pointing to the specified path. - */ -- (FIRDatabaseReference *) referenceWithPath:(NSString *)path; - -/** - * Gets a FIRDatabaseReference for the provided URL. The URL must be a URL to a path - * within this Firebase Database. To create a FIRDatabaseReference to a different database, - * create a FIRApp} with a FIROptions object configured with the appropriate database URL. - * - * @param databaseUrl A URL to a path within your database. - * @return A FIRDatabaseReference for the provided URL. -*/ -- (FIRDatabaseReference *) referenceFromURL:(NSString *)databaseUrl; - -/** - * The Firebase Database client automatically queues writes and sends them to the server at the earliest opportunity, - * depending on network connectivity. In some cases (e.g. offline usage) there may be a large number of writes - * waiting to be sent. Calling this method will purge all outstanding writes so they are abandoned. - * - * All writes will be purged, including transactions and onDisconnect writes. The writes will - * be rolled back locally, perhaps triggering events for affected event listeners, and the client will not - * (re-)send them to the Firebase Database backend. - */ -- (void)purgeOutstandingWrites; - -/** - * Shuts down our connection to the Firebase Database backend until goOnline is called. - */ -- (void)goOffline; - -/** - * Resumes our connection to the Firebase Database backend after a previous goOffline call. - */ -- (void)goOnline; - -/** - * The Firebase Database client will cache synchronized data and keep track of all writes you've - * initiated while your application is running. It seamlessly handles intermittent network - * connections and re-sends write operations when the network connection is restored. - * - * However by default your write operations and cached data are only stored in-memory and will - * be lost when your app restarts. By setting this value to `YES`, the data will be persisted - * to on-device (disk) storage and will thus be available again when the app is restarted - * (even when there is no network connectivity at that time). Note that this property must be - * set before creating your first Database reference and only needs to be called once per - * application. - * - */ -@property (nonatomic) BOOL persistenceEnabled FIR_SWIFT_NAME(isPersistenceEnabled); - -/** - * By default the Firebase Database client will use up to 10MB of disk space to cache data. If the cache grows beyond - * this size, the client will start removing data that hasn't been recently used. If you find that your application - * caches too little or too much data, call this method to change the cache size. This property must be set before - * creating your first FIRDatabaseReference and only needs to be called once per application. - * - * Note that the specified cache size is only an approximation and the size on disk may temporarily exceed it - * at times. Cache sizes smaller than 1 MB or greater than 100 MB are not supported. - */ -@property (nonatomic) NSUInteger persistenceCacheSizeBytes; - -/** - * Sets the dispatch queue on which all events are raised. The default queue is the main queue. - * - * Note that this must be set before creating your first Database reference. - */ -@property (nonatomic, strong) dispatch_queue_t callbackQueue; - -/** - * Enables verbose diagnostic logging. - * - * @param enabled YES to enable logging, NO to disable. - */ -+ (void) setLoggingEnabled:(BOOL)enabled; - -/** Retrieve the Firebase Database SDK version. */ -+ (NSString *) sdkVersion; - -@end - -NS_ASSUME_NONNULL_END diff --git a/Firebase/Database/Api/FIRDatabaseQuery.h b/Firebase/Database/Api/FIRDatabaseQuery.h deleted file mode 100644 index be4ad27..0000000 --- a/Firebase/Database/Api/FIRDatabaseQuery.h +++ /dev/null @@ -1,315 +0,0 @@ -/* - * 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 "FIRDatabaseSwiftNameSupport.h" -#import "FIRDataEventType.h" -#import "FIRDataSnapshot.h" - -NS_ASSUME_NONNULL_BEGIN - -/** - * A FIRDatabaseHandle is used to identify listeners of Firebase Database events. These handles - * are returned by observeEventType: and and can later be passed to removeObserverWithHandle: to - * stop receiving updates. - */ -typedef NSUInteger FIRDatabaseHandle FIR_SWIFT_NAME(DatabaseHandle); - -/** - * A FIRDatabaseQuery instance represents a query over the data at a particular location. - * - * You create one by calling one of the query methods (queryOrderedByChild:, queryStartingAtValue:, etc.) - * on a FIRDatabaseReference. The query methods can be chained to further specify the data you are interested in - * observing - */ -FIR_SWIFT_NAME(DatabaseQuery) -@interface FIRDatabaseQuery : NSObject - - -#pragma mark - Attach observers to read data - -/** - * observeEventType:withBlock: is used to listen for data changes at a particular location. - * This is the primary way to read data from the Firebase Database. Your block will be triggered - * for the initial data and again whenever the data changes. - * - * Use removeObserverWithHandle: to stop receiving updates. - * - * @param eventType The type of event to listen for. - * @param block The block that should be called with initial data and updates. It is passed the data as a FIRDataSnapshot. - * @return A handle used to unregister this block later using removeObserverWithHandle: - */ -- (FIRDatabaseHandle)observeEventType:(FIRDataEventType)eventType withBlock:(void (^)(FIRDataSnapshot *snapshot))block; - - -/** - * observeEventType:andPreviousSiblingKeyWithBlock: is used to listen for data changes at a particular location. - * This is the primary way to read data from the Firebase Database. Your block will be triggered - * for the initial data and again whenever the data changes. In addition, for FIRDataEventTypeChildAdded, FIRDataEventTypeChildMoved, and - * FIRDataEventTypeChildChanged events, your block will be passed the key of the previous node by priority order. - * - * Use removeObserverWithHandle: to stop receiving updates. - * - * @param eventType The type of event to listen for. - * @param block The block that should be called with initial data and updates. It is passed the data as a FIRDataSnapshot - * and the previous child's key. - * @return A handle used to unregister this block later using removeObserverWithHandle: - */ -- (FIRDatabaseHandle)observeEventType:(FIRDataEventType)eventType andPreviousSiblingKeyWithBlock:(void (^)(FIRDataSnapshot *snapshot, NSString *__nullable prevKey))block; - - -/** - * observeEventType:withBlock: is used to listen for data changes at a particular location. - * This is the primary way to read data from the Firebase Database. Your block will be triggered - * for the initial data and again whenever the data changes. - * - * The cancelBlock will be called if you will no longer receive new events due to no longer having permission. - * - * Use removeObserverWithHandle: to stop receiving updates. - * - * @param eventType The type of event to listen for. - * @param block The block that should be called with initial data and updates. It is passed the data as a FIRDataSnapshot. - * @param cancelBlock The block that should be called if this client no longer has permission to receive these events - * @return A handle used to unregister this block later using removeObserverWithHandle: - */ -- (FIRDatabaseHandle)observeEventType:(FIRDataEventType)eventType withBlock:(void (^)(FIRDataSnapshot *snapshot))block withCancelBlock:(nullable void (^)(NSError* error))cancelBlock; - - -/** - * observeEventType:andPreviousSiblingKeyWithBlock: is used to listen for data changes at a particular location. - * This is the primary way to read data from the Firebase Database. Your block will be triggered - * for the initial data and again whenever the data changes. In addition, for FIRDataEventTypeChildAdded, FIRDataEventTypeChildMoved, and - * FIRDataEventTypeChildChanged events, your block will be passed the key of the previous node by priority order. - * - * The cancelBlock will be called if you will no longer receive new events due to no longer having permission. - * - * Use removeObserverWithHandle: to stop receiving updates. - * - * @param eventType The type of event to listen for. - * @param block The block that should be called with initial data and updates. It is passed the data as a FIRDataSnapshot - * and the previous child's key. - * @param cancelBlock The block that should be called if this client no longer has permission to receive these events - * @return A handle used to unregister this block later using removeObserverWithHandle: - */ -- (FIRDatabaseHandle)observeEventType:(FIRDataEventType)eventType andPreviousSiblingKeyWithBlock:(void (^)(FIRDataSnapshot *snapshot, NSString *__nullable prevKey))block withCancelBlock:(nullable void (^)(NSError* error))cancelBlock; - - -/** - * This is equivalent to observeEventType:withBlock:, except the block is immediately canceled after the initial data is returned. - * - * @param eventType The type of event to listen for. - * @param block The block that should be called. It is passed the data as a FIRDataSnapshot. - */ -- (void)observeSingleEventOfType:(FIRDataEventType)eventType withBlock:(void (^)(FIRDataSnapshot *snapshot))block; - - -/** - * This is equivalent to observeEventType:withBlock:, except the block is immediately canceled after the initial data is returned. In addition, for FIRDataEventTypeChildAdded, FIRDataEventTypeChildMoved, and - * FIRDataEventTypeChildChanged events, your block will be passed the key of the previous node by priority order. - * - * @param eventType The type of event to listen for. - * @param block The block that should be called. It is passed the data as a FIRDataSnapshot and the previous child's key. - */ -- (void)observeSingleEventOfType:(FIRDataEventType)eventType andPreviousSiblingKeyWithBlock:(void (^)(FIRDataSnapshot *snapshot, NSString *__nullable prevKey))block; - - -/** - * This is equivalent to observeEventType:withBlock:, except the block is immediately canceled after the initial data is returned. - * - * The cancelBlock will be called if you do not have permission to read data at this location. - * - * @param eventType The type of event to listen for. - * @param block The block that should be called. It is passed the data as a FIRDataSnapshot. - * @param cancelBlock The block that will be called if you don't have permission to access this data - */ -- (void)observeSingleEventOfType:(FIRDataEventType)eventType withBlock:(void (^)(FIRDataSnapshot *snapshot))block withCancelBlock:(nullable void (^)(NSError* error))cancelBlock; - - -/** - * This is equivalent to observeEventType:withBlock:, except the block is immediately canceled after the initial data is returned. In addition, for FIRDataEventTypeChildAdded, FIRDataEventTypeChildMoved, and - * FIRDataEventTypeChildChanged events, your block will be passed the key of the previous node by priority order. - * - * The cancelBlock will be called if you do not have permission to read data at this location. - * - * @param eventType The type of event to listen for. - * @param block The block that should be called. It is passed the data as a FIRDataSnapshot and the previous child's key. - * @param cancelBlock The block that will be called if you don't have permission to access this data - */ -- (void)observeSingleEventOfType:(FIRDataEventType)eventType andPreviousSiblingKeyWithBlock:(void (^)(FIRDataSnapshot *snapshot, NSString *__nullable prevKey))block withCancelBlock:(nullable void (^)(NSError* error))cancelBlock; - - -#pragma mark - Detaching observers - -/** - * Detach a block previously attached with observeEventType:withBlock:. - * - * @param handle The handle returned by the call to observeEventType:withBlock: which we are trying to remove. - */ -- (void) removeObserverWithHandle:(FIRDatabaseHandle)handle; - - -/** - * Detach all blocks previously attached to this Firebase Database location with observeEventType:withBlock: - */ -- (void) removeAllObservers; - -/** - * By calling `keepSynced:YES` on a location, the data for that location will automatically be downloaded and - * kept in sync, even when no listeners are attached for that location. Additionally, while a location is kept - * synced, it will not be evicted from the persistent disk cache. - * - * @param keepSynced Pass YES to keep this location synchronized, pass NO to stop synchronization. -*/ - - (void) keepSynced:(BOOL)keepSynced; - - -#pragma mark - Querying and limiting - -/** -* queryLimitedToFirst: is used to generate a reference to a limited view of the data at this location. -* The FIRDatabaseQuery instance returned by queryLimitedToFirst: will respond to at most the first limit child nodes. -* -* @param limit The upper bound, inclusive, for the number of child nodes to receive events for -* @return A FIRDatabaseQuery instance, limited to at most limit child nodes. -*/ -- (FIRDatabaseQuery *)queryLimitedToFirst:(NSUInteger)limit; - - -/** -* queryLimitedToLast: is used to generate a reference to a limited view of the data at this location. -* The FIRDatabaseQuery instance returned by queryLimitedToLast: will respond to at most the last limit child nodes. -* -* @param limit The upper bound, inclusive, for the number of child nodes to receive events for -* @return A FIRDatabaseQuery instance, limited to at most limit child nodes. -*/ -- (FIRDatabaseQuery *)queryLimitedToLast:(NSUInteger)limit; - -/** - * queryOrderBy: is used to generate a reference to a view of the data that's been sorted by the values of - * a particular child key. This method is intended to be used in combination with queryStartingAtValue:, - * queryEndingAtValue:, or queryEqualToValue:. - * - * @param key The child key to use in ordering data visible to the returned FIRDatabaseQuery - * @return A FIRDatabaseQuery instance, ordered by the values of the specified child key. -*/ -- (FIRDatabaseQuery *)queryOrderedByChild:(NSString *)key; - -/** - * queryOrderedByKey: is used to generate a reference to a view of the data that's been sorted by child key. - * This method is intended to be used in combination with queryStartingAtValue:, queryEndingAtValue:, - * or queryEqualToValue:. - * - * @return A FIRDatabaseQuery instance, ordered by child keys. - */ -- (FIRDatabaseQuery *) queryOrderedByKey; - -/** - * queryOrderedByValue: is used to generate a reference to a view of the data that's been sorted by child value. - * This method is intended to be used in combination with queryStartingAtValue:, queryEndingAtValue:, - * or queryEqualToValue:. - * - * @return A FIRDatabaseQuery instance, ordered by child value. - */ -- (FIRDatabaseQuery *) queryOrderedByValue; - -/** - * queryOrderedByPriority: is used to generate a reference to a view of the data that's been sorted by child - * priority. This method is intended to be used in combination with queryStartingAtValue:, queryEndingAtValue:, - * or queryEqualToValue:. - * - * @return A FIRDatabaseQuery instance, ordered by child priorities. - */ -- (FIRDatabaseQuery *) queryOrderedByPriority; - -/** - * queryStartingAtValue: is used to generate a reference to a limited view of the data at this location. - * The FIRDatabaseQuery instance returned by queryStartingAtValue: will respond to events at nodes with a value - * greater than or equal to startValue. - * - * @param startValue The lower bound, inclusive, for the value of data visible to the returned FIRDatabaseQuery - * @return A FIRDatabaseQuery instance, limited to data with value greater than or equal to startValue - */ -- (FIRDatabaseQuery *)queryStartingAtValue:(nullable id)startValue; - -/** - * queryStartingAtValue:childKey: is used to generate a reference to a limited view of the data at this location. - * The FIRDatabaseQuery instance returned by queryStartingAtValue:childKey will respond to events at nodes with a value - * greater than startValue, or equal to startValue and with a key greater than or equal to childKey. This is most - * useful when implementing pagination in a case where multiple nodes can match the startValue. - * - * @param startValue The lower bound, inclusive, for the value of data visible to the returned FIRDatabaseQuery - * @param childKey The lower bound, inclusive, for the key of nodes with value equal to startValue - * @return A FIRDatabaseQuery instance, limited to data with value greater than or equal to startValue - */ -- (FIRDatabaseQuery *)queryStartingAtValue:(nullable id)startValue childKey:(nullable NSString *)childKey; - -/** - * queryEndingAtValue: is used to generate a reference to a limited view of the data at this location. - * The FIRDatabaseQuery instance returned by queryEndingAtValue: will respond to events at nodes with a value - * less than or equal to endValue. - * - * @param endValue The upper bound, inclusive, for the value of data visible to the returned FIRDatabaseQuery - * @return A FIRDatabaseQuery instance, limited to data with value less than or equal to endValue - */ -- (FIRDatabaseQuery *)queryEndingAtValue:(nullable id)endValue; - -/** - * queryEndingAtValue:childKey: is used to generate a reference to a limited view of the data at this location. - * The FIRDatabaseQuery instance returned by queryEndingAtValue:childKey will respond to events at nodes with a value - * less than endValue, or equal to endValue and with a key less than or equal to childKey. This is most useful when - * implementing pagination in a case where multiple nodes can match the endValue. - * - * @param endValue The upper bound, inclusive, for the value of data visible to the returned FIRDatabaseQuery - * @param childKey The upper bound, inclusive, for the key of nodes with value equal to endValue - * @return A FIRDatabaseQuery instance, limited to data with value less than or equal to endValue - */ -- (FIRDatabaseQuery *)queryEndingAtValue:(nullable id)endValue childKey:(nullable NSString *)childKey; - -/** - * queryEqualToValue: is used to generate a reference to a limited view of the data at this location. - * The FIRDatabaseQuery instance returned by queryEqualToValue: will respond to events at nodes with a value equal - * to the supplied argument. - * - * @param value The value that the data returned by this FIRDatabaseQuery will have - * @return A FIRDatabaseQuery instance, limited to data with the supplied value. - */ -- (FIRDatabaseQuery *)queryEqualToValue:(nullable id)value; - -/** - * queryEqualToValue:childKey: is used to generate a reference to a limited view of the data at this location. - * The FIRDatabaseQuery instance returned by queryEqualToValue:childKey will respond to events at nodes with a value - * equal to the supplied argument and with their key equal to childKey. There will be at most one node that matches - * because child keys are unique. - * - * @param value The value that the data returned by this FIRDatabaseQuery will have - * @param childKey The name of nodes with the right value - * @return A FIRDatabaseQuery instance, limited to data with the supplied value and the key. - */ -- (FIRDatabaseQuery *)queryEqualToValue:(nullable id)value childKey:(nullable NSString *)childKey; - - -#pragma mark - Properties - -/** -* Gets a FIRDatabaseReference for the location of this query. -* -* @return A FIRDatabaseReference for the location of this query. -*/ -@property (nonatomic, readonly, strong) FIRDatabaseReference * ref; - -@end - -NS_ASSUME_NONNULL_END diff --git a/Firebase/Database/Api/FIRDatabaseSwiftNameSupport.h b/Firebase/Database/Api/FIRDatabaseSwiftNameSupport.h deleted file mode 100644 index 55e1bcc..0000000 --- a/Firebase/Database/Api/FIRDatabaseSwiftNameSupport.h +++ /dev/null @@ -1,29 +0,0 @@ -/* - * 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. - */ - -#ifndef FIR_SWIFT_NAME - -#import <Foundation/Foundation.h> - -// NS_SWIFT_NAME can only translate factory methods before the iOS 9.3 SDK. -// Wrap it in our own macro if it's a non-compatible SDK. -#ifdef __IPHONE_9_3 -#define FIR_SWIFT_NAME(X) NS_SWIFT_NAME(X) -#else -#define FIR_SWIFT_NAME(X) // Intentionally blank. -#endif // #ifdef __IPHONE_9_3 - -#endif // FIR_SWIFT_NAME diff --git a/Firebase/Database/Api/FIRMutableData.h b/Firebase/Database/Api/FIRMutableData.h deleted file mode 100644 index 5c26024..0000000 --- a/Firebase/Database/Api/FIRMutableData.h +++ /dev/null @@ -1,130 +0,0 @@ -/* - * 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 "FIRDatabaseSwiftNameSupport.h" - -NS_ASSUME_NONNULL_BEGIN - -/** - * A FIRMutableData instance is populated with data from a Firebase Database location. - * When you are using runTransactionBlock:, you will be given an instance containing the current - * data at that location. Your block will be responsible for updating that instance to the data - * you wish to save at that location, and then returning using [FIRTransactionResult successWithValue:]. - * - * To modify the data, set its value property to any of the native types support by Firebase Database: - * - * + NSNumber (includes BOOL) - * + NSDictionary - * + NSArray - * + NSString - * + nil / NSNull to remove the data - * - * Note that changes made to a child FIRMutableData instance will be visible to the parent. - */ -FIR_SWIFT_NAME(MutableData) -@interface FIRMutableData : NSObject - - -#pragma mark - Inspecting and navigating the data - - -/** - * Returns boolean indicating whether this mutable data has children. - * - * @return YES if this data contains child nodes. - */ -- (BOOL) hasChildren; - - -/** - * Indicates whether this mutable data has a child at the given path. - * - * @param path A path string, consisting either of a single segment, like 'child', or multiple segments, 'a/deeper/child' - * @return YES if this data contains a child at the specified relative path - */ -- (BOOL) hasChildAtPath:(NSString *)path; - - -/** - * Used to obtain a FIRMutableData instance that encapsulates the data at the given relative path. - * Note that changes made to the child will be visible to the parent. - * - * @param path A path string, consisting either of a single segment, like 'child', or multiple segments, 'a/deeper/child' - * @return A FIRMutableData instance containing the data at the given path - */ -- (FIRMutableData *)childDataByAppendingPath:(NSString *)path; - - -#pragma mark - Properties - - -/** - * To modify the data contained by this instance of FIRMutableData, set this to any of the native types supported by Firebase Database: - * - * + NSNumber (includes BOOL) - * + NSDictionary - * + NSArray - * + NSString - * + nil / NSNull to remove the data - * - * Note that setting this value will override the priority at this location. - * - * @return The current data at this location as a native object - */ -@property (strong, nonatomic, nullable) id value; - - -/** - * Set this property to update the priority of the data at this location. Can be set to the following types: - * - * + NSNumber - * + NSString - * + nil / NSNull to remove the priority - * - * @return The priority of the data at this location - */ -@property (strong, nonatomic, nullable) id priority; - - -/** - * @return The number of child nodes at this location - */ -@property (readonly, nonatomic) NSUInteger childrenCount; - - -/** - * Used to iterate over the children at this location. You can use the native for .. in syntax: - * - * for (FIRMutableData* child in data.children) { - * ... - * } - * - * Note that this enumerator operates on an immutable copy of the child list. So, you can modify the instance - * during iteration, but the new additions will not be visible until you get a new enumerator. - */ -@property (readonly, nonatomic, strong) NSEnumerator* children; - - -/** - * @return The key name of this node, or nil if it is the top-most location - */ -@property (readonly, nonatomic, strong, nullable) NSString* key; - - -@end - -NS_ASSUME_NONNULL_END diff --git a/Firebase/Database/Api/FIRServerValue.h b/Firebase/Database/Api/FIRServerValue.h deleted file mode 100644 index f5eadd5..0000000 --- a/Firebase/Database/Api/FIRServerValue.h +++ /dev/null @@ -1,35 +0,0 @@ -/* - * 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 "FIRDatabaseSwiftNameSupport.h" - -NS_ASSUME_NONNULL_BEGIN - -/** - * Placeholder values you may write into Firebase Database as a value or priority - * that will automatically be populated by the Firebase Database server. - */ -FIR_SWIFT_NAME(ServerValue) -@interface FIRServerValue : NSObject - -/** - * Placeholder value for the number of milliseconds since the Unix epoch - */ -+ (NSDictionary *) timestamp; - -@end - -NS_ASSUME_NONNULL_END diff --git a/Firebase/Database/Api/FIRTransactionResult.h b/Firebase/Database/Api/FIRTransactionResult.h deleted file mode 100644 index 3c2d39a..0000000 --- a/Firebase/Database/Api/FIRTransactionResult.h +++ /dev/null @@ -1,47 +0,0 @@ -/* - * 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 "FIRDatabaseSwiftNameSupport.h" -#import "FIRMutableData.h" - -NS_ASSUME_NONNULL_BEGIN - -/** - * Used for runTransactionBlock:. An FIRTransactionResult instance is a container for the results of the transaction. - */ -FIR_SWIFT_NAME(TransactionResult) -@interface FIRTransactionResult : NSObject - -/** - * Used for runTransactionBlock:. Indicates that the new value should be saved at this location - * - * @param value A FIRMutableData instance containing the new value to be set - * @return An FIRTransactionResult instance that can be used as a return value from the block given to runTransactionBlock: - */ -+ (FIRTransactionResult *)successWithValue:(FIRMutableData *)value; - - -/** - * Used for runTransactionBlock:. Indicates that the current transaction should no longer proceed. - * - * @return An FIRTransactionResult instance that can be used as a return value from the block given to runTransactionBlock: - */ -+ (FIRTransactionResult *) abort; - -@end - -NS_ASSUME_NONNULL_END diff --git a/Firebase/Database/Api/FirebaseDatabase.h b/Firebase/Database/Api/FirebaseDatabase.h deleted file mode 100644 index e52f5d6..0000000 --- a/Firebase/Database/Api/FirebaseDatabase.h +++ /dev/null @@ -1,29 +0,0 @@ -/* - * 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. - */ - -#ifndef FirebaseDatabase_h -#define FirebaseDatabase_h - -#import "FIRDatabase.h" -#import "FIRDatabaseQuery.h" -#import "FIRDatabaseReference.h" -#import "FIRDataEventType.h" -#import "FIRDataSnapshot.h" -#import "FIRMutableData.h" -#import "FIRServerValue.h" -#import "FIRTransactionResult.h" - -#endif /* FirebaseDatabase_h */ |