SalesforceSDK/com.salesforce.androidsdk.ui/LoginViewModel

LoginViewModel

open class LoginViewModel(val bootConfig: BootConfig, backgroundContext: CoroutineContext = IO) : ViewModel

View model for the login activity managing OAuth authorization URL generation, server selection, and authentication flow state.

Parameters

bootConfig

The boot configuration providing default OAuth client credentials, redirect URI, and scopes

backgroundContext

The coroutine context used for background work such as OAuth configuration resolution and URL generation. This parameter is intended for testing purposes only. Defaults to IO

Constructors

LoginViewModel

constructor(bootConfig: BootConfig, backgroundContext: CoroutineContext = IO)

Types

BottomBarButton

data class BottomBarButton(val title: String, val onClick: () -> Unit)

Models an additional bottom bar button the login view can display.

Companion

object Companion

LoginUrlSource

@VisibleForTesting

inner class LoginUrlSource(viewModel: LoginViewModel = this@LoginViewModel, scope: CoroutineScope = viewModelScope) : Observer<String?>

An observer used to set the web view's OAuth authorization URL from the selected login server.

PendingServerSource

@VisibleForTesting

inner class PendingServerSource(viewModel: LoginViewModel = this@LoginViewModel) : Observer<LoginServerManager.LoginServer>

An observer used to set the pending login server from the login server manager's selected login server.

Properties

additionalParameters

open var additionalParameters: <Error class: unknown class>

Additional Auth Values used for login.

bootConfig

val bootConfig: BootConfig

bottomAppBar

open val bottomAppBar: @Composable () -> Unit? = null

BottomAppBar that will be used instead of the default.

browserCustomTabUrl

val browserCustomTabUrl: MediatorLiveData<String>

The selected login server's OAuth authorization URL for use in the external browser custom tab when browser-based authentication is active. This provides the login flow with the requirements for advanced authentication, such as client certificates.

customBottomBarButton

open val customBottomBarButton: MutableState<LoginViewModel.BottomBarButton?>

A custom button to display on the login view bottom app bar.

frontDoorBridgeUrl

val frontDoorBridgeUrl: MediatorLiveData<String?>

The Salesforce Identity API UI Bridge front door bridge URL for use in the web view when overriding the standard login URL

var loading: MutableState<Boolean>

loadingIndicator

open val loadingIndicator: @Composable () -> Unit? = null

Loading Indicator

loginUrl

val loginUrl: MediatorLiveData<String>

The selected login server's OAuth authorization URL for use in the web view when browser-based authentication is inactive

selectedServer

val selectedServer: MediatorLiveData<String>

The login server that has been selected by the login server manager, has an authentication configuration and is ready for use

shouldShowBackButton

open val shouldShowBackButton: <Error class: unknown class>

Value representing if the back button should be shown on the login view.

showServerPicker

var showServerPicker: MutableState<Boolean>

singleServerCustomTabActivity

open val singleServerCustomTabActivity: Boolean = false

Setting this option to true will enable a mode where only a custom tab will be shown. The first server will be launched in a custom tab immediately and the user will not be able to switch servers. The LoginActivity is ended if the user attempts to back out of the custom tab.

titleText

open var titleText: String?

TopAppBar text. Defaults to login server url.

titleTextColor

open var titleTextColor: Color?

TopAppBar text Color. Defaults to black on light backgrounds and white on dark backgrounds. Back and menu buttons will match this color.

topAppBar