Using the Android Renderer
Android project requirements
System requirements:
- minSdk = 26
- compileSdk = 34
The SDK library was build using:
- Android Gradle Plugin 8.1.1
- Kotlin 1.9.10
Installing the library
- Add the maven repository in your project's
settings.gradle.kts
file:
dependencyResolutionManagement {
...
repositories {
...
maven {
url = uri("https://nexus-jx.dev.rd.flowx.ai/repository/flowx-maven-releases/")
credentials {
username = "your_username"
password = "your_password"
}
}
}
}
- Add the library as a dependency in your
app/build.gradle.kts
file:
dependencies {
...
implementation("ai.flowx.android:android-sdk:2.2.1")
...
}
Library dependencies
Impactful dependencies:
- Koin 3.2.2, including the implementation for Koin Context Isolation
- Compose BOM 2023.09.01 + Compose Compiler 1.5.3
- Accompanist 0.32.0
- Kotlin Coroutines 1.7.3
- OkHttp BOM 4.11.0
- Retrofit 2.9.0
- Coil Image Library 2.3.0
- Gson 2.10.1
Public API
The SDK library is managed through the FlowxSdkApi
singleton instance, which exposes the following methods:
Name | Description | Definition |
---|---|---|
init | Initializes the FlowX SDK. Must be called in your application's onCreate() | fun init(context: Context, config: SdkConfig, customComponentsProvider: CustomComponentsProvider? = null) |
checkRendererCompatibility | Checks the renderer version compatibility with the deployed services | suspend fun checkRendererCompatibility(action: ((Boolean) -> Unit)?) |
startProcess | Starts a FlowX process instance, by returning a @Composable function where the process is rendered. | fun startProcess(processName: String, accessToken: String, params: JSONObject = JSONObject(), isModal: Boolean = false, closeModalFunc: ((processName: String) -> Unit)? = null): @Composable () -> Unit |
continueProcess | Continues an existing FlowX process instance, by returning a @Composable function where the process is rendered. | fun continueProcess(processUuid: String, accessToken: String, isModal: Boolean = false, closeModalFunc: ((processName: String) -> Unit)? = null): @Composable () -> Unit |
executeAction | Runs an action from a custom component | fun executeAction(action: CustomComponentAction, params: JSONObject? = null) |
getMediaResourceUrl | Extracts a media item URL needed to populate the UI of a custom component | fun getMediaResourceUrl(key: String): String? |
replaceSubstitutionTag | Extracts a substitution tag value needed to populate the UI of a custom component | fun replaceSubstitutionTag(key: String): String |
updateAccessToken | Updates the access token inside the renderer | fun updateAccessToken(token: String) |
Configuring the library
To configure it, call this method in your project's application class onCreate()
method:
fun init(
context: Context,
config: SdkConfig,
customComponentsProvider: CustomComponentsProvider? = null,
)
Its params are explained below:
Name | Description | Type | Requirement |
---|---|---|---|
context | Android application Context | Context | Mandatory |
config | SDK configuration parameters | ai.flowx.android.sdk.process.model.SdkConfig | Mandatory |
customComponentsProvider | Provider for the @Composable /View custom components | ai.flowx.android.sdk.component.custom.customComponentsProvider? | Optional. Defaults to null . |
The custom components
implementation is explained in its own section.
Sample
class MyApplication : Application() {
override fun onCreate() {
super.onCreate()
initFlowXSdk()
}
private fun initFlowXSdk() {
FlowxSdkApi.getInstance().init(
context = applicationContext,
config = SdkConfig(
baseUrl = "URL to FlowX backend",
imageBaseUrl = "URL to FlowX CMS Media Library",
language = "en",
validators = mapOf("exact_25_in_length" to { it.length == 25 }),
themeTokensJsonFileAssetsPath = "theme/tokens.json",
themeComponentsJsonFileAssetsPath = "theme/components.json"
),
customComponentsProvider = object : CustomComponentsProvider {...},
)
}
}
The configuration properties that should be passed as SdkConfig
data for the config
parameter above are:
Name | Description | Type | Requirement |
---|---|---|---|
baseUrl | URL to connect to the FlowX back-end environment | String | Mandatory |
imageBaseUrl | URL to connect to the FlowX Media Library module of the CMS | String | Mandatory |
language | The language used for retrieving enumerations and substitution tags | String | Optional. Defaults to en . |
validators | Custom validators for form elements | Map<String, (String) -> Boolean>? | Optional. |
themeTokensJsonFileAssetsPath | Android assets relative path to the theme tokens json file | String? | Optional. When null , internal theme will be used. |
themeComponentsJsonFileAssetsPath | Android assets relative path to the theme components json file | String? | Optional. When null , internal theme will be used. |
Custom validators
The custom validators
map is a collection of lambda functions, referenced by name (i.e. the value of the key
in this map), each returning a Boolean
based on the String
which needs to be validated.
For a custom validator to be evaluated for a form field, its name must be specified in the form field process definition.
By looking at the example from above - mapOf("exact_25_in_length" to { it.length == 25 })
- if a form element should be validated using this lambda function, in the process definition it must specifiy a custom validator named "exact_25_in_length"
.
Theming
To override the renderer's internal theme, the themeTokensJsonFileAssetsPath
and themeComponentsJsonFileAssetsPath
parameters should contain some values, representing Android assets relative paths to the corresponding JSON file for tokens and components.
For example, their values could look like in the example from above:
themeTokensJsonFileAssetsPath = "theme/tokens.json",
themeComponentsJsonFileAssetsPath = "theme/components.json"
For each case, this translates to file://android_asset/...
, where ...
is the relative path within your project's assets/
directory.
Using the library
Check renderer compatibility
To check the renderers compatibility with the FlowX deployed services, use the suspend
function checkRendererCompatibility
:
suspend fun checkRendererCompatibility(action: ((Boolean) -> Unit)?)
where the action lambda parameter is where you should put your own logic when compatible or not.
Sample
CoroutineScope(Dispatchers.IO).launch {
FlowxSdkApi.getInstance().checkRendererCompatibility {
when (it) {
true -> { /* compatible */ }
false -> { /* NOT compatible */ }
}
}
}
Start a FlowX process
To start a new instance of a FlowX process, use the startProcess
function:
fun startProcess(
processName: String,
accessToken: String,
params: JSONObject = JSONObject(),
isModal: Boolean = false,
closeModalFunc: ((processName: String) -> Unit)? = null,
): @Composable () -> Unit
Parameters
Parameter | Description | Type | Requirement |
---|---|---|---|
processName | The name of the process | String | Mandatory |
accessToken | The access token which allows access to the FlowX backend services | String | Mandatory |
params | The starting params for the process, if any | JSONObject | Optional. If omitted, if defaults to JSONObject() |
isModal | Flag indicating whether the process can be closed at anytime by tapping the top-right close button | Boolean | Optional. It defaults to false . |
closeModalFunc | Lambda function where you should handle closing the process when isModal flag is true | ((processName: String) -> Unit)? | Optional. It defaults to null . |
This returned @Composable function must be included in its own activity, which is part of (controlled and maintained by) the container application.
This wrapper activity must display only the @Composable
returned from the SDK (i.e. it occupies the whole activity screen space).
Sample
class ProcessActivity : ComponentActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
...
setContent {
FlowxSdkApi.getInstance().startProcess(
processName = "your process name",
accessToken = "your access token",
params: JSONObject = JSONObject(),
isModal = true,
closeModalFunc = { processName ->
// NOTE: possible handling could involve doing something differently based on the `processName` value
},
).invoke()
}
}
...
}
Resume a FlowX process
To resume an existing instance of a FlowX process, use the continueProcess
function:
fun continueProcess(
processUuid: String,
accessToken: String,
isModal: Boolean = false,
closeModalFunc: ((processName: String) -> Unit)? = null,
): @Composable () -> Unit
Parameters
Parameter | Description | Type | Requirement |
---|---|---|---|
processUuid | The UUID string of the process | String | Mandatory |
accessToken | The access token which allows access to the FlowX backend services | String | Mandatory |
isModal | Flag indicating whether the process can be closed at anytime by tapping the top-right close button | Boolean | Optional. It defaults to false . |
closeModalFunc | Lambda function where you should handle closing the process when isModal flag is true | ((processName: String) -> Unit)? | Optional. It defaults to null . |
This returned @Composable function must be included in its own activity, which is part of (controlled and maintained by) the container application.
This wrapper activity must display only the @Composable
returned from the SDK (i.e. it occupies the whole activity screen space).
Sample
class ProcessActivity : ComponentActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
...
setContent {
FlowxSdkApi.getInstance().continueProcess(
processUuid = "your process UUID string",
accessToken = "your access token",
isModal = true,
closeModalFunc = { processName ->
// NOTE: possible handling could involve doing something differently based on the `processName` value
},
).invoke()
}
}
...
}
Handling authorization token changes
When the access token changes, in can be updated in the renderer using the updateAccessToken
method:
fun updateAccessToken(token: String)
Custom components
The container application should decide which custom component view to provide using the componentIdentifier
configured in the UI designer.
A custom component receives data to populate the view and actions to execute, as described below.
To handle custom components, an implementation of the CustomComponentsProvider
interface should be passed as a parameter when initializing the SDK:
interface CustomComponentsProvider {
fun provideCustomComposableComponent(): CustomComposableComponent?
fun provideCustomViewComponent(): CustomViewComponent?
}
There are two methods to provide a custom component:
- by implementing the CustomComposableComponent interface
- by implementing the CustomViewComponent interface
Sample
class CustomComponentsProviderImpl : CustomComponentsProvider {
override fun provideCustomComposableComponent(): CustomComposableComponent? {
return object : CustomComposableComponent {...}
}
override fun provideCustomViewComponent(): CustomViewComponent? {
return object : CustomViewComponent {...}
}
}
CustomComposableComponent
To provide the custom component as a @Composable function, you have to implement the CustomComposableComponent
interface:
interface CustomComposableComponent {
fun provideCustomComposable(componentIdentifier: String): CustomComposable
}
The returned CustomComposable
object is an interface defined like this:
interface CustomComposable {
// `true` for the custom components that are implemented and can be handled
// `false` otherwise
val isDefined: Boolean
// `@Composable` definitions for the custom components that can be handled
val composable: @Composable () -> Unit
/**
* Called when the data is available for the custom component
* (i.e. when the User Task that contains the custom component is displayed)
*
* @param data used to populate the custom component
*/
fun populateUi(data: JSONObject)
/**
* Called when the actions are available for the custom component
* (i.e. when the User Task that contains the custom component is displayed)
*
* @param actions that need to be attached to the custom component (e.g. onClick events)
*/
fun populateUi(actions: Map<String, CustomComponentAction>)
}
Sample
override fun provideCustomComposableComponent(): CustomComposableComponent? {
return object : CustomComposableComponent {
override fun provideCustomComposable(componentIdentifier: String) = object : CustomComposable {
override val isDefined: Boolean = when (componentIdentifier) {
"some custom component identifier" -> true
"other custom component identifier" -> true
else -> false
}
override val composable: @Composable () -> Unit = {
when (componentIdentifier) {
"some custom component identifier" -> { /* add some @Composable implementation */ }
"other custom component identifier" -> { /* add other @Composable implementation */ }
}
}
override fun populateUi(data: JSONObject) {
// extract the necessary data to be used for displaying the custom components
}
override fun populateUi(actions: Map<String, CustomComponentAction>) {
// extract the available actions that may be executed from the custom components
}
}
}
}
CustomViewComponent
To provide the custom component as a classical Android View function, you have to implement the CustomViewComponent
interface:
interface CustomViewComponent {
fun provideCustomView(componentIdentifier: String): CustomView
}
The returned CustomView
object is an interface defined like this:
interface CustomView {
// `true` for the custom components that are implemented and can be handled
// `false` otherwise
val isDefined: Boolean
/**
* returns the `View`s for the custom components that can be handled
*/
fun getView(context: Context): View
/**
* Called when the data is available for the custom component
* (i.e. when the User Task that contains the custom component is displayed)
*
* @param data used to populate the custom component
*/
fun populateUi(data: JSONObject)
/**
* Called when the actions are available for the custom component
* (i.e. when the User Task that contains the custom component is displayed)
*
* @param actions that need to be attached to the custom component (e.g. onClick events)
*/
fun populateUi(actions: Map<String, CustomComponentAction>)
}
Sample
override fun provideCustomViewComponent(): CustomViewComponent? {
return object : CustomViewComponent {
override fun provideCustomView(componentIdentifier: String) = object : CustomView {
override val isDefined: Boolean = when (componentIdentifier) {
"some custom component identifier" -> true
"other custom component identifier" -> true
else -> false
}
override fun getView(context: Context): View {
return when (componentIdentifier) {
"some custom component identifier" -> { /* return some View */ }
"other custom component identifier" -> { /* return other View */ }
}
}
override fun populateUi(data: JSONObject) {
// extract the necessary data to be used for displaying the custom components
}
override fun populateUi(actions: Map<String, CustomComponentAction>) {
// extract the available actions that may be executed from the custom components
}
}
}
}
Execute action
The custom components which the container app provides will contain FlowX actions to be executed.
In order to run an action you need to call the executeAction
method:
fun executeAction(action: CustomComponentAction, params: JSONObject? = null)
Parameters
Name | Description | Type | Requirement |
---|---|---|---|
action | Action object extracted from the data received in the custom component | ai.flowx.android.sdk.component.custom.CustomComponentAction | Mandatory |
params | Parameters needed to execute the action | JSONObject? | Optional. It defaults to null |
Get a substitution tag value by key
fun replaceSubstitutionTag(key: String): String
All substitution tags will be retrieved by the SDK before starting the first process and will be stored in memory.
Whenever the container app needs a substitution tag value for populating the UI of the custom components, it can request the substitution tag using the method above, by providing the key
.
It returns:
- the key's counterpart, if the
key
is valid and found - the empty string, if the
key
is valid, but not found - the unaltered string, if the key has the wrong format (i.e. not starting with
@@
)
Get a media item url by key
fun getMediaResourceUrl(key: String): String?
All media items will be retrieved by the SDK before starting the first process and will be stored in memory.
Whenever the container app needs a media item url for populating the UI of the custom components, it can request the url using the method above, by providing the key
.
It returns the URL
string of the media resource, or null
, if not found.
Known issues
- shadows are rendering only on Android >= 28 having hardware acceleration enabled