Android SDK

Android SDK migration guide

SDK API changes

Config

The Config interface used when initializing the SDK now requires a new, mandatory, property, named organizationId (the ID of the organization used to identify your installation):

diff 5.1.x LTS..5.9.x version

Flowx.getInstance().init(
    ...
    config = object : Config {
        override val organizationId: String = "organization id"
        override val baseUrl = "URL to FlowX backend",
        override val imageBaseUrl = "URL to FlowX CMS Media Library",
        override val enginePath = "some_path",
        override val language = "en",
        override val locale = Locale.getDefault(),
        override val validators: Map<String, (String) -> Boolean>? = mapOf("exact_25_in_length" to { it.length == 25 }),
        override val logEnabled: Boolean get() = 0 != applicationInfo.flags and ApplicationInfo.FLAG_DEBUGGABLE,
    },
    ...
)

Custom loaders

The CustomLoaderProvider interface has been changed from:

5.1.x LTS version

interface CustomLoaderProvider {
    fun provideCustomLoader(actionName: String?): CustomLoader?
}

5.9.x version

interface CustomLoaderProvider {
    fun provideCustomLoader(loaderType: CustomLoaderProvider.LoaderType?): CustomLoader?
}

where the CustomLoaderProvider.LoaderType is defined like this:

interface LoaderType {
    interface StartProcess : LoaderType
    interface ReloadProcess : LoaderType
    interface Action : LoaderType { val name: String }
    interface Upload : LoaderType { val name: String }
}

The available types for the loaderType parameter are:

LoaderType.StartProcess - received for overriding the loader displayed when starting a new process
LoaderType.ReloadProcess - received for overriding the loader displayed when resuming an existing process
LoaderType.Action - received for overriding the loader displayed while the action having the name name is executed
LoaderType.Upload - received for overriding the loader displayed while the upload action having the name name is executed

The name property received for the LoaderType.Action and LoaderType.Upload types represents the name of an action, as defined at process definition time, received for being able to override the loader displayed while that action is executed.

Returning an implementation of a CustomLoader replaces the built-in platform loader with the provided one for the specified use cases.

Returning null keeps the built-in platform loader for the specified use cases.

Android SDK reference

Android renderer SDK documentation

Migration overview

Return to the 5.1 LTS → 5.9 LTS migration hub

​Android SDK migration guide

​SDK API changes

​Config

​Custom loaders

​Related resources

Android SDK reference

Migration overview

Android SDK migration guide

SDK API changes

Config

Custom loaders

Related resources