foundation/com.sap.cloud.mobile.foundation.mobileservices/ApplicationState

ApplicationState

ApplicationState is intended to be used in MobileService.onStateChange method (possibly in when clause). To make its usage consistent, make all the subclasses data class, even SettingsParameterReady and HTTPClientReady may not need the ready parameter. Sample code: when (state) { is ApplicationState.HTTPClientReady -> httpClientReady = state.ready is ApplicationState.AuthenticationChange -> authenticated = state.authenticated ... }

Inheritors

SettingsParameterReady

ClientPolicyRetrieved

Types

ApplicationInactive

data class ApplicationInactive(val activeVersions: String?) : ApplicationState

Represents the state when application version is inactive.

ApplicationLock

data class ApplicationLock(val locked: Boolean) : ApplicationState

Represents the application lock status, when put into background and timeout, the app is in 'locked' state, when unlocked with the passcode or biometric credentials, the app is in 'unlocked' state.

AuthenticationChange

data class AuthenticationChange(val authenticated: Boolean) : ApplicationState

Represents the state that a session is successfully established with the server, it will be notified out during both onboarding and restore flows.

ClientPolicyRetrieved

data class ClientPolicyRetrieved(val policy: ClientPolicies) : ApplicationState

Represents the state that the client policy is retrieved from the server side.

CustomTabsVisibility

data class CustomTabsVisibility(val visible: Boolean) : ApplicationState

The CustomTabs visibility state.

HostTokenRenewed

data class HostTokenRenewed(val token: OAuth2Token) : ApplicationState

Host app token renewed.

HTTPClientReady

data class HTTPClientReady(val ready: Boolean = true) : ApplicationState

Represents the state when 'okHttpClient' is set into 'ClientProvider', it will only notified once

NetworkState

data class NetworkState(val isNetworkAvailable: Boolean) : ApplicationState

Represents the current network state, either network is available, or not

OnFrontChange

data class OnFrontChange(val onFront: Boolean) : ApplicationState

Represents the state that the app is brought up to the foreground or put into the background

OnUserSwitch

data class OnUserSwitch(val newUser: DeviceUser, val oldUser: DeviceUser?) : ApplicationState

Represents the state when user switching happened. This will be used in a multiple user mode app

SettingsParameterReady

data class SettingsParameterReady(val ready: Boolean = true) : ApplicationState

Represents the state when 'SettingsParameter' is set into 'SettingsProvider'.