-
- All Implemented Interfaces:
public final class AuthOptions
Represents a set of options for authentication, which can be passed to some methods such as Webcom.authWithOAuth.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
AuthOptions.OAuthUserAgent
public class
AuthOptions.Companion
-
Field Summary
Fields Modifier and Type Field Description private Boolean
forcesWebView
private AuthOptions.OAuthUserAgent
userAgent
private Function1<CustomTabsIntent.Builder, Unit>
customTabsBuilder
-
Method Summary
Modifier and Type Method Description final Boolean
getForcesWebView()
final Unit
setForcesWebView(@Deprecated(message = "Use userAgent instead") Boolean forcesWebView)
final AuthOptions.OAuthUserAgent
getUserAgent()
final Unit
setUserAgent(AuthOptions.OAuthUserAgent userAgent)
final Function1<CustomTabsIntent.Builder, Unit>
getCustomTabsBuilder()
final Unit
setCustomTabsBuilder(Function1<CustomTabsIntent.Builder, Unit> customTabsBuilder)
final AuthOptions
setMCC()
Adds the "mcc" option (Mobile Country Code) to this AuthOptions instance with a value automatically guessed from the activated SIM card on the device. final AuthOptions
setMCC(String mcc)
Adds the "mcc" option (Mobile Country Code) to this AuthOptions instance with a custom value. final AuthOptions
setScope(String scope)
Adds an OAuth2 "scope" option to this AuthOptions instance. final AuthOptions
setCustomParameter(String key, Object value)
Adds (or removes) a custom parameter to this AuthOptions instance with a custom value. final AuthOptions
WithMCC()
final AuthOptions
WithMCC(String mcc)
final AuthOptions
WithScope(String scope)
final AuthOptions
WithCustomParameter(String key, Object value)
String
toString()
-
-
Method Detail
-
getForcesWebView
final Boolean getForcesWebView()
-
setForcesWebView
final Unit setForcesWebView(@Deprecated(message = "Use userAgent instead") Boolean forcesWebView)
-
getUserAgent
final AuthOptions.OAuthUserAgent getUserAgent()
-
setUserAgent
final Unit setUserAgent(AuthOptions.OAuthUserAgent userAgent)
-
getCustomTabsBuilder
final Function1<CustomTabsIntent.Builder, Unit> getCustomTabsBuilder()
-
setCustomTabsBuilder
final Unit setCustomTabsBuilder(Function1<CustomTabsIntent.Builder, Unit> customTabsBuilder)
-
setMCC
final AuthOptions setMCC()
Adds the "mcc" option (Mobile Country Code) to this AuthOptions instance with a value automatically guessed from the activated SIM card on the device. This option is relevant for wassup-based implicit authentication.
-
setMCC
final AuthOptions setMCC(String mcc)
Adds the "mcc" option (Mobile Country Code) to this AuthOptions instance with a custom value. This option is relevant for wassup-based implicit authentication.
-
setScope
final AuthOptions setScope(String scope)
Adds an OAuth2 "scope" option to this AuthOptions instance.
- Parameters:
scope
- An OAuth2 scope (value is OAuth2-provider-specific).
-
setCustomParameter
final AuthOptions setCustomParameter(String key, Object value)
Adds (or removes) a custom parameter to this AuthOptions instance with a custom value.
- Parameters:
key
- The name of the custom parameter to setvalue
- The value of the custom parameter to add, ornull
to remove the custom parameter
-
WithMCC
@Deprecated(message = "replaced by setMCC()", replaceWith = @ReplaceWith(imports = {}, expression = "setMCC()")) final AuthOptions WithMCC()
-
WithMCC
@Deprecated(message = "replaced by setMCC(mcc: String)", replaceWith = @ReplaceWith(imports = {}, expression = "setMCC(mcc)")) final AuthOptions WithMCC(String mcc)
-
WithScope
@Deprecated(message = "replaced by setScope(scope: String?)", replaceWith = @ReplaceWith(imports = {}, expression = "setScope(scope)")) final AuthOptions WithScope(String scope)
-
WithCustomParameter
@Deprecated(message = "replaced by setCustomParameter(key: String, value: Any?", replaceWith = @ReplaceWith(imports = {}, expression = "setCustomParameter(key, value)")) final AuthOptions WithCustomParameter(String key, Object value)
-
-
-
-