com.uber.sdk.rides.client

Class SessionConfiguration.Builder

java.lang.Object

com.uber.sdk.rides.client.SessionConfiguration.Builder

Enclosing class:

SessionConfiguration

public static class SessionConfiguration.Builder
extends java.lang.Object

Builder for SessionConfiguration

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SessionConfiguration	build() Constructs SessionConfiguration from set Builder parameters.
SessionConfiguration.Builder	setClientId(java.lang.String clientId) The Uber API requires a registered clientId to be sent along with API requests and Deeplinks.
SessionConfiguration.Builder	setClientSecret(java.lang.String clientSecret) The Uber API requires a registered clientSecret to be used for Authentication.
SessionConfiguration.Builder	setCustomScopes(java.util.Collection<java.lang.String> scopes) Sets a list of custom scopes that your application must be explicitly whitelisted for.
SessionConfiguration.Builder	setEnvironment(SessionConfiguration.Environment environment) Sets the SessionConfiguration.Environment to be used for API requests
SessionConfiguration.Builder	setLocale(java.util.Locale locale) Sets the requested Locale through the Accept-Language HTTP header.
SessionConfiguration.Builder	setRedirectUri(java.lang.String redirectUri) Sets the redirect URI that is registered for this application.
SessionConfiguration.Builder	setScopes(java.util.Collection<Scope> scopes) Sets the Scope Collection to be used when requesting authentication
SessionConfiguration.Builder	setServerToken(java.lang.String serverToken) The Uber API can use a server token for some endpoints.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setClientId

public SessionConfiguration.Builder setClientId(@Nonnull
                                                java.lang.String clientId)

The Uber API requires a registered clientId to be sent along with API requests and Deeplinks. This can be registered and retrieved on the developer dashboard at https://developer.uber.com/

Parameters:

clientId - to be used for identification

Returns:

setClientSecret

public SessionConfiguration.Builder setClientSecret(@Nonnull
                                                    java.lang.String clientSecret)

The Uber API requires a registered clientSecret to be used for Authentication. This can be registered and retrieved on the developer dashboard at https://developer.uber.com/ Do not set client secret for Android or client side applications.

Parameters:

clientSecret - to be used for identification

Returns:

setServerToken

public SessionConfiguration.Builder setServerToken(@Nonnull
                                                   java.lang.String serverToken)

The Uber API can use a server token for some endpoints.

Parameters:

serverToken - to be used for identification

Returns:

setRedirectUri

public SessionConfiguration.Builder setRedirectUri(@Nonnull
                                                   java.lang.String redirectUri)

Sets the redirect URI that is registered for this application.

Parameters:

redirectUri - the redirect URI String for this application.

setEnvironment

public SessionConfiguration.Builder setEnvironment(@Nonnull
                                                   SessionConfiguration.Environment environment)

Sets the SessionConfiguration.Environment to be used for API requests

Parameters:

environment - to be set

Returns:

setScopes

public SessionConfiguration.Builder setScopes(@Nonnull
                                              java.util.Collection<Scope> scopes)

Sets the Scope Collection to be used when requesting authentication

Parameters:

scopes - to be set

Returns:

setCustomScopes

public SessionConfiguration.Builder setCustomScopes(@Nonnull
                                                    java.util.Collection<java.lang.String> scopes)

Sets a list of custom scopes that your application must be explicitly whitelisted for. For any documented scopes, please use setScopes(Collection) instead.

setLocale

public SessionConfiguration.Builder setLocale(@Nonnull
                                              java.util.Locale locale)

Sets the requested Locale through the Accept-Language HTTP header. See Localization for possible locales.

build

public SessionConfiguration build()

Constructs SessionConfiguration from set Builder parameters.

Returns:

SessionConfiguration

Throws:

java.lang.NullPointerException - when clientId has not been set