BuiltConfig Class Reference

Inherits from NSObject
Declared in BuiltConfig.h

Backend API Host

  host

Host name of Built.io Backend api server.

@property (nonatomic, copy) NSString *host

Discussion

//Obj-C
 BuiltConfig *config = [[BuiltConfig alloc] init];
 config.host = @"api.built.io";

//Swift
 var config:BuiltConfig = BuiltConfig()
 config.host = "api.built.io"

Declared In

BuiltConfig.h

  isSSL

SSL state of Built.io Backend api server.

@property (nonatomic, assign) BOOL isSSL

Discussion

 //Obj-C
 BuiltConfig *config = [[BuiltConfig alloc] init];
 config.isSSL = YES;

 //Swift
 var config:BuiltConfig = BuiltConfig()
 config.isSSL = true

Declared In

BuiltConfig.h

  version

API version of Built.io Backend api server.

@property (nonatomic, copy) NSString *version

Discussion

 //Obj-C
 BuiltConfig *config = [[BuiltConfig alloc] init];
 config.version = @"v2";

 //Swift
 var config:BuiltConfig = BuiltConfig()
 config.isSSL = "v2"

Declared In

BuiltConfig.h

  url

Returns the URL in which application will point to. (Deprecated: Please use BuiltConfig instead.)

@property (nonatomic, copy, readonly) NSString *url

Discussion

Warning: This property is readonly i.e you can just read the value but can’t set its value

 //Obj-C
 NSString *URLString = config.url;

 //Swift
 var URLString:NSString = config.url

Declared In

BuiltConfig.h

  extensionKey

Returns the extensionKey in which application will point to.

@property (nonatomic, copy) NSString *extensionKey

Discussion

Obj-C BuiltConfig *config = [[BuiltConfig alloc] init]; config.extensionKey = @“new_extension”;

//Swift var config:BuiltConfig = BuiltConfig() config.extensionKey = “new_extension”

Declared In

BuiltConfig.h

Backend Realtime API Host

  realtimeHost

Realtime host name of Built.io Backend api server.

@property (nonatomic, copy) NSString *realtimeHost

Discussion

 //Obj-C
 BuiltConfig *config = [[BuiltConfig alloc] init];
 config.realtimeHost = @"realtime.built.io";

 //Swift
 var config:BuiltConfig = BuiltConfig()
 config.realtimeHost = "realtime.built.io"

Warning: Not supported in watchOS

Declared In

BuiltConfig.h

  realtimePort

Realtime port number of Built.io Backend api server.

@property (nonatomic, assign) NSInteger realtimePort

Discussion

 //Obj-C
 BuiltConfig *config = [[BuiltConfig alloc] init];
 config.realtimePort = 443;

 //Swift
 var config:BuiltConfig = BuiltConfig()
 config.realtimePort = 443

Warning: Not supported in watchOS

Declared In

BuiltConfig.h

  realtimeSSL

Realtime SSL state of Built.io Backend api server.

@property (nonatomic, assign) BOOL realtimeSSL

Discussion

 //Obj-C
 BuiltConfig *config = [[BuiltConfig alloc] init];
 config.realtimeSSL = YES;

 //Swift
 var config:BuiltConfig = BuiltConfig()
 config.realtimeSSL = true

Warning: Not supported in watchOS

Declared In

BuiltConfig.h

Usermetrics

  enableUserMetrics

Enable UserMetrics for application

@property (nonatomic, assign, getter=isUserMetricsEnabled) BOOL enableUserMetrics

Discussion

 //Obj-C
 BuiltConfig *config = [[BuiltConfig alloc] init];
 config.enableUserMetrics = YES;

 //Swift
 var config:BuiltConfig = BuiltConfig()
 config.enableUserMetrics = true

Declared In

BuiltConfig.h

Offline

  offline

Enable offline mode for application. When enabled, it will save and mantain all records from application Sync, BuiltQuery and save operation of BuiltObject to offline DB.

@property (nonatomic, assign, getter=isOffline) BOOL offline

Discussion

 //Obj-C
 BuiltConfig *config = [[BuiltConfig alloc] init];
 config.offline = YES;

 //Swift
 var config:BuiltConfig = BuiltConfig()
 config.offline = true

Warning: Not supported in watchOS

Declared In

BuiltConfig.h

Persist refresh token

  persistRefreshToken

Sets whether the refresh token is to persist or not in user session

@property (nonatomic, assign, getter=isPersistRefreshTokenEnabled) BOOL persistRefreshToken

Discussion

//Obj-C
BuiltConfig *config = [[BuiltConfig alloc] init];
config.persistRefreshToken = NO;

//Swift
var config:BuiltConfig = BuiltConfig()
config.persistRefreshToken = false

Declared In

BuiltConfig.h