com.orange.webcom.sdk

Class AuthOptions

com.orange.webcom.sdk.AuthOptions

public class AuthOptions

Represents a set of options for authentication, which can be passed to some methods such as Webcom.authWithOAuth.

See Also:

Webcom.authWithOAuth

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthOptions.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static AuthOptions.Companion	Companion

Method Summary

Modifier and Type	Method and Description
static AuthOptions	Create() Deprecated.
AuthOptions	WithCustomParameter(java.lang.String key, java.lang.Object value) Adds (or removes) a custom parameter to this class AuthOptions instance with a custom value.
AuthOptions	WithMCC() Deprecated.
AuthOptions	WithMCC(java.lang.String mcc) Deprecated.
AuthOptions	WithScope(java.lang.String scope) Deprecated.
static AuthOptions	create() Creates an empty class AuthOptions instance.
boolean	getForcesWebView()
static java.lang.String	getMobileCountryCode() Retrieves the Mobile Country Code (MCC) associated to the SIM card activated on the phone.
static java.lang.String	getMobileNetworkCode() Retrieves the Mobile Network Code (MNC) associated to the SIM card activated on the phone.
AuthOptions	setCustomParameter(java.lang.String key, java.lang.Object value)
void	setForcesWebView(boolean p)
AuthOptions	setMCC()
AuthOptions	setMCC(java.lang.String mcc)
AuthOptions	setScope(java.lang.String scope) Adds an OAuth2 "scope" option to this class AuthOptions instance.
java.lang.String	toString()

Field Detail

Companion

public static AuthOptions.Companion Companion

Method Detail

getForcesWebView

public boolean getForcesWebView()

setForcesWebView

public void setForcesWebView(boolean p)

WithMCC

@Deprecated
 @NotNull
public AuthOptions WithMCC()

Deprecated.

Adds the "mcc" option (Mobile Country Code) to this class AuthOptions instance with a value automatically guessed from the activated SIM card on the device. This option is relevant for wassup-based implicit authentication.

Returns:

This class AuthOptions instance updated, so that other With... methods can be chained

Throws:

WebcomException - If no Mobile Country Code can be found from the SIM card

See Also:

Mobile Country Code, class AuthOptions

setMCC

@NotNull
public AuthOptions setMCC()

WithMCC

@Deprecated
 @NotNull
public AuthOptions WithMCC(@NotNull
                                                 java.lang.String mcc)

Deprecated.

Adds the "mcc" option (Mobile Country Code) to this class AuthOptions instance with a custom value. This option is relevant for wassup-based implicit authentication.

Returns:

This class AuthOptions instance updated, so that other With... methods can be chained

See Also:

Mobile Country Code, class AuthOptions

setMCC

@NotNull
public AuthOptions setMCC(@NotNull
                                   java.lang.String mcc)

setScope

@NotNull
public AuthOptions setScope(@Nullable
                                     java.lang.String scope)

Adds an OAuth2 "scope" option to this class AuthOptions instance.

Parameters:

scope - An OAuth2 scope (value is OAuth2-provider-specific). If null, remains this instanceunchanged (note that if no scope is specified within an class AuthOptions instance, a minimalscope will be requested to the OAuth2 provider when passed toWebcom.authWithOAuth)

Returns:

This class AuthOptions instance updated, so that other With... methods can be chained

See Also:

class AuthOptions

WithScope

@Deprecated
 @NotNull
public AuthOptions WithScope(@Nullable
                                                   java.lang.String scope)

Deprecated.

WithCustomParameter

@NotNull
public AuthOptions WithCustomParameter(@NotNull
                                                java.lang.String key,
                                                @Nullable
                                                java.lang.Object value)

Adds (or removes) a custom parameter to this class AuthOptions instance with a custom value.

Parameters:

key - The name of the custom parameter to set

value - The value of the custom parameter to add, or null to remove the custom parameter

Returns:

This class AuthOptions instance updated, so that other With... methods can be chained

See Also:

class AuthOptions

setCustomParameter

@NotNull
public AuthOptions setCustomParameter(@NotNull
                                               java.lang.String key,
                                               @Nullable
                                               java.lang.Object value)

toString

@NotNull
public java.lang.String toString()

Create

@JvmStatic
 @Deprecated
 @NotNull
public static AuthOptions Create()

Deprecated.

create

@JvmStatic
 @NotNull
public static AuthOptions create()

Creates an empty class AuthOptions instance.

Returns:

An empty class AuthOptions instance

See Also:

class AuthOptions

getMobileCountryCode

@JvmStatic
 @NotNull
public static java.lang.String getMobileCountryCode()

Retrieves the Mobile Country Code (MCC) associated to the SIM card activated on the phone.

Returns:

the MCC of this phone SIM card or an empty String if no SIM card is found or activated

See Also:

Mobile Country Code

getMobileNetworkCode

@JvmStatic
 @NotNull
public static java.lang.String getMobileNetworkCode()

Retrieves the Mobile Network Code (MNC) associated to the SIM card activated on the phone.

Returns:

the MNC of this phone SIM card or an empty String if no SIM card is found or activated

See Also:

Mobile Network Code