motion-firebase 1.0.5

data/lib/vendor/Firebase.framework/Versions/Current/Headers/FDataSnapshot.h

@@ -0,0 +1,146 @@
+/*
+ * 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>
+
+@class Firebase;
+
+/**
+ * An FDataSnapshot contains data from a Firebase location. Any time you read
+ * Firebase data, you receive the data as an FDataSnapshot.
+ *
+ * FDataSnapshots 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 location.
+ * They can't be modified and will never change. To modify data at a location,
+ * use a Firebase reference (e.g. with setValue:).
+ */
+@interface FDataSnapshot : NSObject
+
+
+/** @name Navigating and inspecting a snapshot */
+
+/**
+ * Get an FDataSnapshot for the location at the specified relative path.
+ * The relative path can either be a simple child name (e.g. 'fred')
+ * or a deeper slash-separated path (e.g. 'fred/name/first'). If the child
+ * location has no data, an empty FDataSnapshot is returned.
+ *
+ * @param childPathString A relative path to the location of child data.
+ * @return The FDataSnapshot for the child location.
+ */
+- (FDataSnapshot *) 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 false.
+ */
+- (BOOL) hasChild:(NSString *)childPathString;
+
+
+/**
+ * Return YES if the DataSnapshot has any children.
+ *
+ * @return YES if this snapshot has any children, else NO.
+ */
+- (BOOL) hasChildren;
+
+
+/** @name 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) valueInExportFormat;
+
+
+/** @name 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) id value;
+
+
+/**
+ * Get the number of children for this DataSnapshot.
+ *
+ * @return An integer indicating the number of children.
+ */
+@property (readonly, nonatomic) NSUInteger childrenCount;
+
+
+/**
+ * Get a Firebase reference for the location that this data came from
+ *
+ * @return A Firebase instance for the location of this data
+ */
+@property (nonatomic, readonly, strong) Firebase* ref;
+
+
+/**
+ * The name of the location that generated this FDataSnapshot.
+ *
+ * @return An NSString containing the name for the location of this FDataSnapshot.
+ */
+@property (strong, readonly, nonatomic) NSString* name;
+
+
+/**
+ * An iterator for snapshots of the child nodes in this snapshot.
+ * You can use the native for..in syntax:
+ *
+ * for (FDataSnapshot* child in snapshot.children) {
+ *     ...
+ * }
+ *
+ * @return An NSEnumerator of the children
+ */
+@property (strong, readonly, nonatomic) NSEnumerator* children;
+
+/**
+ * The priority of the data in this FDataSnapshot.
+ *
+ * @return The priority as a string, or nil if no priority was set.
+ */
+@property (strong, readonly, nonatomic) id priority;
+
+@end

data/lib/vendor/Firebase.framework/Versions/Current/Headers/FEventType.h

@@ -0,0 +1,43 @@
+/*
+ * 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.
+ */
+
+#ifndef Firebase_FEventType_h
+#define Firebase_FEventType_h
+
+/**
+ * This enum is the set of events that you can observe at a Firebase location.
+ */
+typedef enum {
+    FEventTypeChildAdded,    // 0, fired when a new child node is added to a location
+    FEventTypeChildRemoved,  // 1, fired when a child node is removed from a location
+    FEventTypeChildChanged,  // 2, fired when a child node at a location changes
+    FEventTypeChildMoved,    // 3, fired when a child node moves relative to the other child nodes at a location
+    FEventTypeValue          // 4, fired when any data changes at a location
+} FEventType;
+
+#endif

data/lib/vendor/Firebase.framework/Versions/Current/Headers/FMutableData.h

@@ -0,0 +1,134 @@
+/*
+ * 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>
+
+/**
+ * An FMutableData instance is populated with data from a Firebase 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 [FTransactionResult successWithData:yourData].
+ *
+ * To modify the data, set its value property to any of the native types support by Firebase:
+ * * NSNumber (includes BOOL)
+ * * NSDictionary
+ * * NSArray
+ * * NSString
+ * * nil / [NSNull null] to remove the data
+ *
+ * Note that changes made to a child FMutableData instance will be visible to the parent.
+ */
+@interface FMutableData : NSObject
+
+
+/** @name Inspecting and navigating the data */
+
+
+/**
+ * @return YES if this data contains child nodes.
+ */
+- (BOOL) hasChildren;
+
+
+/**
+ * @return YES if this data contains a child at the specified relative path
+ */
+- (BOOL) hasChildAtPath:(NSString *)path;
+
+
+/**
+ * Used to obtain an FMutableData 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 An FMutableData instance containing the data at the given path
+ */
+- (FMutableData *) childDataByAppendingPath:(NSString *)path;
+
+
+/** @name Properties */
+
+
+/**
+ * @return An FMutableData instance containing the data at the parent location, or nil if this is the top-most location
+ */
+@property (strong, readonly, nonatomic) FMutableData* parent;
+
+
+/**
+ * To modify the data contained by this instance of FMutableData, set this to any of the native types support by Firebase:
+ * * NSNumber (includes BOOL)
+ * * NSDictionary
+ * * NSArray
+ * * NSString
+ * * nil / [NSNull null] to remove the data
+ *
+ * Note that setting the value will override the priority at this location.
+ *
+ * @return The current data at this location as a native object
+ */
+@property (strong, nonatomic) 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 null] to remove the priority
+ *
+ * @return The priority of the data at this location
+ */
+@property (strong, nonatomic) 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 (FMutableData* 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 name of this node, or nil if it is the top-most location
+ */
+@property (readonly, nonatomic, strong) NSString* name;
+
+
+@end

data/lib/vendor/Firebase.framework/Versions/Current/Headers/FQuery.h

@@ -0,0 +1,229 @@
+/*
+ * 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>
+#import "FEventType.h"
+#import "FDataSnapshot.h"
+
+typedef NSUInteger FirebaseHandle;
+
+/**
+ * An FQuery instance represents a query over the data at a particular location.
+ * 
+ * You create one by calling one of the query methods (queryStartingAtPriority:, queryEndingAtPriority:, etc.) 
+ * on a Firebase reference. The query methods can be chained to further specify the data you are interested in 
+ * observing
+ */
+@interface FQuery : NSObject
+
+
+/** @name Attaching 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 Firebase. 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.
+ * @return A handle used to unregister this block later using removeObserverWithHandle:
+ */
+- (FirebaseHandle) observeEventType:(FEventType)eventType withBlock:(void (^)(FDataSnapshot* snapshot))block;
+
+
+/**
+ * observeEventType:andPreviousSiblingWithBlock: is used to listen for data changes at a particular location.
+ * This is the primary way to read data from Firebase. Your block will be triggered
+ * for the initial data and again whenever the data changes. In addition, for FEventTypeChildAdded, FEventTypeChildMoved, and
+ * FEventTypeChildChanged events, your block will be passed the name 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, as well as the previous child's name.
+ * @return A handle used to unregister this block later using removeObserverWithHandle:
+ */
+- (FirebaseHandle) observeEventType:(FEventType)eventType andPreviousSiblingNameWithBlock:(void (^)(FDataSnapshot* snapshot, NSString* prevName))block;
+
+
+/**
+ * observeEventType:withBlock: is used to listen for data changes at a particular location.
+ * This is the primary way to read data from Firebase. 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.
+ * @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:
+ */
+- (FirebaseHandle) observeEventType:(FEventType)eventType withBlock:(void (^)(FDataSnapshot* snapshot))block withCancelBlock:(void (^)(void))cancelBlock;
+
+
+/**
+ * observeEventType:andPreviousSiblingWithBlock: is used to listen for data changes at a particular location.
+ * This is the primary way to read data from Firebase. Your block will be triggered
+ * for the initial data and again whenever the data changes. In addition, for FEventTypeChildAdded, FEventTypeChildMoved, and
+ * FEventTypeChildChanged events, your block will be passed the name 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, as well as the previous child's name.
+ * @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:
+ */
+- (FirebaseHandle) observeEventType:(FEventType)eventType andPreviousSiblingNameWithBlock:(void (^)(FDataSnapshot* snapshot, NSString* prevName))block withCancelBlock:(void (^)(void))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 with initial data and updates.
+ */
+- (void) observeSingleEventOfType:(FEventType)eventType withBlock:(void (^)(FDataSnapshot* snapshot))block;
+
+
+/**
+ * This is equivalent to observeEventType:withBlock:, except the block is immediately canceled after the initial data is returned. In addition, for FEventTypeChildAdded, FEventTypeChildMoved, and
+ * FEventTypeChildChanged events, your block will be passed the name of the previous node by priority order.
+ *
+ * @param eventType The type of event to listen for.
+ * @param block The block that should be called with initial data and updates.
+ */
+- (void) observeSingleEventOfType:(FEventType)eventType andPreviousSiblingNameWithBlock:(void (^)(FDataSnapshot* snapshot, NSString* prevName))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 with initial data and updates.
+ * @param cancelBlock The block that will be called if you don't have permission to access this data
+ */
+- (void) observeSingleEventOfType:(FEventType)eventType withBlock:(void (^)(FDataSnapshot* snapshot))block withCancelBlock:(void (^)(void))cancelBlock;
+
+
+/**
+ * This is equivalent to observeEventType:withBlock:, except the block is immediately canceled after the initial data is returned. In addition, for FEventTypeChildAdded, FEventTypeChildMoved, and
+ * FEventTypeChildChanged events, your block will be passed the name 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 with initial data and updates.
+ * @param cancelBlock The block that will be called if you don't have permission to access this data
+ */
+- (void) observeSingleEventOfType:(FEventType)eventType andPreviousSiblingNameWithBlock:(void (^)(FDataSnapshot* snapshot, NSString* prevName))block withCancelBlock:(void (^)(void))cancelBlock;
+
+/** @name 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:(FirebaseHandle)handle;
+
+
+/**
+ * Detach all blocks previously attached to this Firebase location with observeEventType:withBlock:
+ */
+- (void) removeAllObservers;
+
+
+/** @name Querying and limiting */
+
+
+/**
+ * queryStartingAtPriority: is used to generate a reference to a limited view of the data at this location.
+ * The FQuery instance returned by queryStartingAtPriority: will respond to events at nodes with a priority
+ * greater than or equal to startPriority
+ *
+ * @param startPriority The lower bound, inclusive, for the priority of data visible to the returned FQuery
+ * @return An FQuery instance, limited to data with priority greater than or equal to startPriority
+ */
+- (FQuery *) queryStartingAtPriority:(id)startPriority;
+
+
+/**
+ * queryStartingAtPriority:andChildName: is used to generate a reference to a limited view of the data at this location.
+ * The FQuery instance returned by queryStartingAtPriority:andChildName will respond to events at nodes with a priority
+ * greater than startPriority, or equal to startPriority and with a name greater than or equal to childName
+ *
+ * @param startPriority The lower bound, inclusive, for the priority of data visible to the returned FQuery
+ * @param childName The lower bound, inclusive, for the name of nodes with priority equal to startPriority
+ * @return An FQuery instance, limited to data with priority greater than or equal to startPriority
+ */
+- (FQuery *) queryStartingAtPriority:(id)startPriority andChildName:(NSString *)childName;
+
+
+/**
+ * queryEndingAtPriority: is used to generate a reference to a limited view of the data at this location.
+ * The FQuery instance returned by queryEndingAtPriority: will respond to events at nodes with a priority
+ * less than or equal to startPriority and with a name greater than or equal to childName
+ *
+ * @param endPriority The upper bound, inclusive, for the priority of data visible to the returned FQuery
+ * @return An FQuery instance, limited to data with priority less than or equal to endPriority
+ */
+- (FQuery *) queryEndingAtPriority:(id)endPriority;
+
+
+/**
+ * queryEndingAtPriority:andChildName: is used to generate a reference to a limited view of the data at this location.
+ * The FQuery instance returned by queryEndingAtPriority:andChildNAme will respond to events at nodes with a priority
+ * less than endPriority, or equal to endPriority and with a name less than or equal to childName
+ *
+ * @param endPriority The upper bound, inclusive, for the priority of data visible to the returned FQuery
+ * @param childName The upper bound, inclusive, for the name of nodes with priority equal to endPriority
+ * @return An FQuery instance, limited to data with priority less than endPriority or equal to endPriority and with a name less than or equal to childName
+ */
+- (FQuery *) queryEndingAtPriority:(id)endPriority andChildName:(NSString *)childName;
+
+
+/**
+ * queryLimitedToNumberOfChildren: is used to generate a reference to a limited view of the data at this location.
+ * The FQuery instance returned by queryLimitedToNumberOfChildren: will respond to events at from at most limit child nodes
+ *
+ * @param limit The upper bound, inclusive, for the number of child nodes to receive events for
+ * @return An FQuery instance, limited to at most limit child nodes.
+ */
+- (FQuery *) queryLimitedToNumberOfChildren:(NSUInteger)limit;
+
+@end

data/lib/vendor/Firebase.framework/Versions/Current/Headers/FTransactionResult.h

@@ -0,0 +1,50 @@
+/*
+ * 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>
+#import "FMutableData.h"
+
+@interface FTransactionResult : NSObject
+
+/**
+ * Used for runTransactionBlock:. Indicates that the new value should be saved at this location
+ *
+ * @param value An FMutableData instance containing the new value to be set
+ * @return An FTransactionResult instance that can be used as a return value from the block given to runTransactionBlock:
+ */
++ (FTransactionResult *) successWithValue:(FMutableData *)value;
+
+
+/**
+ * Used for runTransactionBlock:. Indicates that the current transaction should no longer proceed.
+ *
+ * @return An FTransactionResult instance that can be used as a return value from the block given to runTransactionBlock:
+ */
++ (FTransactionResult *) abort;
+
+@end