OAuthProvider.Builder

class OAuthProvider.Builder


Class used to create instances of OAuthProvider.

Summary

Public functions

OAuthProvider.Builder
addCustomParameter(paramKey: String, paramValue: String)

Configures custom parameters to be passed to the identity provider during the OAuth sign-in flow.

OAuthProvider.Builder
addCustomParameters(customParameters: (Mutable)Map<String!, String!>)

Similar to addCustomParameter, this takes a Map and adds each entry to the set of custom parameters to be passed.

OAuthProvider

Returns an OAuthProvider created from this Builder.

OAuthProvider.Builder

Sets the OAuth 2 scopes to be presented to the user during their sign-in flow with the identity provider.

Public functions

addCustomParameter

fun addCustomParameter(paramKey: String, paramValue: String): OAuthProvider.Builder

Configures custom parameters to be passed to the identity provider during the OAuth sign-in flow. Calling this method multiple times will add to the set of custom parameters being passed, rather than overwriting them (as long as key values don't collide).

Parameters
paramKey: String

the name of the custom parameter

paramValue: String

the value of the custom parameter

addCustomParameters

fun addCustomParameters(customParameters: (Mutable)Map<String!, String!>): OAuthProvider.Builder

Similar to addCustomParameter, this takes a Map and adds each entry to the set of custom parameters to be passed. Calling this method multiple times will add to the set of custom parameters being passed, rather than overwriting them (as long as key values don't collide).

Parameters
customParameters: (Mutable)Map<String!, String!>

a dictionary of custom parameter names and values to be passed to the identity provider as part of the sign-in flow.

build

fun build(): OAuthProvider

Returns an OAuthProvider created from this Builder.

setScopes

fun setScopes(scopes: (Mutable)List<String!>): OAuthProvider.Builder

Sets the OAuth 2 scopes to be presented to the user during their sign-in flow with the identity provider.