SalesforceSDK/com.salesforce.androidsdk.ui/LoginActivity/Companion

Companion

object Companion

Types

Link copied to clipboard
data class SimulatedDiscoveryResult(val loginHint: String, val loginHost: String)

The result of a simulated Welcome Discovery flow. Holds the values that the real sfdc://discocallback?login_hint=&my_domain= URL would have provided. Set on SalesforceSDKManager.simulatedDiscoveryResult from the Login Options screen to bypass the email round-trip during automated tests.

Link copied to clipboard
data class UiBridgeApiParameters(val frontdoorBridgeUrl: String, val pkceCodeVerifier: String?)

A data class representing Salesforce Identity API UI Bridge parameters.

Properties

Link copied to clipboard
const val EXTRA_KEY_FRONTDOOR_BRIDGE_URL: String

Extras key for the Salesforce Identity API UI Bridge front door URL

Link copied to clipboard
const val EXTRA_KEY_LOGIN_HINT: String

Intent extra key for Salesforce Welcome login username hint value

Link copied to clipboard
const val EXTRA_KEY_LOGIN_HOST: String

Intent extra key for Salesforce Welcome login host to use with login hint

Link copied to clipboard
const val EXTRA_KEY_PKCE_CODE_VERIFIER: String

Extras key for the Salesforce Identity API UI PKCE code verifier

Link copied to clipboard
var qrCodeLoginUrlJsonFrontdoorBridgeUrlKey: String

For QR code login URLs, the Salesforce Identity API UI Bridge parameters JSON key for the frontdoor URL.

Link copied to clipboard
var qrCodeLoginUrlJsonParameterName: String

For QR code login URLs, the URL query string parameter name for the Salesforce Identity API UI Bridge parameters JSON object.

Link copied to clipboard
var qrCodeLoginUrlJsonPkceCodeVerifierKey: String

For QR code login URLs, the Salesforce Identity API UI Bridge parameters JSON key for the PKCE code verifier, which is only used when the front door URL was generated for the web server authorization flow. The user agent flow does not require a value for this parameter.

Link copied to clipboard
var qrCodeLoginUrlPath: String

For QR code login URLs, the URL path which distinguishes them from other URLs provided by the app's internal QR code reader or deep link intents from external QR code readers.

@VisibleForTesting
const val SALESFORCE_WELCOME_DISCOVERY_MOBILE_URL_QUERY_PARAMETER_KEY_CALLBACK_URL: String

The Salesforce Welcome Discovery mobile URL's callback URL query string parameter name

@VisibleForTesting
const val SALESFORCE_WELCOME_DISCOVERY_MOBILE_URL_QUERY_PARAMETER_KEY_CLIENT_ID: String

The Salesforce Welcome Discovery mobile URL's client id (consumer key) query string parameter name

@VisibleForTesting
const val SALESFORCE_WELCOME_DISCOVERY_MOBILE_URL_QUERY_PARAMETER_KEY_CLIENT_VERSION: String

The Salesforce Welcome Discovery mobile URL's client version query string parameter name

Link copied to clipboard
@VisibleForTesting
const val SALESFORCE_WELCOME_DISCOVERY_URL_PATH: String

The URL path used by Salesforce Welcome Discovery URLs

Functions

Link copied to clipboard
fun isQrCodeLoginUrlIntent(intent: Intent): Boolean

Determines if the provided intent has QR code login parameters.

Link copied to clipboard
fun isSalesforceWelcomeDiscoveryMobileUrl(uri: Uri): Boolean
fun isSalesforceWelcomeDiscoveryMobileUrl(context: Context, uri: Uri): <Error class: unknown class>

Determines if the provided URL has the Salesforce Welcome Discovery path and parameters for mobile callback. The client id (consumer key) of the URL must match the boot config's consumer key.

Link copied to clipboard
fun isSalesforceWelcomeDiscoveryUrlPath(uri: Uri): Boolean

Determines if the provided URL has the Salesforce Welcome Discovery path.

Link copied to clipboard
fun uiBridgeApiParametersFromQrCodeLoginUrl(qrCodeLoginUrl: String?): <Error class: unknown class>

Parses Salesforce Identity API UI Bridge parameters from the provided login QR code login URL.