Integrate the SDK APIs for the Automatic Configuration Update

AndroidiOS

Android

First, add the ShieldSDK-config Maven dependency to your Android project. This can be found in the SDK/maven/ directory of the App Shielding package.

You can then use the ShieldConfig class with the following methods:

The following example demonstrates how these methods can be used:

ShieldConfig.requestUpdate();
ShieldConfig.setUpdateCustomId("my-token".getBytes(StandardCharsets.UTF_8));

ShieldConfig.setUpdateCallbacks(new UpdateCallbacks() {
  @Override
  public void configUpdateReceived(String timestamp) {
    // handle callback logic
    ...
  }
});

Always call these methods from a background thread as the app's main thread is reserved for updates of the user interface, as specified by Android.

aBackgroundThread {
  ShieldConfig.requestUpdate();  
  ShieldConfig.setUpdateCallbacks();  
  ShieldConfig.setUpdateCustomId();
 }

You should be aware that the downloaded new configuration is not applied immediately, but only after an application is restarted.

iOS

First, add the ShieldSDK.xcframework bundle from the App Shielding package to your iOS project.

You can then use the ShieldConfig class with the following methods:

The following example demonstrates how these methods can be used:

[ShieldConfig requestUpdate];
[ShieldConfig setUpdateCustomId:[NSData dataWithBytes:"my-token" length:8]];

For callbacks, you can start with the ConfigUpdateCallbacks interface.

Objective-C example

@interface ConfigUpdateCallbacks : NSObject <ShieldConfigUpdateCallbacks>
@end

@implementation ConfigUpdateCallbacks
- (void)configUpdateReceived:(NSString *)timestamp
{

  // handle callback logic
  ...
}
@end

During the app initialization (e.g., in didFinishLaunchingWithOptions), call the setUpdateCallbacks method in the following manner:

[ShieldConfig setUpdateCallbacks:[[ConfigUpdateCallbacks alloc] init]];

Swift example

If you are using Swift instead of Objective-C, you can set up the callback as follows:

class ConfigUpdateCallbacks: NSObject, ShieldConfigUpdateCallbacks {
  func configUpdateReceived(_ timestamp: String) {
    // handle callback logic
    ...
  }
}
...
ShieldConfig.setUpdateCallbacks(ConfigUpdateCallbacks())

You should be aware that the downloaded new configuration is not applied immediately, but only after an application is restarted.

You should be aware that the downloaded new configuration is not applied immediately, but only after an application is restarted.