Boolean

Bool properties must be either true or false. The default value of a Bool property is false. You can change the default value of the property by assigning a new value in an overridden reset method.

BOOL properties must be either YES or NO. The default value of a BOOL property is NO. You can change the default value of the property by assigning a new value in an overridden reset method.

BOOL properties should be declared in your APLConfiguration subclass header file as follows:

@import AppfigurateLibrary;

@interface Configuration : APLConfiguration

@property(nonatomic, assign) BOOL propertyName;
...

Local properties

Switch UI

Allows a boolean property to be changed in Appfigurate using a switch.

Swift prototype

@BoolProperty(description, restart)
var propertyName: Bool

If restart is true, then the app will be restarted if the property value changes.

Swift example

import AppfigurateLibrary

@objcMembers class Configuration: APLConfiguration {
    
    @BoolProperty(description: "Enable debug logging to console", restart: false)
    var logging: Bool
    
    override func reset() {
        logging = true
    }
    ...

Objective-C prototype

BOOL_PROPERTY(propertyName, description, restart)

If restart is YES, then the app will be restarted if the property value changes.

Objective-C example

@import AppfigurateLibrary;

@interface Configuration : APLConfiguration

@property(nonatomic, assign) BOOL logging;

@end

@implementation Configuration

BOOL_PROPERTY(logging, @"Enable debug logging to console", NO);

- (void) reset {
    self.logging = YES;
}
...

Kotlin prototype

@BooleanProperty(description, restart)
var propertyName = false

If restart is true, then the app will be restarted if the property value changes.

Kotlin example

import nz.co.electricbolt.appfiguratelibrary.Configuration
import nz.co.electricbolt.appfiguratelibrary.annotations.BooleanProperty

public class AppConfiguration : Configuration() {

    @BooleanProperty(description = "Enable debug logging to console", restart = false)
    var logging = false
    
    override fun reset() {
        logging = true
    }
    ...

Java prototype

@BooleanProperty(description, restart)
public boolean propertyName;

If restart is true, then the app will be restarted if the property value changes.

Java example

import nz.co.electricbolt.appfiguratelibrary.Configuration;
import nz.co.electricbolt.appfiguratelibrary.annotations.BooleanProperty;

public class AppConfiguration extends Configuration {

    @BooleanProperty(description = "Enable debug logging to console", restart = false)
    public boolean logging;
    
    @Override
    public void reset() {
        this.logging = true;
    }
    ...

Remote properties

Remote Switch UI

Allows a third party remote configuration provider's boolean property to be changed locally in Appfigurate using a switch. If the override tick box is ticked off, the third party remote configuration provider's value is displayed. If the override tick box is ticked on, then you can use Appfigurate to locally override the value.

Swift prototype

@RemoteBoolProperty(remoteKey, description)
var propertyName: Bool

Swift example

import AppfigurateLibrary

@objcMembers class Configuration: APLConfiguration {
    
    @RemoteBoolProperty(remoteKey: "alwaysDarkMode", description: "Force dark mode to be always set")
    var alwaysDarkMode: Bool
    
    override func reset() {
        alwaysDarkMode = false
    }
    ...

Objective-C prototype

BOOL_PROPERTY(propertyName, remoteKey, description)

Objective-C example

@import AppfigurateLibrary;

@interface Configuration : APLConfiguration

@property(nonatomic, assign) BOOL alwaysDarkMode;

@end

@implementation Configuration

BOOL_PROPERTY(alwaysDarkMode, @"alwaysDarkMode", @"Force dark mode to be always set");

- (void) reset {
    self.alwaysDarkMode = NO;
}
...

Kotlin prototype

@RemoteBooleanProperty(remoteKey, description)
var propertyName = false

Kotlin example

import nz.co.electricbolt.appfiguratelibrary.Configuration
import nz.co.electricbolt.appfiguratelibrary.annotations.RemoteBooleanProperty

public class AppConfiguration : Configuration() {

    @RemoteBooleanProperty(remoteKey = "alwaysDarkMode", description = "Force dark mode to be always set")
    var alwaysDarkMode = false
    
    override fun reset() {
        alwaysDarkMode = true
    }
    ...

Java prototype

@RemoteBooleanProperty(remoteKey, description)
public boolean propertyName;

Java example

import nz.co.electricbolt.appfiguratelibrary.Configuration;
import nz.co.electricbolt.appfiguratelibrary.annotations.RemoteBooleanProperty;

public class AppConfiguration extends Configuration {

    @RemoteBooleanProperty(remoteKey = "alwaysDarkMode", description = "Force dark mode to be always set")
    public boolean alwaysDarkMode;
    
    @Override
    public void reset() {
        this.alwaysDarkMode = true;
    }
    ...

Dart example

import 'package:appfigurateflutter/appfigurateflutter.dart';

public class Configuration extends APLNativeConfiguration {

    bool get alwaysDarkMode => nativeBool('alwaysDarkMode');
    ...

JavaScript example

import {
  NativeModules,
} from 'react-native';

const {Appfigurate} = NativeModules;

...

let alwaysDarkMode = await Appfigurate.nativeValue("alwaysDarkMode"); // true or false

PreviousSupported property types NextInteger

Last updated 3 months ago