com.smartcar.sdk

Class SmartcarAuth.AuthUrlBuilder

java.lang.Object

com.smartcar.sdk.SmartcarAuth.AuthUrlBuilder

Enclosing class:

SmartcarAuth

public class SmartcarAuth.AuthUrlBuilder
extends java.lang.Object

A builder used for generating Smartcar Connect authorization URLs.

Constructor Summary

Constructors

Constructor and Description
AuthUrlBuilder()

Method Summary

Modifier and Type	Method and Description
java.lang.String	build() Build a Smartcar Connect authorization url.
SmartcarAuth.AuthUrlBuilder	setFlags(java.lang.String[] flags) Enable early access features.
SmartcarAuth.AuthUrlBuilder	setForcePrompt(boolean forcePrompt) Force display of the grant approval dialog in Smartcar Connect.
SmartcarAuth.AuthUrlBuilder	setMakeBypass(java.lang.String make) Bypass the brand selector screen to a specified make.
SmartcarAuth.AuthUrlBuilder	setSingleSelect(boolean singleSelect) Ensure the user only authorizes a single vehicle.
SmartcarAuth.AuthUrlBuilder	setSingleSelectVin(java.lang.String vin) Specify the vin a user can authorize in Smartcar Connect.
SmartcarAuth.AuthUrlBuilder	setState(java.lang.String state) Set an optional state parameter.
SmartcarAuth.AuthUrlBuilder	setUser(java.lang.String user) Specify a unique identifier for the vehicle owner to track their progress through Smartcar Connect.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthUrlBuilder

public AuthUrlBuilder()

Method Detail

setState

public SmartcarAuth.AuthUrlBuilder setState(java.lang.String state)

Set an optional state parameter.

Parameters:

state - An optional value included on the SmartcarResponse object returned to the SmartcarCallback

Returns:

a reference to this object

setForcePrompt

public SmartcarAuth.AuthUrlBuilder setForcePrompt(boolean forcePrompt)

Force display of the grant approval dialog in Smartcar Connect. Defaults to false and will only display the approval dialog if the user has not previously approved the scope. Set this to true to ensure the approval dialog is always shown to the user even if they have previously approved the same scope.

Parameters:

forcePrompt - Set to true to ensure the grant approval dialog is always shown

Returns:

a reference to this object

setMakeBypass

public SmartcarAuth.AuthUrlBuilder setMakeBypass(java.lang.String make)

Bypass the brand selector screen to a specified make. See the available makes on the Smartcar API Reference.

Parameters:

make - The selected make

Returns:

a reference to this object

See Also:

Smartcar Connect Direct

setSingleSelect

public SmartcarAuth.AuthUrlBuilder setSingleSelect(boolean singleSelect)

Ensure the user only authorizes a single vehicle. A user's connected service account can be connected to multiple vehicles. Setting this parameter to true forces the user to select only a single vehicle.

Parameters:

singleSelect - Set to true to ensure only a single vehicle is authorized

Returns:

a reference to this object

See Also:

Smartcar Connect Match

setSingleSelectVin

public SmartcarAuth.AuthUrlBuilder setSingleSelectVin(java.lang.String vin)

Specify the vin a user can authorize in Smartcar Connect. When the setSingleSelect(boolean) is set to true, this parameter can be used to ensure that Smartcar Connect will allow the user to authorize only the vehicle with a specific VIN.

Parameters:

vin - The specific VIN to authorize

Returns:

a reference to this object

See Also:

Smartcar Connect Match

setFlags

public SmartcarAuth.AuthUrlBuilder setFlags(java.lang.String[] flags)

Enable early access features.

Parameters:

flags - List of feature flags that your application has early access to.

Returns:

a reference to this object

setUser

public SmartcarAuth.AuthUrlBuilder setUser(java.lang.String user)

Specify a unique identifier for the vehicle owner to track their progress through Smartcar Connect.

Parameters:

user - An optional unique identifier for a vehicle owner. This identifier is used to aggregate analytics across Connect sessions for each vehicle owner.

Returns:

a reference to this object

build

public java.lang.String build()

Build a Smartcar Connect authorization url.

Returns:

A built url which can be used in SmartcarAuth.launchAuthFlow(Context, String) or SmartcarAuth.addClickHandler(Context, View, String)