Skip to content

Commit 801633e

Browse files
author
Priyanka Mistry
committed
updated to v4.2.0
1 parent 1738ceb commit 801633e

28 files changed

+635
-115
lines changed

‎BuiltIOBackend.podspec‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Pod::Spec.new do |s|
22
s.name = 'BuiltIOBackend'
3-
s.version = '4.1.0'
3+
s.version = '4.2.0'
44
s.summary = 'The BuiltIO Backend helps you to create apps quickly and effortlessly, taking care of all the backend requirements.'
55

66
s.description = <<-DESC

‎SDK/iOS/BuiltIO.framework/.DS_Store‎

-6 KB
Binary file not shown.

‎SDK/iOS/BuiltIO.framework/BuiltIO‎

311 KB
Binary file not shown.

‎SDK/iOS/BuiltIO.framework/Headers/BuiltApplication.h‎

Lines changed: 44 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
@class BuiltKeyStore;
2424
@class BuiltUserRoleMapper;
2525

26-
2726
BUILT_ASSUME_NONNULL_BEGIN
2827
/**
2928
* Represents an Application
@@ -228,6 +227,22 @@ BUILT_ASSUME_NONNULL_BEGIN
228227
*/
229228
@property (nullable, nonatomic, readonly) BuiltKeyStore *keystore;
230229

230+
/**
231+
To set extensionKey for the application.
232+
// 'blt5d4sample2633b' is a dummy Application API key
233+
234+
//Obj-C
235+
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
236+
builtApplication.extensionKey = @"new_extension";
237+
238+
//Swift
239+
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
240+
builtApplication.extensionKey = "new_extension";
241+
242+
*/
243+
@property (nonnull, nonatomic, strong) NSString *extensionKey;
244+
245+
231246
//MARK: - Initialization
232247

233248
- (instancetype)init UNAVAILABLE_ATTRIBUTE;
@@ -387,20 +402,37 @@ BUILT_ASSUME_NONNULL_BEGIN
387402
/**
388403
Represents extension in this application
389404
390-
//'blt5d4sample2633b' is a dummy Application API key
405+
//'blt5d4sample2633b' is a dummy Application API key
391406
392-
//Obj-C
393-
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
394-
BuiltExtension *extensionObject = [builtApplication extensionWithName:@"hello"];
395-
396-
//Swift
397-
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
398-
var extensionObject:BuiltExtension = builtApplication.extensionWithName("hello")
407+
//Obj-C
408+
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
409+
BuiltExtension *extensionObject = [builtApplication extension];
410+
411+
//Swift
412+
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
413+
var extensionObject:BuiltExtension = builtApplication.extension()
414+
415+
@return Returns an instance of a BuiltExtension.
416+
*/
417+
- (BuiltExtension *)extension;
418+
419+
/**
420+
Represents extension in this application
421+
422+
//'blt5d4sample2633b' is a dummy Application API key
399423
400-
@param extensionName name of extension
424+
//Obj-C
425+
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
426+
BuiltExtension *extensionObject = [builtApplication extensionWithKey:@"new_extensionKey"];
427+
428+
//Swift
429+
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
430+
var extensionObject:BuiltExtension = builtApplication.extensionWithKey("new_extensionKey")
431+
432+
@param extensionKey key of extension
401433
@return Returns an instance of a BuiltExtension.
402434
*/
403-
- (BuiltExtension *)extensionWithName:(NSString*)extensionName;
435+
- (BuiltExtension *)extensionWithKey:(NSString*)extensionKey;
404436

405437
#if !TARGET_OS_WATCH
406438
/**---------------------------------------------------------------------------------------
@@ -709,6 +741,7 @@ Gets the application variables.
709741
*/
710742
- (BUILT_NULLABLE NSString *)variableForKey:(NSString *)key;
711743

744+
712745
/**---------------------------------------------------------------------------------------
713746
* @name Application Info
714747
* ---------------------------------------------------------------------------------------

‎SDK/iOS/BuiltIO.framework/Headers/BuiltClass.h‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,23 @@ BUILT_ASSUME_NONNULL_BEGIN
1919
*/
2020
@interface BuiltClass : NSObject
2121

22+
/**
23+
To set extensionKey for the class.
24+
// 'blt5d4sample2633b' is a dummy Application API key
25+
26+
//Obj-C
27+
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
28+
BuiltClass *projectClass = [builtApplication classWithUID:@"project"];
29+
projectClass.extensionKey = @"new_extension";
30+
31+
//Swift
32+
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
33+
var projectClass:BuiltClass = builtApplication.classWithUID("project")
34+
projectClass.extensionKey = "new_extension";
35+
36+
*/
37+
@property (nonnull, nonatomic, strong) NSString *extensionKey;
38+
2239
- (instancetype)init UNAVAILABLE_ATTRIBUTE;
2340

2441
//MARK: - Headers
@@ -85,7 +102,6 @@ Removes a header from this application.
85102
*/
86103
- (void)removeHeaderForKey:(NSString *)headerKey;
87104

88-
89105
//MARK: - New Instance
90106

91107
/**---------------------------------------------------------------------------------------
@@ -214,4 +230,4 @@ Gets the schema of class asynchronously
214230

215231
@end
216232

217-
BUILT_ASSUME_NONNULL_END
233+
BUILT_ASSUME_NONNULL_END

‎SDK/iOS/BuiltIO.framework/Headers/BuiltConfig.h‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,20 @@ SSL state of Built.io Backend api server.
7878
*/
7979
@property (nonatomic, copy, readonly) NSString *url;
8080

81+
/**
82+
Returns the extensionKey in which application will point to.
83+
84+
Obj-C
85+
BuiltConfig *config = [[BuiltConfig alloc] init];
86+
config.extensionKey = @"new_extension";
87+
88+
//Swift
89+
var config:BuiltConfig = BuiltConfig()
90+
config.extensionKey = "new_extension"
91+
92+
*/
93+
@property (nonatomic, copy) NSString *extensionKey;
94+
8195
#if TARGET_OS_IOS
8296
/**---------------------------------------------------------------------------------------
8397
* @name Backend Realtime API Host

‎SDK/iOS/BuiltIO.framework/Headers/BuiltExtension.h‎

Lines changed: 151 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,36 +11,179 @@
1111

1212
BUILT_ASSUME_NONNULL_BEGIN
1313

14+
15+
typedef NS_ENUM(NSUInteger, BuiltRequestType) {
16+
BuiltRequestTypeGET,
17+
BuiltRequestTypePOST,
18+
BuiltRequestTypePUT,
19+
BuiltRequestTypeDELETE
20+
};
21+
1422
@interface BuiltExtension : NSObject
1523

16-
- (instancetype)init UNAVAILABLE_ATTRIBUTE;
24+
/**
25+
Set parameter to pass in extension call
26+
27+
//'blt5d4sample2633b' is a dummy Application API key
28+
29+
//Obj-C
30+
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
31+
BuiltExtension *extensionObject = [builtApplication extension];
32+
extensionObject.requestParams = @{@"name" : @"John"};
33+
34+
//Swift
35+
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
36+
var extensionObject:BuiltExtension = builtApplication.extension()
37+
extensionObject.requestParams = {"name" : "John"}
38+
39+
*/
40+
@property (nonatomic, strong) NSDictionary* requestParams;
41+
1742

43+
- (instancetype)init UNAVAILABLE_ATTRIBUTE;
44+
//MARK: Execute -
45+
/**---------------------------------------------------------------------------------------
46+
* @name execute
47+
* ---------------------------------------------------------------------------------------
48+
*/
1849
/**
1950
@abstract Makes a call to an extension function asynchronously.
2051
2152
//'blt5d4sample2633b' is a dummy Application API key
2253
2354
//Obj-C
2455
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
25-
BuiltExtension *extensionObject = [builtApplication extensionWithName:@"hello"];
26-
[extensionObject executeWithData:@{@"name":@"Rohit"} completion:^(BuiltResponseType responseType, id responseObject, NSError *error) {
56+
BuiltExtension *extensionObject = [builtApplication extension];
57+
[extensionObject execute:^(BuiltResponseType responseType, id responseObject, NSError *error) {
2758
2859
}];
2960
3061
//Swift
3162
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
32-
var extensionObject:BuiltExtension = builtApplication.extensionWithName("hello")
33-
extensionObject.executeWithData(["name":"Rohit"]) { (responseType, responseObject, error) -> Void in
63+
var extensionObject:BuiltExtension = builtApplication.extension()
64+
extensionObject.execute { (responseType, responseObject, error) -> Void in
3465
3566
}
3667
3768
3869
@param dataParameters any data that you want to pass to the function.
3970
@param completion this block will be called after network call if success `responseObject` will contain the response from the extension method or else nil. `error` object will contain error if any.
4071
72+
*/
73+
- (void)execute:(void (^)(BuiltResponseType responseType, id responseObject, NSError *error))completionBlock;
74+
75+
/**
76+
@abstract Makes a call to an extension function asynchronously.
77+
78+
//'blt5d4sample2633b' is a dummy Application API key
79+
80+
//Obj-C
81+
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
82+
BuiltExtension *extensionObject = [builtApplication extensionWithKey:@"new_extensionkey"];
83+
[extensionObject executeFunction:^(BuiltResponseType responseType, id responseObject, NSError *error) {
84+
85+
}];
86+
87+
//Swift
88+
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
89+
var extensionObject:BuiltExtension = builtApplication.extensionWithKey("new_extensionkey")
90+
extensionObject.executeFunction { (responseType, responseObject, error) -> Void in
91+
92+
}
93+
94+
@param completion this block will be called after network call if success `responseObject` will contain the response from the extension method or else nil. `error` object will contain error if any.
95+
96+
*/
97+
- (void)executeFunction:(void (^)(BuiltResponseType responseType, id responseObject, NSError *error))completionBlock;
98+
99+
/**
100+
@abstract set request url and request type.
101+
102+
//'blt5d4sample2633b' is a dummy Application API key
103+
104+
//Obj-C
105+
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
106+
BuiltExtension *extensionObject = [builtApplication extensionWithKey:@"new_extensionkey"];
107+
[extensionObject setRequestURL:@"v1/person" withRequestType:BuiltRequestTypeGET];
108+
109+
//Swift
110+
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
111+
var extensionObject:BuiltExtension = builtApplication.extensionWithKey("new_extensionkey")
112+
extensionObject.setRequestURL("v1/person", withRequestType:BuiltRequestTypeGET)
113+
114+
@param requestURL url to make call
115+
@param requestType requestMethod by which we are making call (GET, POST, PUT, DELETE)
116+
117+
118+
*/
119+
-(void)setRequestURL:(NSString *)url withRequestType:(BuiltRequestType) requestType;
120+
121+
122+
//MARK: Manually set headers -
123+
/**---------------------------------------------------------------------------------------
124+
* @name Manually set headers
125+
* ---------------------------------------------------------------------------------------
126+
*/
127+
/**
128+
Set a header for an application
129+
130+
//Obj-C
131+
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
132+
BuiltClass *projectClass = [builtApplication classWithUID:@"project"];
133+
BuiltQuery *projectQuery = [projectClass query];
134+
[projectQuery setHeader:@"MyHeaderValue" forKey:@"My-Custom-Header-Key"];
135+
136+
137+
//Swift
138+
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
139+
var projectClass:BuiltClass = builtApplication.classWithUID("project")
140+
var projectQuery:BuiltQuery = projectClass.query()
141+
projectQuery.setHeader("MyHeaderValue", forKey:"My-Custom-Header-Key")
142+
143+
@param headerValue The header key
144+
@param headerKey The header value
145+
*/
146+
- (void)setHeader:(NSString *)headerValue forKey:(NSString *)headerKey;
147+
148+
/**
149+
Set a header for an application
150+
151+
//Obj-C
152+
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
153+
BuiltClass *projectClass = [builtApplication classWithUID:@"project"];
154+
BuiltQuery *projectQuery = [projectClass query];
155+
[projectQuery addHeadersWithDictionary:@{@"My-Custom-Header-Key":@"MyHeaderValue"}];
156+
157+
//Swift
158+
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
159+
var projectClass:BuiltClass = builtApplication.classWithUID("project")
160+
var projectQuery:BuiltQuery = projectClass.query()
161+
projectQuery.addHeadersWithDictionary(["My-Custom-Header-Key":"MyHeaderValue"])
162+
163+
164+
@param headers The headers as dictionary which needs to be added to the application
165+
*/
166+
- (void)addHeadersWithDictionary:(NSDictionary *)headers;
167+
168+
/**
169+
Removes a header from this application.
170+
171+
//Obj-C
172+
BuiltApplication *builtApplication = [Built applicationWithAPIKey:@"blt5d4sample2633b"];
173+
BuiltClass *projectClass = [builtApplication classWithUID:@"project"];
174+
BuiltQuery *projectQuery = [projectClass query];
175+
[projectQuery removeHeaderForKey:@"My-Custom-Header-Key"];
176+
177+
//Swift
178+
var builtApplication:BuiltApplication = Built.applicationWithAPIKey("blt5d4sample2633b")
179+
var projectClass:BuiltClass = builtApplication.classWithUID("project")
180+
var projectQuery:BuiltQuery = projectClass.query()
181+
projectQuery.removeHeaderForKey("My-Custom-Header-Key")
182+
183+
184+
@param headerKey The header key that needs to be removed
41185
*/
42-
- (void)executeWithData:(BUILT_NULLABLE NSDictionary *)dataParameters
43-
completion:(void (^)(BuiltResponseType responseType, id BUILT_NULLABLE_P responseObject, NSError * BUILT_NULLABLE_P error))completionBlock;
186+
- (void)removeHeaderForKey:(NSString *)headerKey;
44187

45188
/**---------------------------------------------------------------------------------------
46189
* @name Cancel Network calls
@@ -66,4 +209,4 @@ BUILT_ASSUME_NONNULL_BEGIN
66209
- (void)cancelRequest;
67210
@end
68211

69-
BUILT_ASSUME_NONNULL_END
212+
BUILT_ASSUME_NONNULL_END

‎SDK/iOS/BuiltIO.framework/Headers/BuiltIO.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
// Copyright (c) 2013 raweng. All rights reserved.
77
//
88

9-
// sdk-version: 4.1.0
9+
// sdk-version: 4.2.0
1010

1111
#import <Foundation/Foundation.h>
1212

‎SDK/iOS/BuiltIO.framework/Headers/BuiltInstallation.h‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,6 @@ BUILT_ASSUME_NONNULL_BEGIN
171171
*/
172172
@property (nonatomic, strong) NSString *credentialsName;
173173

174-
175174
- (instancetype)init UNAVAILABLE_ATTRIBUTE;
176175

177176
//MARK: - Headers

0 commit comments

Comments
 (0)