Comment on page
v2.1.1 to v2.2.0
Appfigurate app 2.2.0 is backwardly runtime compatible with apps and app extensions linked against Appfigurate library 2.1.1.
Appfigurate 2.2.0 is mostly source compatible with 2.1.1. Some minor changes are required:
- Remove the
APLConfigurationClasskey/value pair. In order to improve reliability and startup time of your app, Appfigurate Library no longer uses theAPLConfigurationClasskey/value pair to instantiate yourAPLConfigurationsubclass. Instead it calls theAPLConfigurationClassfunction that you implement (see Objective-C/Swift changes below):
- Add a new C function
APLConfigurationClassto the bottom of your APLConfiguration subclass:
Objective-C example
Class APLConfigurationClass(void) {
return [ExampleConfiguration class];
}
Swift example
@_cdecl("APLConfigurationClass")
func APLConfigurationClass() -> AnyClass {
return ExampleConfiguration.self
}
One of the key features of Appfigurate 2.2.0 is support for Swift 5.3 using property wrappers. It is relatively simple to upgrade your
APLConfiguration subclass from Objective-C to Swift:Using Appfigurate tap ≡ ‣ App ‣ Output Implementation under the SWIFT LIBRARY INTEGRATION section. The output will be similar to the following:
import Foundation
import AppfigurateLibrary
@objcMembers class Configuration: APLConfiguration {
@BoolProperty(description: "Log debug output to console", restart: false)
var debugLogging: Bool
@StringPropertyListEdit(regex: #"https://[\w\.-]+\.yourappserver.com/.*"#, description: "Application server url", restart: false, values: ["Dev":"https://dev.yourappserver.com/api", "Prod":"https://www.yourappserver.com/api"])
var serverURL: String
override func allowInvalidSignatures() -> Bool {
return !ENCRYPTED()
}
override func publicKey() -> String {
// 41 36 87 71 0D 05
return "-----BEGIN PUBLIC KEY-----\n" +
"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4TZnKfGeXttN7Rr3eiAZ\n" +
"PMEPsZvbo7lgIpMh6OjgBsoqkJJP0yXXLtpqsBCv8vm7RYqCn5+yfkiCQiXvkJBz\n" +
"FSKmLF9EPR9l1H+32Id82dDuseD70D66puPUHjciEgmU18DpW2NVvTAykMwTEsiR\n" +
"0h/ExBEhUe75qtwlVno8cMFbEfVtiGbKECvWIr122ED71T0Jt2Bcxqx1a7c1hPIV\n" +
"RwLxIfWfE0+2rB9nJVPBgsTVPywibDvjio82FousyMDmvkAbMq5iyuyvJ0+5bATz\n" +
"o12GEt5lSiQlCMzfmkWYBROMDCh27qGFVVo1XAUCVsMfsW9n4iQcoLAdUp/LI3B3\n" +
"ywIDAQAB\n" +
"-----END PUBLIC KEY-----\n"
}
override func reset() {
debugLogging = true
serverURL = "https://www.yourappserver.com/api"
}
}
@_cdecl("APLConfigurationClass")
func APLConfigurationClass() -> AnyClass {
return ExampleConfiguration.self
}
Delete the
debugLogging and serverURL properties and port your Objective-C properties across one-by-one as per the following Macros ‣ Property wrappers section below.Appfigurate's swift property wrappers are named the same as the Objective-C macros making it easy to port:
Objective-C macro | Swift property wrapper |
|---|---|
BOOL_PROPERTY | @BoolProperty |
STRING_PROPERTY_EDIT | @StringPropertyEdit |
STRING_PROPERTY_LIST | @StringPropertyList |
STRING_PROPERTY_LIST_EDIT | @StringPropertyListEdit |
ENCRYPTED_STRING_PROPERTY_LIST_EDIT | @EncryptedStringPropertyListEdit |
INT_PROPERTY_SLIDER | @IntPropertySlider |
INT_PROPERTY_EDIT | @IntPropertyEdit |
INT_PROPERTY_LIST | @IntPropertyList |
INT_PROPERTY_LIST_EDIT | @IntPropertyListEdit |
FLOAT_PROPERTY_SLIDER | @FloatPropertySlider |
FLOAT_PROPERTY_EDIT | @FloatPropertyEdit |
FLOAT_PROPERTY_LIST | @FloatPropertyList |
FLOAT_PROPERTY_LIST_EDIT | @FloatPropertyListEdit |
DOUBLE_PROPERTY_SLIDER | @DoublePropertySlider |
DOUBLE_PROPERTY_EDIT | @DoublePropertyEdit |
DOUBLE_PROPERTY_LIST | @DoublePropertyList |
DOUBLE_PROPERTY_LIST_EDIT | @DoublePropertyListEdit |
ACTION_METHOD | No Swift equivalent |
Objective-C Example
@interface Configuration : APLConfiguration
@property(nonatomic, assign) BOOL logging;
@end
@implementation Configuration
BOOL_PROPERTY(logging, @"Enable debug logging to console", NO);
...
Swift Example
@objcMembers class Configuration: APLConfiguration {
@BoolProperty(description: "Enable debug logging to console", restart: false)
var logging: Bool
...
You must either mark the entire
APLConfiguration subclass with @objcMembers (recommended approach) or mark each configuration property individually with @objc. Omitting these markers will cause the properties to be unavailable for access by Appfigurate Library.@objcMembers Example
@objcMembers class Configuration: APLConfiguration {
@BoolProperty(description: "Enable debug logging to console", restart: false)
var logging: Bool
...
@objc Example
class Configuration: APLConfiguration {
@BoolProperty(description: "Enable debug logging to console", restart: false)
@objc var logging: Bool
...
Last modified 1mo ago