OAuthRequest.Builder

public final class OAuthRequest.Builder


Builder for constructing new instance of OAuth request.

Summary

Public constructors

Public methods

final @RequiresApi(value = "26") @NonNull OAuthRequest

Build the request instance specified by this builder

final @NonNull OAuthRequest.Builder
setAuthProviderUrl(@NonNull Uri authProviderUrl)

Set the url of the auth provider site.

final @NonNull OAuthRequest.Builder

Set the client id of this OAuth request.

final @NonNull OAuthRequest.Builder

Set the code challenge for authentication with PKCE (proof key for code exchange).

final @NonNull OAuthRequest.Builder
setRedirectUrl(@NonNull Uri redirectUrl)

Set the redirect url the companion app registered to, so that the response will be routed from the auth server back to the companion.

Public constructors

Builder

public final Builder(@NonNull Context context)
Parameters
@NonNull Context context

The Context of the app sending the auth request.

Public methods

build

@RequiresApi(value = "26")
@NonNull
public final @RequiresApi(value = "26") OAuthRequest build()

Build the request instance specified by this builder

setAuthProviderUrl

@NonNull
public final OAuthRequest.Builder setAuthProviderUrl(@NonNull Uri authProviderUrl)

Set the url of the auth provider site. Appending query parameters in this uri is optional, it is recommended to let the builder append query parameters automatically through the use of setters (no setter is required for the builder to append the redirect_uri).

setClientId

@NonNull
public final OAuthRequest.Builder setClientId(@NonNull String clientId)

Set the client id of this OAuth request. With this setter called. the builder appends the "client_id" to the requestUrl.

setCodeChallenge

@NonNull
public final OAuthRequest.Builder setCodeChallenge(@NonNull CodeChallenge codeChallenge)

Set the code challenge for authentication with PKCE (proof key for code exchange). With this setter called, the builder appends the "code_challenge", "code_challenge_method" and "response_type" queries to the requestUrl.

setRedirectUrl

@NonNull
public final OAuthRequest.Builder setRedirectUrl(@NonNull Uri redirectUrl)

Set the redirect url the companion app registered to, so that the response will be routed from the auth server back to the companion.

Calling this method is optional. If the redirect URL is not specified, it will be automatically set to WEAR_REDIRECT_URL_PREFIX or WEAR_REDIRECT_URL_PREFIX_CN for rest of the world or China, respectively.

Note, the app package name should NOT be included here, it will be appended to the end of redirect_uri automatically in Builder.build.