Options

@JvmOverloads()
fun Options(scope: String? = null, forcesWebView: Boolean = false)
Content copied to clipboard

Basic constructor for standard options.

The scope option key is a standard OAuth2 option and can be passed to all OAuth2 providers.

The forcesWebView option is not passed to the OAuth2 provider, it only selects which web browser will display the OAuth2 provider authentication endpoint on the device: false uses a "Chrome-tab" embedded within the phone (if available), it's the most secure, while false uses an Android WebView (may be useful for testing purpose).

fun Options(scope: String? = null, forcesWebView: Boolean = false, customOption: Pair<String, Any>, vararg otherOptions: Pair<String, Any>)
Content copied to clipboard

Advanced constructor for provider-specific options.

Most of the options are specified using the customOption (the first one) and otherOptions (optional other ones) parameters as pairs of key / value.

Only the scope option key is standard and doesn't need to be set through customOption.

The forcesWebView option is not passed to the OAuth2 provider, it only selects which web browser will display the OAuth2 provider authentication endpoint on the device: false uses a "Chrome-tab" embedded within the phone (if available), it's the most secure, while false uses an Android WebView (may be useful for testing purpose).