-
Notifications
You must be signed in to change notification settings - Fork 0
/
SMDataStore.h
578 lines (455 loc) · 38.1 KB
/
SMDataStore.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
/*
* Copyright 2012-2013 StackMob
*
* 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 <CoreData/CoreData.h>
#import "SMClient.h"
#import "SMQuery.h"
#import "SMResponseBlocks.h"
#define POST @"POST"
#define GET @"GET"
#define PUT @"PUT"
#define DELETE @"DELETE"
@class SMUserSession;
@class SMRequestOptions;
@class SMCustomCodeRequest;
/**
`SMDataStore` exposes an interface for performing CRUD operations on known StackMob objects and for executing an <SMQuery> or <SMCustomCodeRequest>.
As a direct interface to StackMob, `SMDataStore` uses StackMob's terminology:
* Operations are performed against a specific _schema_ (usually also the name of a model class or of an entity in a managed object model).
* Objects sent via the API are expressed as a dictionary of _fields_.
* The schema name string provided to any of the methods in this class is NOT case-sensitive. It will be converted and stored on StackMob as a lowercase string but returned in success/failure blocks in the same form it was received.
**Accessing the Datastore**
Using your `SMClient` defaultClient:
[[[SMClient defaultClient] dataStore] createObject...];
Creating an instance of `SMDataStore`:
// Assuming you have an initialized SMClient call client
SMDataStore *dataStore = [[self client] dataStore];
[dataStore createObject...];
*/
@interface SMDataStore : NSObject
///-------------------------------
/// @name Properties
///-------------------------------
/**
The StackMob API Version being used.
@since Available in iOS SDK 1.0.0 and later.
*/
@property(nonatomic, readonly, copy) NSString *apiVersion;
/**
The instance of `SMUserSession` attached to this datastore.
@since Available in iOS SDK 1.0.0 and later.
*/
@property(nonatomic, readwrite, strong) SMUserSession *session;
///-------------------------------
/// @name Initialize
///-------------------------------
/**
Initialize a Datastore.
@param apiVersion The API version of your StackMob application which this `SMDataStore` instance should use.
@param session An instance of <SMUserSession> configured with the proper credentials. This is used to properly authenticate requests.
@return An instance of `SMDataStore` configured with the supplied apiVersion and session.
@since Available in iOS SDK 1.0.0 and later.
*/
- (id)initWithAPIVersion:(NSString *)apiVersion session:(SMUserSession *)session;
#pragma mark - Create an Object
///-------------------------------
/// @name Create an Object
///-------------------------------
/**
Create a new object in your StackMob Datastore.
@param theObject A dictionary describing the object to create on StackMob. Keys should map to valid StackMob fields. Values should be JSON serializable objects.
@param schema The StackMob schema in which to create this new object.
@param successBlock <i>typedef void (^SMDataStoreSuccessBlock)(NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the main thread after the object is successfully created. Passed the dictionary representation of the response from StackMob and the schema in which the new object was created.
@param failureBlock <i>typedef void (^SMDataStoreFailureBlock)(NSError *theError, NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the main thread if the Datastore fails to create the specified object. Passed the error returned by StackMob, the dictionary sent with this create request, and the schema in which the object was to be created.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)createObject:(NSDictionary *)theObject
inSchema:(NSString *)schema
onSuccess:(SMDataStoreSuccessBlock)successBlock
onFailure:(SMDataStoreFailureBlock)failureBlock;
/**
Create a new object in your StackMob Datastore.
@param theObject A dictionary describing the object to create on StackMob. Keys should map to valid StackMob fields. Values should be JSON serializable objects.
@param schema The StackMob schema in which to create this new object.
@param options An options object contains headers and other configuration for this request
@param successBlock <i>typedef void (^SMDataStoreSuccessBlock)(NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the main thread after the object is successfully created. Passed the dictionary representation of the response from StackMob and the schema in which the new object was created.
@param failureBlock <i>typedef void (^SMDataStoreFailureBlock)(NSError *theError, NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the main thread if the Datastore fails to create the specified object. Passed the error returned by StackMob, the dictionary sent with this create request, and the schema in which the object was to be created.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)createObject:(NSDictionary *)theObject
inSchema:(NSString *)schema
options:(SMRequestOptions *)options
onSuccess:(SMDataStoreSuccessBlock)successBlock
onFailure:(SMDataStoreFailureBlock)failureBlock;
/**
Create a new object in your StackMob Datastore.
@param theObject A dictionary describing the object to create on StackMob. Keys should map to valid StackMob fields. Values should be JSON serializable objects.
@param schema The StackMob schema in which to create this new object.
@param options An options object contains headers and other configuration for this request.
@param successCallbackQueue The dispatch queue used to execute the success block. If nil is passed, the main queue is used.
@param failureCallbackQueue The dispatch queue used to execute the failure block. If nil is passed, the main queue is used.
@param successBlock <i>typedef void (^SMDataStoreSuccessBlock)(NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the successCallbackQueue after the object is successfully created. Passed the dictionary representation of the response from StackMob and the schema in which the new object was created.
@param failureBlock <i>typedef void (^SMDataStoreFailureBlock)(NSError *theError, NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the failureCallbackQueue if the Datastore fails to create the specified object. Passed the error returned by StackMob, the dictionary sent with this create request, and the schema in which the object was to be created.
@since Available in iOS SDK 1.2.0 and later.
*/
- (void)createObject:(NSDictionary *)theObject
inSchema:(NSString *)schema
options:(SMRequestOptions *)options
successCallbackQueue:(dispatch_queue_t)successCallbackQueue
failureCallbackQueue:(dispatch_queue_t)failureCallbackQueue
onSuccess:(SMDataStoreSuccessBlock)successBlock
onFailure:(SMDataStoreFailureBlock)failureBlock;
#pragma mark - Read an Object
///-------------------------------
/// @name Read an Object
///-------------------------------
/**
Read an existing object from your StackMob Datastore.
@param theObjectId The object id (the value of the primary key field) for the object to read.
@param schema The StackMob schema containing this object.
@param successBlock <i>typedef void (^SMDataStoreSuccessBlock)(NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the main thread after the object is successfully read. Passed the dictionary representation of the response from StackMob and the object's schema.
@param failureBlock <i>typedef void (^SMDataStoreObjectIdFailureBlock)(NSError *theError, NSString* theObjectId, NSString *schema)</i>. A block object to invoke on the main thread if the Datastore fails to read the specified object. Passed the error returned by StackMob, the object id sent with this request, and the schema in which the object was to be found.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)readObjectWithId:(NSString *)theObjectId
inSchema:(NSString *)schema
onSuccess:(SMDataStoreSuccessBlock)successBlock
onFailure:(SMDataStoreObjectIdFailureBlock)failureBlock;
/**
Read an existing object from your StackMob Datastore (with request options).
@param theObjectId The object id (the value of the primary key field) for the object to read.
@param schema The StackMob schema containing this object.
@param options An options object contains headers and other configuration for this request
@param successBlock <i>typedef void (^SMDataStoreSuccessBlock)(NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the main thread after the object is successfully read. Passed the dictionary representation of the response from StackMob and the object's schema.
@param failureBlock <i>typedef void (^SMDataStoreObjectIdFailureBlock)(NSError *theError, NSString* theObjectId, NSString *schema)</i>. A block object to invoke on the main thread if the Datastore fails to read the specified object. Passed the error returned by StackMob, the object id sent with this request, and the schema in which the object was to be found.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)readObjectWithId:(NSString *)theObjectId
inSchema:(NSString *)schema
options:(SMRequestOptions *)options
onSuccess:(SMDataStoreSuccessBlock)successBlock
onFailure:(SMDataStoreObjectIdFailureBlock)failureBlock;
/**
Read an existing object from your StackMob Datastore (with request options).
@param theObjectId The object id (the value of the primary key field) for the object to read.
@param schema The StackMob schema containing this object.
@param options An options object contains headers and other configuration for this request.
@param successCallbackQueue The dispatch queue used to execute the success block. If nil is passed, the main queue is used.
@param failureCallbackQueue The dispatch queue used to execute the failure block. If nil is passed, the main queue is used.
@param successBlock <i>typedef void (^SMDataStoreSuccessBlock)(NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the successCallbackQueue after the object is successfully read. Passed the dictionary representation of the response from StackMob and the object's schema.
@param failureBlock <i>typedef void (^SMDataStoreObjectIdFailureBlock)(NSError *theError, NSString* theObjectId, NSString *schema)</i>. A block object to invoke on the failureCallbackQueue if the Datastore fails to read the specified object. Passed the error returned by StackMob, the object id sent with this request, and the schema in which the object was to be found.
@since Available in iOS SDK 1.2.0 and later.
*/
- (void)readObjectWithId:(NSString *)theObjectId
inSchema:(NSString *)schema
options:(SMRequestOptions *)options
successCallbackQueue:(dispatch_queue_t)successCallbackQueue
failureCallbackQueue:(dispatch_queue_t)failureCallbackQueue
onSuccess:(SMDataStoreSuccessBlock)successBlock
onFailure:(SMDataStoreObjectIdFailureBlock)failureBlock;
#pragma mark - Update an Object
///-------------------------------
/// @name Update an Object
///-------------------------------
/**
Update an existing object in your StackMob Datastore.
@param theObjectId The object id (the value of the primary key field) for the object to update.
@param schema The StackMob schema containing this object.
@param updatedFields A dictionary describing the object. Keys should map to valid StackMob fields. Values should be JSON serializable objects.
@param successBlock <i>typedef void (^SMDataStoreSuccessBlock)(NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the main thread after the object is successfully updated. Passed the dictionary representation of the response from StackMob and the object's schema.
@param failureBlock <i>typedef void (^SMDataStoreFailureBlock)(NSError *theError, NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the main thread if the Datastore fails to read the specified object. Passed the error returned by StackMob, the dictionary sent with this request, and the schema in which the object was to be found.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)updateObjectWithId:(NSString *)theObjectId
inSchema:(NSString *)schema
update:(NSDictionary *)updatedFields
onSuccess:(SMDataStoreSuccessBlock)successBlock
onFailure:(SMDataStoreFailureBlock)failureBlock;
/**
Update an existing object in your StackMob Datastore (with request options).
@param theObjectId The object id (the value of the primary key field) for the object to update.
@param schema The StackMob schema containing this object.
@param updatedFields A dictionary describing the object. Keys should map to valid StackMob fields. Values should be JSON serializable objects.
@param options An options object contains headers and other configuration for this request
@param successBlock <i>typedef void (^SMDataStoreSuccessBlock)(NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the main thread after the object is successfully updated. Passed the dictionary representation of the response from StackMob and the object's schema.
@param failureBlock <i>typedef void (^SMDataStoreFailureBlock)(NSError *theError, NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the main thread if the Datastore fails to read the specified object. Passed the error returned by StackMob, the dictionary sent with this request, and the schema in which the object was to be found.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)updateObjectWithId:(NSString *)theObjectId
inSchema:(NSString *)schema
update:(NSDictionary *)updatedFields
options:(SMRequestOptions *)options
onSuccess:(SMDataStoreSuccessBlock)successBlock
onFailure:(SMDataStoreFailureBlock)failureBlock;
/**
Update an existing object in your StackMob Datastore (with request options).
@param theObjectId The object id (the value of the primary key field) for the object to update.
@param schema The StackMob schema containing this object.
@param updatedFields A dictionary describing the object. Keys should map to valid StackMob fields. Values should be JSON serializable objects.
@param options An options object contains headers and other configuration for this request.
@param successCallbackQueue The dispatch queue used to execute the success block. If nil is passed, the main queue is used.
@param failureCallbackQueue The dispatch queue used to execute the failure block. If nil is passed, the main queue is used.
@param successBlock <i>typedef void (^SMDataStoreSuccessBlock)(NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the successCallbackQueue after the object is successfully updated. Passed the dictionary representation of the response from StackMob and the object's schema.
@param failureBlock <i>typedef void (^SMDataStoreFailureBlock)(NSError *theError, NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the failureCallbackQueue if the Datastore fails to read the specified object. Passed the error returned by StackMob, the dictionary sent with this request, and the schema in which the object was to be found.
@since Available in iOS SDK 1.2.0 and later.
*/
- (void)updateObjectWithId:(NSString *)theObjectId
inSchema:(NSString *)schema
update:(NSDictionary *)updatedFields
options:(SMRequestOptions *)options
successCallbackQueue:(dispatch_queue_t)successCallbackQueue
failureCallbackQueue:(dispatch_queue_t)failureCallbackQueue
onSuccess:(SMDataStoreSuccessBlock)successBlock
onFailure:(SMDataStoreFailureBlock)failureBlock;
/**
Do an atomic update on a particular value.
@param theObjectId The object id (the value of the primary key field) for the object to update.
@param field the field in the schema that represents the counter.
@param schema The StackMob schema containing the counter.
@param increment The value (positive or negative) to increment the counter by.
@param successBlock <i>typedef void (^SMDataStoreSuccessBlock)(NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the main thread after the object is successfully updated. Passed the dictionary representation of the response from StackMob and the object's schema.
@param failureBlock <i>typedef void (^SMDataStoreFailureBlock)(NSError *theError, NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the main thread if the Datastore fails to read the specified object. Passed the error returned by StackMob, the dictionary sent with this request, and the schema in which the object was to be found.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)updateAtomicCounterWithId:(NSString *)theObjectId
field:(NSString *)field
inSchema:(NSString *)schema
by:(int)increment
onSuccess:(SMDataStoreSuccessBlock)successBlock
onFailure:(SMDataStoreFailureBlock)failureBlock;
/**
Do an atomic update on a particular value (with request options).
@param theObjectId The object id (the value of the primary key field) for the object to update.
@param field the field in the schema that represents the counter.
@param schema The StackMob schema containing the counter.
@param increment The value (positive or negative) to increment the counter by.
@param options An options object contains headers and other configuration for this request.
@param successBlock <i>typedef void (^SMDataStoreSuccessBlock)(NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the main thread after the object is successfully updated. Passed the dictionary representation of the response from StackMob and the object's schema.
@param failureBlock <i>typedef void (^SMDataStoreFailureBlock)(NSError *theError, NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the main thread if the Datastore fails to read the specified object. Passed the error returned by StackMob, the dictionary sent with this request, and the schema in which the object was to be found.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)updateAtomicCounterWithId:(NSString *)theObjectId
field:(NSString *)field
inSchema:(NSString *)schema
by:(int)increment
options:(SMRequestOptions *)options
onSuccess:(SMDataStoreSuccessBlock)successBlock
onFailure:(SMDataStoreFailureBlock)failureBlock;
/**
Do an atomic update on a particular value (with request options).
@param theObjectId The object id (the value of the primary key field) for the object to update.
@param field the field in the schema that represents the counter.
@param schema The StackMob schema containing the counter.
@param increment The value (positive or negative) to increment the counter by.
@param options An options object contains headers and other configuration for this request.
@param successCallbackQueue The dispatch queue used to execute the success block. If nil is passed, the main queue is used.
@param failureCallbackQueue The dispatch queue used to execute the failure block. If nil is passed, the main queue is used.
@param successBlock <i>typedef void (^SMDataStoreSuccessBlock)(NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the successCallbackQueue after the object is successfully updated. Passed the dictionary representation of the response from StackMob and the object's schema.
@param failureBlock <i>typedef void (^SMDataStoreFailureBlock)(NSError *theError, NSDictionary* theObject, NSString *schema)</i>. A block object to invoke on the failureCallbackQueue if the Datastore fails to read the specified object. Passed the error returned by StackMob, the dictionary sent with this request, and the schema in which the object was to be found.
@since Available in iOS SDK 1.2.0 and later.
*/
- (void)updateAtomicCounterWithId:(NSString *)theObjectId
field:(NSString *)field
inSchema:(NSString *)schema
by:(int)increment
options:(SMRequestOptions *)options
successCallbackQueue:(dispatch_queue_t)successCallbackQueue
failureCallbackQueue:(dispatch_queue_t)failureCallbackQueue
onSuccess:(SMDataStoreSuccessBlock)successBlock
onFailure:(SMDataStoreFailureBlock)failureBlock;
#pragma mark - Delete an Object
///-------------------------------
/// @name Delete an Object
///-------------------------------
/**
Delete an existing object from your StackMob Datastore.
@param theObjectId The object id (the value of the primary key field) for the object to delete.
@param schema The StackMob schema containing this object.
@param successBlock <i>typedef void (^SMDataStoreObjectIdSuccessBlock)(NSString* theObjectId, NSString *schema)</i>. A block object to invoke on the main thread after the object is successfully deleted. Passed the object id of the deleted object and the object's schema.
@param failureBlock <i>typedef void (^SMDataStoreObjectIdFailureBlock)(NSError *theError, NSString* theObjectId, NSString *schema)</i>. A block object to invoke on the main thread if the Datastore fails to read the specified object. Passed the error returned by StackMob, the object id sent with this request, and the schema in which the object was to be found.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)deleteObjectId:(NSString *)theObjectId
inSchema:(NSString *)schema
onSuccess:(SMDataStoreObjectIdSuccessBlock)successBlock
onFailure:(SMDataStoreObjectIdFailureBlock)failureBlock;
/**
Delete an existing object from your StackMob Datastore (with request options).
@param theObjectId The object id (the value of the primary key field) for the object to delete.
@param schema The StackMob schema containing this object.
@param options An options object contains headers and other configuration for this request.
@param successBlock <i>typedef void (^SMDataStoreObjectIdSuccessBlock)(NSString* theObjectId, NSString *schema)</i>. A block object to invoke on the main thread after the object is successfully deleted. Passed the object id of the deleted object and the object's schema.
@param failureBlock <i>typedef void (^SMDataStoreObjectIdFailureBlock)(NSError *theError, NSString* theObjectId, NSString *schema)</i>. A block object to invoke on the main thread if the Datastore fails to read the specified object. Passed the error returned by StackMob, the object id sent with this request, and the schema in which the object was to be found.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)deleteObjectId:(NSString *)theObjectId
inSchema:(NSString *)schema
options:(SMRequestOptions *)options
onSuccess:(SMDataStoreObjectIdSuccessBlock)successBlock
onFailure:(SMDataStoreObjectIdFailureBlock)failureBlock;
/**
Delete an existing object from your StackMob Datastore (with request options).
@param theObjectId The object id (the value of the primary key field) for the object to delete.
@param schema The StackMob schema containing this object.
@param options An options object contains headers and other configuration for this request.
@param successCallbackQueue The dispatch queue used to execute the success block. If nil is passed, the main queue is used.
@param failureCallbackQueue The dispatch queue used to execute the failure block. If nil is passed, the main queue is used.
@param successBlock <i>typedef void (^SMDataStoreObjectIdSuccessBlock)(NSString* theObjectId, NSString *schema)</i>. A block object to invoke on the successCallbackQueue after the object is successfully deleted. Passed the object id of the deleted object and the object's schema.
@param failureBlock <i>typedef void (^SMDataStoreObjectIdFailureBlock)(NSError *theError, NSString* theObjectId, NSString *schema)</i>. A block object to invoke on the failureCallbackQueue if the Datastore fails to read the specified object. Passed the error returned by StackMob, the object id sent with this request, and the schema in which the object was to be found.
@since Available in iOS SDK 1.2.0 and later.
*/
- (void)deleteObjectId:(NSString *)theObjectId
inSchema:(NSString *)schema
options:(SMRequestOptions *)options
successCallbackQueue:(dispatch_queue_t)successCallbackQueue
failureCallbackQueue:(dispatch_queue_t)failureCallbackQueue
onSuccess:(SMDataStoreObjectIdSuccessBlock)successBlock
onFailure:(SMDataStoreObjectIdFailureBlock)failureBlock;
#pragma mark - Queries
///-------------------------------
/// @name Performing Queries
///-------------------------------
/**
Execute a query against your StackMob Datastore.
@param query An `SMQuery` object describing the query to perform.
@param successBlock <i>typedef void (^SMResultsSuccessBlock)(NSArray *results)</i>. A block object to invoke on the main thread after the query succeeds. Passed an array of object dictionaries returned from StackMob (if any).
@param failureBlock <i>typedef void (^SMFailureBlock)(NSError *error)</i>. A block object to invoke on the main thread if the Datastore fails to perform the query. Passed the error returned by StackMob.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)performQuery:(SMQuery *)query onSuccess:(SMResultsSuccessBlock)successBlock onFailure:(SMFailureBlock)failureBlock;
/**
Execute a query against your StackMob Datastore (with request options).
@param query An `SMQuery` object describing the query to perform.
@param options An options object contains headers and other configuration for this request.
@param successBlock <i>typedef void (^SMResultsSuccessBlock)(NSArray *results)</i>. A block object to invoke on the main thread after the query succeeds. Passed an array of object dictionaries returned from StackMob (if any).
@param failureBlock <i>typedef void (^SMFailureBlock)(NSError *error)</i>. A block object to invoke on the main thread if the Datastore fails to perform the query. Passed the error returned by StackMob.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)performQuery:(SMQuery *)query options:(SMRequestOptions *)options onSuccess:(SMResultsSuccessBlock)successBlock onFailure:(SMFailureBlock)failureBlock;
/**
Execute a query against your StackMob Datastore (with request options).
@param query An `SMQuery` object describing the query to perform.
@param options An options object contains headers and other configuration for this request.
@param successCallbackQueue The dispatch queue used to execute the success block. If nil is passed, the main queue is used.
@param failureCallbackQueue The dispatch queue used to execute the failure block. If nil is passed, the main queue is used.
@param successBlock <i>typedef void (^SMResultsSuccessBlock)(NSArray *results)</i>. A block object to invoke on the successCallbackQueue after the query succeeds. Passed an array of object dictionaries returned from StackMob (if any).
@param failureBlock <i>typedef void (^SMFailureBlock)(NSError *error)</i>. A block object to invoke on the failureCallbackQueue if the Datastore fails to perform the query. Passed the error returned by StackMob.
@since Available in iOS SDK 1.2.0 and later.
*/
- (void)performQuery:(SMQuery *)query options:(SMRequestOptions *)options successCallbackQueue:(dispatch_queue_t)successCallbackQueue
failureCallbackQueue:(dispatch_queue_t)failureCallbackQueue onSuccess:(SMResultsSuccessBlock)successBlock onFailure:(SMFailureBlock)failureBlock;
#pragma mark - Performing Count Queries
///-------------------------------
/// @name Performing Count Queries
///-------------------------------
/**
Count the results that would be returned by a query against your StackMob Datastore.
@param query An `SMQuery` object describing the query to perform.
@param successBlock <i>typedef void (^SMCountSuccessBlock)(NSNumber *count)</i>. A block object to invoke on the main thread when the count is complete. Passed the number of objects returned that would by the query.
@param failureBlock <i>typedef void (^SMFailureBlock)(NSError *error)</i>. A block object to invoke on the main thread if the Datastore fails to perform the query. Passed the error returned by StackMob.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)performCount:(SMQuery *)query onSuccess:(SMCountSuccessBlock)successBlock onFailure:(SMFailureBlock)failureBlock;
/**
Count the results that would be returned by a query against your StackMob Datastore (with request options).
@param query An `SMQuery` object describing the query to perform.
@param options An options object contains headers and other configuration for this request.
@param successBlock <i>typedef void (^SMCountSuccessBlock)(NSNumber *count)</i>. A block object to invoke on the main thread when the count is complete. Passed the number of objects that would be returned by the query.
@param failureBlock <i>typedef void (^SMFailureBlock)(NSError *error)</i>. A block object to invoke on the main thread if the Datastore fails to perform the query. Passed the error returned by StackMob.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)performCount:(SMQuery *)query options:(SMRequestOptions *)options onSuccess:(SMCountSuccessBlock)successBlock onFailure:(SMFailureBlock)failureBlock;
/**
Count the results that would be returned by a query against your StackMob Datastore (with request options).
@param query An `SMQuery` object describing the query to perform.
@param options An options object contains headers and other configuration for this request.
@param successCallbackQueue The dispatch queue used to execute the success block. If nil is passed, the main queue is used.
@param failureCallbackQueue The dispatch queue used to execute the failure block. If nil is passed, the main queue is used.
@param successBlock <i>typedef void (^SMCountSuccessBlock)(NSNumber *count)</i>. A block object to invoke on the successCallbackQueue when the count is complete. Passed the number of objects that would be returned by the query.
@param failureBlock <i>typedef void (^SMFailureBlock)(NSError *error)</i>. A block object to on the invoke failureCallbackQueue if the Datastore fails to perform the query. Passed the error returned by StackMob.
@since Available in iOS SDK 1.2.0 and later.
*/
- (void)performCount:(SMQuery *)query options:(SMRequestOptions *)options successCallbackQueue:(dispatch_queue_t)successCallbackQueue
failureCallbackQueue:(dispatch_queue_t)failureCallbackQueue onSuccess:(SMCountSuccessBlock)successBlock onFailure:(SMFailureBlock)failureBlock;
#pragma mark - Custom Code
///-------------------------------
/// @name Performing Custom Code Methods
///-------------------------------
/**
Calls <performCustomCodeRequest:options:onSuccess:onFailure:> with `[SMRequestOptions options]` for the parameter `options`.
You can expect the **responseBody** parameter of the success callback to be in the form of:
* Serialized JSON (NSDictionary/NSArray) if the content type of the response is application/vnd.stackmob+json or application/json.
* A string (NSString) if the content type of the response is text/plain.
* Raw data (NSData) for any other response content type.
To get started writing custom code methods, check out the <a href="https://developer.stackmob.com/customcode-sdk/developer-guide" target="_blank">Custom Code Developer Guide</a>.
@param customCodeRequest The request to execute.
@param successBlock <i>typedef void (^SMFullResponseSuccessBlock)(NSURLRequest *request, NSHTTPURLResponse *response, id responseBody)</i>. A block object to call on the main thread upon success.
@param failureBlock <i>typedef void (^SMFullResponseFailureBlock)(NSURLRequest *request, NSHTTPURLResponse *response, NSError *error, id responseBody)</i>. A block object to call on the main thread upon failure.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)performCustomCodeRequest:(SMCustomCodeRequest *)customCodeRequest onSuccess:(SMFullResponseSuccessBlock)successBlock onFailure:(SMFullResponseFailureBlock)failureBlock;
/**
Execute a custom code method on StackMob.
You can expect the **responseBody** parameter of the success callback to be in the form of:
* Serialized JSON (NSDictionary/NSArray) if the content type of the response is application/vnd.stackmob+json or application/json.
* A string (NSString) if the content type of the response is text/plain.
* Raw data (NSData) for any other response content type.
To get started writing custom code methods, check out the <a href="https://developer.stackmob.com/customcode-sdk/developer-guide" target="_blank">Custom Code Developer Guide</a>.
@param customCodeRequest The request to execute.
@param options The options for this request.
@param successBlock <i>typedef void (^SMFullResponseSuccessBlock)(NSURLRequest *request, NSHTTPURLResponse *response, id responseBody)</i>. A block object to call on the main thread upon success.
@param failureBlock <i>typedef void (^SMFullResponseFailureBlock)(NSURLRequest *request, NSHTTPURLResponse *response, NSError *error, id responseBody)</i>. A block object to call on the main thread upon failure.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)performCustomCodeRequest:(SMCustomCodeRequest *)customCodeRequest options:(SMRequestOptions *)options onSuccess:(SMFullResponseSuccessBlock)successBlock onFailure:(SMFullResponseFailureBlock)failureBlock;
/**
Execute a custom code method on StackMob.
You can expect the **responseBody** parameter of the success callback to be in the form of:
* Serialized JSON (NSDictionary/NSArray) if the content type of the response is application/vnd.stackmob+json or application/json.
* A string (NSString) if the content type of the response is text/plain.
* Raw data (NSData) for any other response content type.
To get started writing custom code methods, check out the <a href="https://developer.stackmob.com/customcode-sdk/developer-guide" target="_blank">Custom Code Developer Guide</a>.
@param customCodeRequest The request to execute.
@param options The options for this request.
@param successCallbackQueue The dispatch queue used to execute the success block. If nil is passed, the main queue is used.
@param failureCallbackQueue The dispatch queue used to execute the failure block. If nil is passed, the main queue is used.
@param successBlock <i>typedef void (^SMFullResponseSuccessBlock)(NSURLRequest *request, NSHTTPURLResponse *response, id responseBody)</i>. A block object to call on the successCallbackQueue upon success.
@param failureBlock <i>typedef void (^SMFullResponseFailureBlock)(NSURLRequest *request, NSHTTPURLResponse *response, NSError *error, id responseBody)</i>. A block object to call on the failureCallbackQueue upon failure.
@since Available in iOS SDK 1.2.0 and later.
*/
- (void)performCustomCodeRequest:(SMCustomCodeRequest *)customCodeRequest options:(SMRequestOptions *)options successCallbackQueue:(dispatch_queue_t)successCallbackQueue failureCallbackQueue:(dispatch_queue_t)failureCallbackQueue onSuccess:(SMFullResponseSuccessBlock)successBlock onFailure:(SMFullResponseFailureBlock)failureBlock;
/**
Retry executing a custom code method on StackMob.
This method should only be called by developers defining their own custom code retry blocks. See <SMRequestOptions> method `addSMErrorServiceUnavailableRetryBlock:`.
@param request The request to execute.
@param options The options for this request.
@param successBlock <i>typedef void (^SMFullResponseSuccessBlock)(NSURLRequest *request, NSHTTPURLResponse *response, id responseBody)</i>. A block object to call on the main thread upon success.
@param failureBlock <i>typedef void (^SMFullResponseFailureBlock)(NSURLRequest *request, NSHTTPURLResponse *response, NSError *error, id responseBody)</i>. A block object to call on the main thread upon failure.
@since Available in iOS SDK 1.0.0 and later.
*/
- (void)retryCustomCodeRequest:(NSURLRequest *)request options:(SMRequestOptions *)options onSuccess:(SMFullResponseSuccessBlock)successBlock onFailure:(SMFullResponseFailureBlock)failureBlock;
/**
Retry executing a custom code method on StackMob.
This method should only be called by developers defining their own custom code retry blocks. See <SMRequestOptions> method `addSMErrorServiceUnavailableRetryBlock:`.
@param request The request to execute.
@param options The options for this request.
@param successCallbackQueue The dispatch queue used to execute the success block. If nil is passed, the main queue is used.
@param failureCallbackQueue The dispatch queue used to execute the failure block. If nil is passed, the main queue is used.
@param successBlock <i>typedef void (^SMFullResponseSuccessBlock)(NSURLRequest *request, NSHTTPURLResponse *response, id responseBody)</i>. A block object to call on the successCallbackQueue upon success.
@param failureBlock <i>typedef void (^SMFullResponseFailureBlock)(NSURLRequest *request, NSHTTPURLResponse *response, NSError *error, id responseBody )</i>. A block object to call on the failureCallbackQueue upon failure.
@since Available in iOS SDK 1.2.0 and later.
*/
- (void)retryCustomCodeRequest:(NSURLRequest *)request options:(SMRequestOptions *)options successCallbackQueue:(dispatch_queue_t)successCallbackQueue failureCallbackQueue:(dispatch_queue_t)failureCallbackQueue onSuccess:(SMFullResponseSuccessBlock)successBlock onFailure:(SMFullResponseFailureBlock)failureBlock;
@end