-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathStack.h
More file actions
501 lines (343 loc) · 16.7 KB
/
Stack.h
File metadata and controls
501 lines (343 loc) · 16.7 KB
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
//
// Stack.h
// Contentstack
//
// Created by Reefaq on 11/07/15.
// Copyright (c) 2015 Contentstack. All rights reserved.
//
#import <Foundation/Foundation.h>
#import <Contentstack/ContentstackDefinitions.h>
@class Config;
@class ContentType;
@class Taxonomy;
@class AssetLibrary;
@class Asset;
@class SyncStack;
@class GlobalField;
BUILT_ASSUME_NONNULL_BEGIN
@interface Stack : NSObject
/**----------------------------------------------------------------------------------------
* @name Properties
*-----------------------------------------------------------------------------------------
*/
/**
* Readonly property to check value of apikey
*/
@property (nonatomic, copy, readonly) NSString *apiKey;
/**
* Readonly property to check value of access token
*/
@property (nonatomic, copy, readonly) NSString *accessToken;
/**
* Readonly property to check value of environment provided
*/
@property (nonatomic, copy, readonly) NSString *environment;
/**
* Readonly property to check value of config provided
*/
@property (nonatomic, copy, readonly) Config *config;
/**
* Readonly property to get the current host URL for the stack.
* This value is derived from the config's host and updates automatically when the region changes.
*/
@property (nonatomic, copy, readonly) NSString *hostURL;
- (instancetype)init UNAVAILABLE_ATTRIBUTE;
//MARK: - ContentType
/**---------------------------------------------------------------------------------------
* @name ContentType
* ---------------------------------------------------------------------------------------
*/
/**
Gets the new instance of ContentType object with specified name.
//Obj-C
ContentType *contentTypeObj = [stack contentTypeWithName:@"blog"];
//Swift
var contentTypeObj:ContentType = stack.contentTypeWithName("blog")
@param contentTypeName name of the contentType to perform action.
@return instance of ContentType.
*/
- (ContentType *)contentTypeWithName:(NSString *)contentTypeName;
- (Taxonomy *)taxonomy;
- (GlobalField *)globalField;
- (GlobalField *)globalFieldWithName:(NSString *)globalFieldName;
- (NSDictionary *)getHeaders;
//MARK: - Manually set headers
/**---------------------------------------------------------------------------------------
* @name Manually set headers
* ---------------------------------------------------------------------------------------
*/
/**
Set a header for Stack
//Obj-C
[stack setHeader:@"MyValue" forKey:@"My-Custom-Header"];
//Swift
stack.setHeader("MyValue", forKey: "My-Custom-Header")
@param headerValue The header key
@param headerKey The header value
*/
- (void)setHeader:(NSString *)headerValue forKey:(NSString *)headerKey;
/**
Set a header for Stack
//Obj-C
[stack addHeadersWithDictionary:@{@"My-Custom-Header": @"MyValue"}];
//Swift
stack.addHeadersWithDictionary(["My-Custom-Header":"MyValue"])
@param headers The headers as dictionary which needs to be added to the application
*/
- (void)addHeadersWithDictionary:(NSDictionary<NSString *, NSString *> *)headers;
/**
Removes a header from this Stack.
//Obj-C
[stack removeHeaderForKey:@"My-Custom-Header"];
//Swift
stack.removeHeaderForKey("My-Custom-Header")
@param headerKey The header key that needs to be removed
*/
- (void)removeHeaderForKey:(NSString *)headerKey;
//MARK: - Asset and AssetLibrary
/**---------------------------------------------------------------------------------------
* @name Asset and AssetLibrary
* ---------------------------------------------------------------------------------------
*/
/**
Represents a Asset on 'Stack' which can be executed to get AssetLibrary object
//Obj-C
AssetLibrary *assetLib = [stack assetLibrary];
//Swift
var assetLib: AssetLibrary = stack.assetLibrary()
@return Returns new AssetLibrary instance
*/
-(AssetLibrary *)assetLibrary;
/**
Represents a Asset on 'Stack' which can be executed to get Asset object
//Obj-C
Asset *assetObj = [stack asset];
//Swift
var assetObj:Asset = stack.asset()
@return Returns new Asset instance
*/
-(Asset *)asset;
/**
Gets the new instance of Asset object with specified UID.
//Obj-C
Asset *assetObj = [contentTypeObj assetWithUID:@"ENTRY_UID"];
//Swift
var assetObj:Asset = contentTypeObj.assetWithUID("ENTRY_UID")
@param uid uid of the Asset object to fetch.
@return new instance of Asset with uid.
*/
- (Asset *)assetWithUID:(NSString *)uid;
/**
Transforms provided image url based on transformation parameters.
//Obj-C
NSDictionary *params = [[NSDictionary alloc] initWithObjectsAndKeys:[NSNumber numberWithInt:100], @"width", [NSNumber numberWithInt:100], @"height", nil];
NSString *transformedUrl = [stack imageTransformWithUrl:imageURL andParams:params];
//Swift
let params:[String : AnyObject?] = [
"width":100 as AnyObject,
"height":100 as AnyObject,
];
let transformedUrl:String = stack.imageTransformation(withUrl: imageURL, andParams: params);
@param url Url on which transformations to be applied.
@param params Transformation parameters.
@return new instance of transform url.
*/
- (NSString *)imageTransformWithUrl:(NSString *)url andParams:(NSDictionary<NSString *, id> *)params;
//MARK: - Content-Types Schema
/**---------------------------------------------------------------------------------------
* @name ContentTypes Schema
* ---------------------------------------------------------------------------------------
*/
/**
Gets all the ContentTypes and its Schema defination.
//Obj-C
[csStack getContentTypes:params completion:^(NSArray * _Nullable contentTypes, NSError * _Nullable error) {
}];
//Swift
csStack.getContentTypes(params, { (contentTypes, error) in
})
@param params params is dictionary of additional parameter
@param completionBlock block to be called once operation is done.
*/
-(void)getContentTypes:(NSDictionary<NSString *, id> * _Nullable)params completion:(void (^)(NSArray<NSString *> * BUILT_NULLABLE_P contentTypes, NSError * BUILT_NULLABLE_P error))completionBlock;
//MARK: - Sync
/**---------------------------------------------------------------------------------------
* @name Sync
* ---------------------------------------------------------------------------------------
*/
/**
The Initial Sync request performs a complete sync of your app data.
It returns all the published entries and assets of the specified stack in response.
The response also contains a sync token, which you need to store,
since this token is used to get subsequent delta updates later.
//Obj-C
[stack sync:^(SyncStack * _Nullable syncStack, NSError * _Nullable error) {
}];
//Swift
stack.sync({ ( syncStack:SyncStack, error: NSError) in
})
@param completionBlock called synchronization is done.
*/
- (void)sync:(void (^)(SyncStack * BUILT_NULLABLE_P syncStack, NSError * BUILT_NULLABLE_P error))completionBlock;
/**
If the result of the initial sync (or subsequent sync) contains more than 100 records,
the response would be paginated. It provides pagination token in the response. However,
you do not have to use the pagination token manually to get the next batch,
the SDK does that automatically until the sync is complete.
Pagination token can be used in case you want to fetch only selected batches.
It is especially useful if the sync process is interrupted midway (due to network issues, etc.).
In such cases, this token can be used to restart the sync process from where it was interrupted.
//Obj-C
NSString *token = @"PAGINATION_TOKEN"; //Pagination token
[stack syncPaginationToken:token completion:^(SyncStack * _Nullable syncStack, NSError * _Nullable error) {
}];
//Swift
var token = @"PAGINATION_TOKEN"; //Pagination token
syncPaginationToken(token, completion: { ( syncStack:SyncStack, error: NSError) in
})
@param token Pagination token from where to perform sync
@param completionBlock called synchronization is done.
*/
-(void)syncPaginationToken:(NSString *)token completion:(void (^)(SyncStack * BUILT_NULLABLE_P syncResult, NSError * BUILT_NULLABLE_P error))completionBlock;
/**
You can use the sync token (that you receive after initial sync) to get the updated content next time.
The sync token fetches only the content that was added after your last sync, and the details of the content that was deleted or updated.
//Obj-C
NSString *token = @"PAGINATION_TOKEN"; //Sync token
[stack syncToken:token completion:^(SyncStack * _Nullable syncStack, NSError * _Nullable error) {
}];
//Swift
var token = @"PAGINATION_TOKEN"; //Sync token
stack.syncToken(token, completion: { ( syncStack:SyncStack, error: NSError) in
})
@param token Sync token from where to perform sync
@param completionBlock called synchronization is done.
*/
- (void)syncToken:(NSString*)token completion:(void (^)(SyncStack * BUILT_NULLABLE_P syncStack, NSError * BUILT_NULLABLE_P error))completionBlock;
/**
You can also initialize sync with entries of only specific content types.
To do this, use sync With ContentType and specify the content type UID as its value.
However, if you do this, the subsequent syncs will only include the entries of the specified content types.
//Obj-C
NSArray *contentTypeArray = @[@"product", @"multifield"]; //Content type uids that want to sync.
[stack syncOnly:contentTypeArray completion:^(SyncStack * _Nullable syncStack, NSError * _Nullable error) {
}];
//Swift
let contentTypeArray = ["product", "multifield"]; //Content type uids that want to sync.
stack.syncOnly(contentTypeArray, completion: { ( syncStack:SyncStack, error: NSError) in
})
@param contentType uid of classes to be expected.
@param completionBlock called synchronization is done.
*/
- (void)syncOnly:(NSString*)contentType completion:(void (^)(SyncStack * BUILT_NULLABLE_P syncStack, NSError * BUILT_NULLABLE_P error))completionBlock;
/**
You can also initialize sync with entries published after a specific date. To do this, use sync Date and specify the start date as its value.
//Obj-C
NSDate *date = [NSDate date]; //date from where synchronization is called
[stack syncFrom:date completion:^(SyncStack * _Nullable syncStack, NSError * _Nullable error) {
}];
//Swift
let date = Date.date() //date from where synchronization is called
stack.syncFrom(date, completion: { ( syncStack:SyncStack, error: NSError) in
})
@param date date from where sync data is needed.
@param completionBlock called synchronization is done.
*/
- (void)syncFrom:(NSDate*)date completion:(void (^)(SyncStack * BUILT_NULLABLE_P syncStack, NSError * BUILT_NULLABLE_P error))completionBlock;
/**
Perform a synchronization operation on specified classes and from date.
//Obj-C
NSArray *contentTypeArray = @[@"product", @"multifield"]; //Content type uids that want to sync.
NSDate *date = [NSDate date]; //date from where synchronization is called
[[stack syncOnly:contentTypeArray from:date completion:^(SyncStack * _Nullable syncStack, NSError * _Nullable error) {
}];
//Swift
let date = Date.date() //date from where synchronization is called
let contentTypeArray = ["product", "multifield"]; //Content type uids that want to sync.
stack.syncOnly(contentTypeArray, from: date, completion: { ( syncStack:SyncStack, error: NSError) in
})
@param contentType uid of classes to be expected.
@param date from where sync data is needed.
@param completionBlock called synchronization is done.
*/
- (void)syncOnly:(NSString*)contentType from:(NSDate*)date completion:(void (^)(SyncStack * BUILT_NULLABLE_P syncStack, NSError * BUILT_NULLABLE_P error))completionBlock;
/**
Use the type parameter to get a specific type of content. You can pass one of the following values: 'ASSET_PUBLISHED', 'ENTRY_PUBLISHED', 'ASSET_UNPUBLISHED', 'ENTRY_UNPUBLISHED', 'ASSET_DELETED', 'ENTRY_DELETED', 'CONTENT_TYPE_DELETED'.
//Obj-C
NSDate *date = [NSDate date]; //date from where synchronization is called.
[[stack syncPublishType:ENTRY_PUBLISHED completion:^(SyncStack * _Nullable syncStack, NSError * _Nullable error) {
}];
//Swift
let date = Date.date() //date from where synchronization is called.
stack.syncPublishType:ENTRY_PUBLISHED, completion: { ( syncStack:SyncStack, error: NSError) in
})
@param publishType for which sync is needed.
@param completionBlock called synchronization is done.
*/
-(void)syncPublishType:(PublishType)publishType completion:(void (^)(SyncStack * BUILT_NULLABLE_P syncStack, NSError * BUILT_NULLABLE_P error))completionBlock;
/**
You can also initialize sync with entries of only specific locales. To do this, use sync Locale and specify the locale code as its value. However, if you do this, the subsequent syncs will only include the entries of the specified locales.
//Obj-C
[[stack syncLocale:ENGLISH_UNITED_STATES completion:^(SyncStack * _Nullable syncStack, NSError * _Nullable error) {
}];
//Swift
stack.syncLocale(ENGLISH_UNITED_STATES, completion: { ( syncStack:SyncStack, error: NSError) in
})
@param locale for which sync is needed.
@param completionBlock called synchronization is done.
*/
- (void)syncLocale:(NSString*)locale completion:(void (^)(SyncStack * BUILT_NULLABLE_P syncStack, NSError * BUILT_NULLABLE_P error))completionBlock;
/**
Perform a synchronization operation on specified locale and from date.
//Obj-C
NSDate *date = [NSDate date]; //date from where synchronization is called.
[[stack syncLocale:ENGLISH_UNITED_STATES from:date completion:^(SyncStack * Nullable syncStack, NSError * Nullable error) {
}];
//Swift
let date = Date.date() //date from where synchronization is called.
stack.syncLocale(ENGLISH_UNITED_STATES, from: date, completion: { ( syncStack:SyncStack, error: NSError) in
})
@param locale for which sync is needed.
@param date from where sync data is needed.
@param completionBlock called synchronization is done.
*/
- (void)syncLocale:(NSString*)locale from:(NSDate*)date completion:(void (^)(SyncStack * BUILT_NULLABLE_P syncStack, NSError * BUILT_NULLABLE_P error))completionBlock;
/**
Perform a synchronization operation on specified classes, locale and from date.
//Obj-C
NSArray *contentTypeArray = @[@"product", @"multifield"]; //Content type uids that want to sync.
NSDate *date = [NSDate date]; //date from where synchronization is called.
[[stack syncOnly: contentTypeArray locale:ENGLISH_UNITED_STATES from:date completion:^(SyncStack * _Nullable syncStack, NSError * _Nullable error) {
}];
//Swift
let contentTypeArray = ["product", "multifield"]; //Content type uids that want to sync.
let date = Date.date() //date from where synchronization is called.
stack.syncOnly(contentTypeArray, locale:ENGLISH_UNITED_STATES, from: date, completion: { ( syncStack:SyncStack, error: NSError) in
})
@param contentType uid of classes to be expected.
@param locale for which sync is needed.
@param date from where sync data is needed.
@param completionBlock called synchronization is done.
*/
- (void)syncOnly:(NSString*)contentType locale:(NSString*)locale from:(NSDate* BUILT_NULLABLE_P)date completion:(void (^)(SyncStack * BUILT_NULLABLE_P syncStack, NSError * BUILT_NULLABLE_P error))completionBlock;
/**
Perform a synchronization operation on specified classes, locale, date and publishType.
//Obj-C
NSArray *contentTypeArray = @[@"product", @"multifield"]; //Content type uids that want to sync.
NSDate *date = [NSDate date]; //date from where synchronization is called.
[[stack syncOnly: contentTypeArray locale:ENGLISH_UNITED_STATES from:date publishType:ENTRY_PUBLISHED completion:^(SyncStack * _Nullable syncStack, NSError * _Nullable error) {
}];
//Swift
let contentTypeArray = ["product", "multifield"]; //Content type uids that want to sync.
let date = Date.date() //date from where synchronization is called.
stack.syncOnly(contentTypeArray, locale:ENGLISH_UNITED_STATES, from: date, publishType:ENTRY_PUBLISHED, completion: { ( syncStack:SyncStack, error: NSError) in
})
@param contentType uid of classes to be expected.
@param locale for which sync is needed.
@param date from where sync data is needed.
@param publishType for which sync is needed.
@param completionBlock called synchronization is done.
*/
- (void)syncOnly:(NSString*)contentType locale:(NSString*)locale from:(NSDate* BUILT_NULLABLE_P)date publishType:(PublishType)publishType completion:(void (^)(SyncStack * BUILT_NULLABLE_P syncStack, NSError * BUILT_NULLABLE_P error))completionBlock;
@end
BUILT_ASSUME_NONNULL_END