Custom executable actions

Action UI

Allows the custom executable action to be executed by Appfigurate. Any configuration properties you modify in the action method are persisted. Actions appear below properties in the Appfigurate UI.

Objective-C

Prototype

ACTION_METHOD(actionName, description, restart) { ... }

If restart is YES then the app will be restarted after the action method is executed.

Example

@implementation Configuration

ACTION_METHOD(freshInstall, "Resets application to fresh install state", NO) {
    NSUserDefaults* defs = [NSUserDefaults standardUserDefaults];
    NSDictionary* dict = [defs dictionaryRepresentation];
    for (id key in dict) {
        [defs removeObjectForKey: key];
    }
    [defs synchronize];
}
...

Swift

Prototype

As you cannot annotate a Swift method with a property wrapper, your action methods must be specified manually.

Replace XXX with the name of your action (e.g. freshInstall)

func XXXDescription() -> String
func XXXAction()
func XXXRestart() -> Bool

If you return true from your XXXRestart() method, then the app will be restarted after the action method is executed.

Example

@objcMembers class Configuration: APLConfiguration {

    func freshInstallDescription() -> String {
        return "Resets application to fresh install state"
    }
    
    func freshInstallAction() {
        let defs = UserDefaults.standard
        let dict = defs.dictionaryRepresentation()
        for key in dict.keys {
            defs.removeObject(forKey: key)
        }
        defs.synchronize()
    }

    func freshInstallRestart() -> Bool {
        return false
    }
    ...

Java

Prototype

@ActionMethod(description, restart)

If restart is true then the app will be restarted after the action method is executed.

Example

@ActionMethod(description = "Resets application to fresh install state", restart = false)
public void freshInstall() {
    SharedPreferences preferences = context.getSharedPreferences("storage", MODE_PRIVATE);
    SharedPreferences.Editor editor = preferences.edit();
    editor.clear();
    editor.apply();
}

Kotlin

Prototype

@ActionMethod(description, restart)

If restart is true then the app will be restarted after the action method is executed.

Example

@ActionMethod(description = "Resets application to fresh install state", restart = false)
fun freshInstall() {
    var preferences = context.getSharedPreferences("storage", Context.MODE_PRIVATE)
    var editor = preferences.edit()
    editor.clear()
    editor.apply()
}

Dart

When an action is executed in the underlying native APLConfiguration (iOS) or nz.co.electricbolt.appfiguratelibrary.Configuration (Android) subclass, Flutter is also notified. Override the actionExecuted(action) method in APLNativeConfiguration as follows to receive the action:

Example

import 'package:appfigurateflutter/appfigurateflutter.dart';

class ExampleConfiguration extends APLNativeConfiguration {
  factory ExampleConfiguration() => _instance;

  static final ExampleConfiguration _instance = ExampleConfiguration._internal();

  ExampleConfiguration._internal();

  @override
  void actionExecuted(String action) {
    if (action == 'freshInstall') {
      ...
    }
  }
...

JavaScript

When an action is executed in the underlying native APLConfiguration (iOS) or nz.co.electricbolt.appfiguratelibrary.Configuration (Android) subclass, React Native is also notified. Subscribe to an event emitter to receive the action:

Example

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

const {Appfigurate} = NativeModules;
const AppfigurateEvents = new NativeEventEmitter(NativeModules.Appfigurate);

AppfigurateEvents.addListener('APLConfigurationUpdated', result => {
  if (result.APLConfigurationUpdatedAction == "freshInstall") {
    ...
  }
});