mirror of
https://bitbucket.org/vendoo/vendoo_v1.0.git
synced 2025-12-25 11:47:40 +00:00
140 lines
4.6 KiB
Objective-C
Executable File
140 lines
4.6 KiB
Objective-C
Executable File
/*
|
|
* Firebase iOS Client Library
|
|
*
|
|
* Copyright © 2013 Firebase - All Rights Reserved
|
|
* https://www.firebase.com
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binaryform must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY FIREBASE AS IS AND ANY EXPRESS OR
|
|
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
|
|
* EVENT SHALL FIREBASE BE LIABLE FOR ANY DIRECT,
|
|
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
|
|
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
|
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#import <Foundation/Foundation.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.
|
|
*/
|
|
@interface FIRMutableData : NSObject
|
|
|
|
|
|
/** @name 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;
|
|
|
|
|
|
/** @name 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
|