motion-firebase 3.3.0 → 4.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,43 +0,0 @@
1
- /*
2
- * Firebase iOS Client Library
3
- *
4
- * Copyright © 2013 Firebase - All Rights Reserved
5
- * https://www.firebase.com
6
- *
7
- * Redistribution and use in source and binary forms, with or without
8
- * modification, are permitted provided that the following conditions are met:
9
- *
10
- * 1. Redistributions of source code must retain the above copyright notice, this
11
- * list of conditions and the following disclaimer.
12
- *
13
- * 2. Redistributions in binaryform must reproduce the above copyright notice,
14
- * this list of conditions and the following disclaimer in the documentation
15
- * and/or other materials provided with the distribution.
16
- *
17
- * THIS SOFTWARE IS PROVIDED BY FIREBASE AS IS AND ANY EXPRESS OR
18
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19
- * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20
- * EVENT SHALL FIREBASE BE LIABLE FOR ANY DIRECT,
21
- * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
22
- * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
24
- * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25
- * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
26
- * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
- */
28
-
29
- #ifndef Firebase_FEventType_h
30
- #define Firebase_FEventType_h
31
-
32
- /**
33
- * This enum is the set of events that you can observe at a Firebase location.
34
- */
35
- typedef NS_ENUM(NSInteger, FEventType) {
36
- FEventTypeChildAdded, // 0, fired when a new child node is added to a location
37
- FEventTypeChildRemoved, // 1, fired when a child node is removed from a location
38
- FEventTypeChildChanged, // 2, fired when a child node at a location changes
39
- FEventTypeChildMoved, // 3, fired when a child node moves relative to the other child nodes at a location
40
- FEventTypeValue // 4, fired when any data changes at a location and, recursively, any children
41
- };
42
-
43
- #endif
@@ -1,143 +0,0 @@
1
- /*
2
- * Firebase iOS Client Library
3
- *
4
- * Copyright © 2013 Firebase - All Rights Reserved
5
- * https://www.firebase.com
6
- *
7
- * Redistribution and use in source and binary forms, with or without
8
- * modification, are permitted provided that the following conditions are met:
9
- *
10
- * 1. Redistributions of source code must retain the above copyright notice, this
11
- * list of conditions and the following disclaimer.
12
- *
13
- * 2. Redistributions in binaryform must reproduce the above copyright notice,
14
- * this list of conditions and the following disclaimer in the documentation
15
- * and/or other materials provided with the distribution.
16
- *
17
- * THIS SOFTWARE IS PROVIDED BY FIREBASE AS IS AND ANY EXPRESS OR
18
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19
- * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20
- * EVENT SHALL FIREBASE BE LIABLE FOR ANY DIRECT,
21
- * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
22
- * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
24
- * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25
- * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
26
- * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
- */
28
-
29
- #import <Foundation/Foundation.h>
30
-
31
- /**
32
- * An FMutableData instance is populated with data from a Firebase location.
33
- * When you are using runTransactionBlock:, you will be given an instance containing the current
34
- * data at that location. Your block will be responsible for updating that instance to the data
35
- * you wish to save at that location, and then returning using [FTransactionResult successWithValue:].
36
- *
37
- * To modify the data, set its value property to any of the native types support by Firebase:
38
- * * NSNumber (includes BOOL)
39
- * * NSDictionary
40
- * * NSArray
41
- * * NSString
42
- * * nil / NSNull to remove the data
43
- *
44
- * Note that changes made to a child FMutableData instance will be visible to the parent.
45
- */
46
- @interface FMutableData : NSObject
47
-
48
-
49
- /** @name Inspecting and navigating the data */
50
-
51
-
52
- /**
53
- * Returns boolean indicating whether this mutable data has children.
54
- *
55
- * @return YES if this data contains child nodes.
56
- */
57
- - (BOOL) hasChildren;
58
-
59
-
60
- /**
61
- * Indicates whether this mutable data has a child at the given path.
62
- *
63
- * @param path A path string, consisting either of a single segment, like 'child', or multiple segments, 'a/deeper/child'
64
- * @return YES if this data contains a child at the specified relative path
65
- */
66
- - (BOOL) hasChildAtPath:(NSString *)path;
67
-
68
-
69
- /**
70
- * Used to obtain an FMutableData instance that encapsulates the data at the given relative path.
71
- * Note that changes made to the child will be visible to the parent.
72
- *
73
- * @param path A path string, consisting either of a single segment, like 'child', or multiple segments, 'a/deeper/child'
74
- * @return An FMutableData instance containing the data at the given path
75
- */
76
- - (FMutableData *) childDataByAppendingPath:(NSString *)path;
77
-
78
-
79
- /** @name Properties */
80
-
81
-
82
- /**
83
- * This method is deprecated.
84
- *
85
- * @return An FMutableData instance containing the data at the parent location, or nil if this is the top-most location
86
- */
87
- @property (strong, readonly, nonatomic) FMutableData* parent __attribute__((deprecated("Deprecated. Do not use.")));;
88
-
89
-
90
- /**
91
- * To modify the data contained by this instance of FMutableData, set this to any of the native types support by Firebase:
92
- *
93
- * * NSNumber (includes BOOL)
94
- * * NSDictionary
95
- * * NSArray
96
- * * NSString
97
- * * nil / NSNull to remove the data
98
- *
99
- * Note that setting the value will override the priority at this location.
100
- *
101
- * @return The current data at this location as a native object
102
- */
103
- @property (strong, nonatomic) id value;
104
-
105
-
106
- /**
107
- * Set this property to update the priority of the data at this location. Can be set to the following types:
108
- *
109
- * * NSNumber
110
- * * NSString
111
- * * nil / NSNull to remove the priority
112
- *
113
- * @return The priority of the data at this location
114
- */
115
- @property (strong, nonatomic) id priority;
116
-
117
-
118
- /**
119
- * @return The number of child nodes at this location
120
- */
121
- @property (readonly, nonatomic) NSUInteger childrenCount;
122
-
123
-
124
- /**
125
- * Used to iterate over the children at this location. You can use the native for .. in syntax:
126
- *
127
- * for (FMutableData* child in data.children) {
128
- * ...
129
- * }
130
- *
131
- * Note that this enumerator operates on an immutable copy of the child list. So, you can modify the instance
132
- * during iteration, but the new additions will not be visible until you get a new enumerator.
133
- */
134
- @property (readonly, nonatomic, strong) NSEnumerator* children;
135
-
136
-
137
- /**
138
- * @return The key name of this node, or nil if it is the top-most location
139
- */
140
- @property (readonly, nonatomic, strong) NSString* key;
141
-
142
-
143
- @end
@@ -1,412 +0,0 @@
1
- /*
2
- * Firebase iOS Client Library
3
- *
4
- * Copyright © 2013 Firebase - All Rights Reserved
5
- * https://www.firebase.com
6
- *
7
- * Redistribution and use in source and binary forms, with or without
8
- * modification, are permitted provided that the following conditions are met:
9
- *
10
- * 1. Redistributions of source code must retain the above copyright notice, this
11
- * list of conditions and the following disclaimer.
12
- *
13
- * 2. Redistributions in binaryform must reproduce the above copyright notice,
14
- * this list of conditions and the following disclaimer in the documentation
15
- * and/or other materials provided with the distribution.
16
- *
17
- * THIS SOFTWARE IS PROVIDED BY FIREBASE AS IS AND ANY EXPRESS OR
18
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19
- * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20
- * EVENT SHALL FIREBASE BE LIABLE FOR ANY DIRECT,
21
- * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
22
- * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
24
- * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25
- * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
26
- * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
- */
28
-
29
- #import <Foundation/Foundation.h>
30
- #import "FEventType.h"
31
- #import "FDataSnapshot.h"
32
-
33
- typedef NSUInteger FirebaseHandle;
34
-
35
- /**
36
- * An FQuery instance represents a query over the data at a particular location.
37
- *
38
- * You create one by calling one of the query methods (queryStartingAtPriority:, queryEndingAtPriority:, etc.)
39
- * on a Firebase reference. The query methods can be chained to further specify the data you are interested in
40
- * observing
41
- */
42
- @interface FQuery : NSObject
43
-
44
-
45
- /** @name Attaching observers to read data */
46
-
47
- /**
48
- * observeEventType:withBlock: is used to listen for data changes at a particular location.
49
- * This is the primary way to read data from Firebase. Your block will be triggered
50
- * for the initial data and again whenever the data changes.
51
- *
52
- * Use removeObserverWithHandle: to stop receiving updates.
53
- * @param eventType The type of event to listen for.
54
- * @param block The block that should be called with initial data and updates. It is passed the data as an FDataSnapshot.
55
- * @return A handle used to unregister this block later using removeObserverWithHandle:
56
- */
57
- - (FirebaseHandle) observeEventType:(FEventType)eventType withBlock:(void (^)(FDataSnapshot* snapshot))block;
58
-
59
-
60
- /**
61
- * observeEventType:andPreviousSiblingKeyWithBlock: is used to listen for data changes at a particular location.
62
- * This is the primary way to read data from Firebase. Your block will be triggered
63
- * for the initial data and again whenever the data changes. In addition, for FEventTypeChildAdded, FEventTypeChildMoved, and
64
- * FEventTypeChildChanged events, your block will be passed the key of the previous node by priority order.
65
- *
66
- * Use removeObserverWithHandle: to stop receiving updates.
67
- *
68
- * @param eventType The type of event to listen for.
69
- * @param block The block that should be called with initial data and updates. It is passed the data as an FDataSnapshot
70
- * and the previous child's key.
71
- * @return A handle used to unregister this block later using removeObserverWithHandle:
72
- */
73
- - (FirebaseHandle) observeEventType:(FEventType)eventType andPreviousSiblingKeyWithBlock:(void (^)(FDataSnapshot* snapshot, NSString* prevKey))block;
74
-
75
-
76
- /**
77
- * observeEventType:withBlock: is used to listen for data changes at a particular location.
78
- * This is the primary way to read data from Firebase. Your block will be triggered
79
- * for the initial data and again whenever the data changes.
80
- *
81
- * The cancelBlock will be called if you will no longer receive new events due to no longer having permission.
82
- *
83
- * Use removeObserverWithHandle: to stop receiving updates.
84
- *
85
- * @param eventType The type of event to listen for.
86
- * @param block The block that should be called with initial data and updates. It is passed the data as an FDataSnapshot.
87
- * @param cancelBlock The block that should be called if this client no longer has permission to receive these events
88
- * @return A handle used to unregister this block later using removeObserverWithHandle:
89
- */
90
- - (FirebaseHandle) observeEventType:(FEventType)eventType withBlock:(void (^)(FDataSnapshot* snapshot))block withCancelBlock:(void (^)(NSError* error))cancelBlock;
91
-
92
-
93
- /**
94
- * observeEventType:andPreviousSiblingKeyWithBlock: is used to listen for data changes at a particular location.
95
- * This is the primary way to read data from Firebase. Your block will be triggered
96
- * for the initial data and again whenever the data changes. In addition, for FEventTypeChildAdded, FEventTypeChildMoved, and
97
- * FEventTypeChildChanged events, your block will be passed the key of the previous node by priority order.
98
- *
99
- * The cancelBlock will be called if you will no longer receive new events due to no longer having permission.
100
- *
101
- * Use removeObserverWithHandle: to stop receiving updates.
102
- *
103
- * @param eventType The type of event to listen for.
104
- * @param block The block that should be called with initial data and updates. It is passed the data as an FDataSnapshot
105
- * and the previous child's key.
106
- * @param cancelBlock The block that should be called if this client no longer has permission to receive these events
107
- * @return A handle used to unregister this block later using removeObserverWithHandle:
108
- */
109
- - (FirebaseHandle) observeEventType:(FEventType)eventType andPreviousSiblingKeyWithBlock:(void (^)(FDataSnapshot* snapshot, NSString* prevKey))block withCancelBlock:(void (^)(NSError* error))cancelBlock;
110
-
111
-
112
- /**
113
- * This is equivalent to observeEventType:withBlock:, except the block is immediately canceled after the initial data is returned.
114
- *
115
- * @param eventType The type of event to listen for.
116
- * @param block The block that should be called. It is passed the data as an FDataSnapshot.
117
- */
118
- - (void) observeSingleEventOfType:(FEventType)eventType withBlock:(void (^)(FDataSnapshot* snapshot))block;
119
-
120
-
121
- /**
122
- * This is equivalent to observeEventType:withBlock:, except the block is immediately canceled after the initial data is returned. In addition, for FEventTypeChildAdded, FEventTypeChildMoved, and
123
- * FEventTypeChildChanged events, your block will be passed the key of the previous node by priority order.
124
- *
125
- * @param eventType The type of event to listen for.
126
- * @param block The block that should be called. It is passed the data as an FDataSnapshot and the previous child's key.
127
- */
128
- - (void) observeSingleEventOfType:(FEventType)eventType andPreviousSiblingKeyWithBlock:(void (^)(FDataSnapshot* snapshot, NSString* prevKey))block;
129
-
130
-
131
- /**
132
- * This is equivalent to observeEventType:withBlock:, except the block is immediately canceled after the initial data is returned.
133
- *
134
- * The cancelBlock will be called if you do not have permission to read data at this location.
135
- *
136
- * @param eventType The type of event to listen for.
137
- * @param block The block that should be called. It is passed the data as an FDataSnapshot.
138
- * @param cancelBlock The block that will be called if you don't have permission to access this data
139
- */
140
- - (void) observeSingleEventOfType:(FEventType)eventType withBlock:(void (^)(FDataSnapshot* snapshot))block withCancelBlock:(void (^)(NSError* error))cancelBlock;
141
-
142
-
143
- /**
144
- * This is equivalent to observeEventType:withBlock:, except the block is immediately canceled after the initial data is returned. In addition, for FEventTypeChildAdded, FEventTypeChildMoved, and
145
- * FEventTypeChildChanged events, your block will be passed the key of the previous node by priority order.
146
- *
147
- * The cancelBlock will be called if you do not have permission to read data at this location.
148
- *
149
- * @param eventType The type of event to listen for.
150
- * @param block The block that should be called. It is passed the data as an FDataSnapshot and the previous child's key.
151
- * @param cancelBlock The block that will be called if you don't have permission to access this data
152
- */
153
- - (void) observeSingleEventOfType:(FEventType)eventType andPreviousSiblingKeyWithBlock:(void (^)(FDataSnapshot* snapshot, NSString* prevKey))block withCancelBlock:(void (^)(NSError* error))cancelBlock;
154
-
155
- /** @name Detaching observers */
156
-
157
- /**
158
- * Detach a block previously attached with observeEventType:withBlock:.
159
- *
160
- * @param handle The handle returned by the call to observeEventType:withBlock: which we are trying to remove.
161
- */
162
- - (void) removeObserverWithHandle:(FirebaseHandle)handle;
163
-
164
-
165
- /**
166
- * Detach all blocks previously attached to this Firebase location with observeEventType:withBlock:
167
- */
168
- - (void) removeAllObservers;
169
-
170
- /**
171
- * By calling `keepSynced:YES` on a location, the data for that location will automatically be downloaded and
172
- * kept in sync, even when no listeners are attached for that location. Additionally, while a location is kept
173
- * synced, it will not be evicted from the persistent disk cache.
174
- *
175
- * @param keepSynced Pass YES to keep this location synchronized, pass NO to stop synchronization.
176
- */
177
- - (void) keepSynced:(BOOL)keepSynced;
178
-
179
-
180
- /** @name Querying and limiting */
181
-
182
-
183
- /**
184
- * This method is deprecated in favor of using queryStartingAtValue:. This can be used with queryOrderedByPriority
185
- * to query by priority.
186
- *
187
- * queryStartingAtPriority: is used to generate a reference to a limited view of the data at this location.
188
- * The FQuery instance returned by queryStartingAtPriority: will respond to events at nodes with a priority
189
- * greater than or equal to startPriority
190
- *
191
- * @param startPriority The lower bound, inclusive, for the priority of data visible to the returned FQuery
192
- * @return An FQuery instance, limited to data with priority greater than or equal to startPriority
193
- */
194
- - (FQuery *) queryStartingAtPriority:(id)startPriority __attribute__((deprecated("Use [[FQuery queryOrderedByPriority] queryStartingAtValue:] instead")));
195
-
196
-
197
- /**
198
- * This method is deprecated in favor of using queryStartingAtValue:childKey:. This can be used with queryOrderedByPriority
199
- * to query by priority.
200
- *
201
- * queryStartingAtPriority:andChildName: is used to generate a reference to a limited view of the data at this location.
202
- * The FQuery instance returned by queryStartingAtPriority:andChildName will respond to events at nodes with a priority
203
- * greater than startPriority, or equal to startPriority and with a name greater than or equal to childName
204
- *
205
- * @param startPriority The lower bound, inclusive, for the priority of data visible to the returned FQuery
206
- * @param childName The lower bound, inclusive, for the name of nodes with priority equal to startPriority
207
- * @return An FQuery instance, limited to data with priority greater than or equal to startPriority
208
- */
209
- - (FQuery *) queryStartingAtPriority:(id)startPriority andChildName:(NSString *)childName __attribute__((deprecated("Use [[FQuery queryOrderedByPriority] queryStartingAtValue:childKey:] instead")));
210
-
211
- /**
212
- * This method is deprecated in favor of using queryEndingAtValue:. This can be used with queryOrderedByPriority
213
- * to query by priority.
214
- *
215
- * queryEndingAtPriority: is used to generate a reference to a limited view of the data at this location.
216
- * The FQuery instance returned by queryEndingAtPriority: will respond to events at nodes with a priority
217
- * less than or equal to startPriority and with a name greater than or equal to childName
218
- *
219
- * @param endPriority The upper bound, inclusive, for the priority of data visible to the returned FQuery
220
- * @return An FQuery instance, limited to data with priority less than or equal to endPriority
221
- */
222
- - (FQuery *) queryEndingAtPriority:(id)endPriority __attribute__((deprecated("Use [[FQuery queryOrderedByPriority] queryEndingAtValue:] instead")));
223
-
224
-
225
- /**
226
- * This method is deprecated in favor of using queryEndingAtValue:childKey:. This can be used with queryOrderedByPriority
227
- * to query by priority.
228
- *
229
- * queryEndingAtPriority:andChildName: is used to generate a reference to a limited view of the data at this location.
230
- * The FQuery instance returned by queryEndingAtPriority:andChildName will respond to events at nodes with a priority
231
- * less than endPriority, or equal to endPriority and with a name less than or equal to childName
232
- *
233
- * @param endPriority The upper bound, inclusive, for the priority of data visible to the returned FQuery
234
- * @param childName The upper bound, inclusive, for the name of nodes with priority equal to endPriority
235
- * @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
236
- */
237
- - (FQuery *) queryEndingAtPriority:(id)endPriority andChildName:(NSString *)childName __attribute__((deprecated("Use [[FQuery queryOrderedByPriority] queryEndingAtValue:childKey:] instead")));
238
-
239
-
240
- /**
241
- * This method is deprecated in favor of using queryEqualToValue:. This can be used with queryOrderedByPriority
242
- * to query by priority.
243
- *
244
- * queryEqualToPriority: is used to generate a reference to a limited view of the data at this location.
245
- * The FQuery instance returned by queryEqualToPriority: will respond to events at nodes with a priority equal to
246
- * supplied argument.
247
- *
248
- * @param priority The priority that the data returned by this FQuery will have
249
- * @return An Fquery instance, limited to data with the supplied priority.
250
- */
251
- - (FQuery *) queryEqualToPriority:(id)priority __attribute__((deprecated("Use [[FQuery queryOrderedByPriority] queryEqualToValue:] instead")));
252
-
253
-
254
- /**
255
- * This method is deprecated in favor of using queryEqualAtValue:childKey:. This can be used with queryOrderedByPriority
256
- * to query by priority.
257
- *
258
- * queryEqualToPriority:andChildName: is used to generate a reference to a limited view of the data at this location.
259
- * The FQuery instance returned by queryEqualToPriority:andChildName will respond to events at nodes with a priority
260
- * equal to the supplied argument with a name equal to childName. There will be at most one node that matches because
261
- * child names are unique.
262
- *
263
- * @param priority The priority that the data returned by this FQuery will have
264
- * @param childName The name of nodes with the right priority
265
- * @return An FQuery instance, limited to data with the supplied priority and the name.
266
- */
267
- - (FQuery *) queryEqualToPriority:(id)priority andChildName:(NSString *)childName __attribute__((deprecated("Use [[FQuery queryOrderedByPriority] queryEqualToValue:childKey:] instead")));
268
-
269
- /**
270
- * This method is deprecated in favor of using queryLimitedToFirst:limit or queryLimitedToLast:limit instead.
271
- *
272
- * queryLimitedToNumberOfChildren: is used to generate a reference to a limited view of the data at this location.
273
- * The FQuery instance returned by queryLimitedToNumberOfChildren: will respond to events from at most limit child nodes.
274
- *
275
- * @param limit The upper bound, inclusive, for the number of child nodes to receive events for
276
- * @return An FQuery instance, limited to at most limit child nodes.
277
- */
278
- - (FQuery *) queryLimitedToNumberOfChildren:(NSUInteger)limit __attribute__((deprecated("Use [FQuery queryLimitedToFirst:limit] or [FQuery queryLimitedToLast:limit] instead")));
279
-
280
-
281
- /**
282
- * queryLimitedToFirst: is used to generate a reference to a limited view of the data at this location.
283
- * The FQuery instance returned by queryLimitedToFirst: will respond to at most the first limit child nodes.
284
- *
285
- * @param limit The upper bound, inclusive, for the number of child nodes to receive events for
286
- * @return An FQuery instance, limited to at most limit child nodes.
287
- */
288
- - (FQuery *) queryLimitedToFirst:(NSUInteger)limit;
289
-
290
-
291
- /**
292
- * queryLimitedToLast: is used to generate a reference to a limited view of the data at this location.
293
- * The FQuery instance returned by queryLimitedToLast: will respond to at most the last limit child nodes.
294
- *
295
- * @param limit The upper bound, inclusive, for the number of child nodes to receive events for
296
- * @return An FQuery instance, limited to at most limit child nodes.
297
- */
298
- - (FQuery *) queryLimitedToLast:(NSUInteger)limit;
299
-
300
- /**
301
- * queryOrderBy: is used to generate a reference to a view of the data that's been sorted by the values of
302
- * a particular child key. This method is intended to be used in combination with queryStartingAtValue:,
303
- * queryEndingAtValue:, or queryEqualToValue:.
304
- *
305
- * @param key The child key to use in ordering data visible to the returned FQuery
306
- * @return An FQuery instance, ordered by the values of the specified child key.
307
- */
308
- - (FQuery *) queryOrderedByChild:(NSString *)key;
309
-
310
- /**
311
- * queryOrderedByKey: is used to generate a reference to a view of the data that's been sorted by child key.
312
- * This method is intended to be used in combination with queryStartingAtValue:, queryEndingAtValue:,
313
- * or queryEqualToValue:.
314
- *
315
- * @return An FQuery instance, ordered by child keys.
316
- */
317
- - (FQuery *) queryOrderedByKey;
318
-
319
- /**
320
- * queryOrderedByValue: is used to generate a reference to a view of the data that's been sorted by child value.
321
- * This method is intended to be used in combination with queryStartingAtValue:, queryEndingAtValue:,
322
- * or queryEqualToValue:.
323
- *
324
- * @return An FQuery instance, ordered by child value.
325
- */
326
- - (FQuery *) queryOrderedByValue;
327
-
328
- /**
329
- * queryOrderedByPriority: is used to generate a reference to a view of the data that's been sorted by child
330
- * priority. This method is intended to be used in combination with queryStartingAtValue:, queryEndingAtValue:,
331
- * or queryEqualToValue:.
332
- *
333
- * @return An FQuery instance, ordered by child priorities.
334
- */
335
- - (FQuery *) queryOrderedByPriority;
336
-
337
- /**
338
- * queryStartingAtValue: is used to generate a reference to a limited view of the data at this location.
339
- * The FQuery instance returned by queryStartingAtValue: will respond to events at nodes with a value
340
- * greater than or equal to startValue.
341
- *
342
- * @param startValue The lower bound, inclusive, for the value of data visible to the returned FQuery
343
- * @return An FQuery instance, limited to data with value greater than or equal to startValue
344
- */
345
- - (FQuery *) queryStartingAtValue:(id)startValue;
346
-
347
- /**
348
- * queryStartingAtValue:childKey: is used to generate a reference to a limited view of the data at this location.
349
- * The FQuery instance returned by queryStartingAtValue:childKey will respond to events at nodes with a value
350
- * greater than startValue, or equal to startValue and with a key greater than or equal to childKey.
351
- *
352
- * @param startValue The lower bound, inclusive, for the value of data visible to the returned FQuery
353
- * @param childKey The lower bound, inclusive, for the key of nodes with value equal to startValue
354
- * @return An FQuery instance, limited to data with value greater than or equal to startValue
355
- */
356
- - (FQuery *) queryStartingAtValue:(id)startValue childKey:(NSString *)childKey;
357
-
358
- /**
359
- * queryEndingAtValue: is used to generate a reference to a limited view of the data at this location.
360
- * The FQuery instance returned by queryEndingAtValue: will respond to events at nodes with a value
361
- * less than or equal to endValue.
362
- *
363
- * @param endValue The upper bound, inclusive, for the value of data visible to the returned FQuery
364
- * @return An FQuery instance, limited to data with value less than or equal to endValue
365
- */
366
- - (FQuery *) queryEndingAtValue:(id)endValue;
367
-
368
- /**
369
- * queryEndingAtValue:childKey: is used to generate a reference to a limited view of the data at this location.
370
- * The FQuery instance returned by queryEndingAtValue:childKey will respond to events at nodes with a value
371
- * less than endValue, or equal to endValue and with a key less than or equal to childKey.
372
- *
373
- * @param endValue The upper bound, inclusive, for the value of data visible to the returned FQuery
374
- * @param childKey The upper bound, inclusive, for the key of nodes with value equal to endValue
375
- * @return An FQuery instance, limited to data with value less than or equal to endValue
376
- */
377
- - (FQuery *) queryEndingAtValue:(id)endValue childKey:(NSString *)childKey;
378
-
379
- /**
380
- * queryEqualToValue: is used to generate a reference to a limited view of the data at this location.
381
- * The FQuery instance returned by queryEqualToValue: will respond to events at nodes with a value equal
382
- * to the supplied argument.
383
- *
384
- * @param value The value that the data returned by this FQuery will have
385
- * @return An Fquery instance, limited to data with the supplied value.
386
- */
387
- - (FQuery *) queryEqualToValue:(id)value;
388
-
389
- /**
390
- * queryEqualToValue:childKey: is used to generate a reference to a limited view of the data at this location.
391
- * The FQuery instance returned by queryEqualToValue:childKey will respond to events at nodes with a value
392
- * equal to the supplied argument with a name equal to childKey. There will be at most one node that matches because
393
- * child keys are unique.
394
- *
395
- * @param value The value that the data returned by this FQuery will have
396
- * @param childKey The name of nodes with the right value
397
- * @return An FQuery instance, limited to data with the supplied value and the key.
398
- */
399
- - (FQuery *) queryEqualToValue:(id)value childKey:(NSString *)childKey;
400
-
401
-
402
- /** @name Properties */
403
-
404
-
405
- /**
406
- * Get a Firebase reference for the location of this query.
407
- *
408
- * @return A Firebase instance for the location of this query.
409
- */
410
- @property (nonatomic, readonly, strong) Firebase* ref;
411
-
412
- @end