play-silhouette
API
Generated with
play-silhouette/play.silhouette/play.silhouette.impl/play.silhouette.impl.providers/play.silhouette.impl.providers.openid/YahooProvider

YahooProvider

play.silhouette.impl.providers.openid.YahooProvider
See theYahooProvider companion object
class YahooProvider(val httpLayer: HTTPLayer, val service: OpenIDService, val settings: OpenIDSettings) extends BaseYahooProvider, CommonSocialProfileBuilder

The Yahoo OAuth2 Provider.

Value parameters

httpLayer

The HTTP layer implementation.

service

The OpenID service implementation.

settings

The OpenID provider settings.

Attributes

Companion
object
Graph
Supertypes
trait Logger
trait Provider
class Object
trait Matchable
class Any
Show all

Members list

Type members

Types

override type Self = YahooProvider

The type of this class.

The type of this class.

Attributes

Inherited types

type A = OpenIDInfo

The type of the auth info.

The type of the auth info.

Attributes

Inherited from:
OpenIDProvider
override type Content = Unit

The content type to parse a profile from.

The content type to parse a profile from.

Attributes

Inherited from:
BaseYahooProvider
type Profile = CommonSocialProfile

The type of the profile a profile builder is responsible for.

The type of the profile a profile builder is responsible for.

Attributes

Inherited from:
CommonSocialProfileBuilder
type Settings = OpenIDSettings

The settings type.

The settings type.

Attributes

Inherited from:
OpenIDProvider

Value members

Concrete methods

override def withSettings(f: Settings => Settings): YahooProvider

Gets a provider initialized with a new settings object.

Gets a provider initialized with a new settings object.

Value parameters

f

A function which gets the settings passed and returns different settings.

Attributes

Returns

An instance of the provider initialized with new settings.

Definition Classes

Inherited methods

def authenticate[B]()(implicit request: ExtractableRequest[B]): Future[Either[Result, OpenIDInfo]]

Starts the authentication process.

Starts the authentication process.

Type parameters

B

The type of the request body.

Value parameters

request

The current request.

Attributes

Returns

Either a Result or the auth info from the provider.

Inherited from:
OpenIDProvider
override protected def buildProfile(authInfo: OpenIDInfo): Future[Profile]

Builds the social profile.

Builds the social profile.

Value parameters

authInfo

The auth info received from the provider.

Attributes

Returns

On success the build social profile, otherwise a failure.

Definition Classes
Inherited from:
BaseYahooProvider
protected def resolveCallbackURL(url: String)(implicit request: RequestHeader): String

Resolves the url to be absolute relative to the request.

Resolves the url to be absolute relative to the request.

This will pass the url through if its already absolute.

Value parameters

request

The current request.

url

The url to resolve.

Attributes

Returns

The absolute url.

Inherited from:
SocialProvider
def retrieveProfile(authInfo: A): Future[Profile]

Retrieves the user profile for the given auth info.

Retrieves the user profile for the given auth info.

This method can be used to retrieve the profile information for an already authenticated identity.

Value parameters

authInfo

The auth info for which the profile information should be retrieved.

Attributes

Returns

The profile information for the given auth info.

Inherited from:
SocialProvider

Concrete fields

override val profileParser: SocialProfileParser[Content, Profile, A]

The profile parser implementation.

The profile parser implementation.

Attributes

val service: OpenIDService

The OpenID service implementation.

The OpenID service implementation.

Attributes

val settings: OpenIDSettings

Gets the provider settings.

Gets the provider settings.

Attributes

Returns

The provider settings.

Inherited fields

val Mode: String

Attributes

Inherited from:
OpenIDConstants
val OpenID: String

Attributes

Inherited from:
OpenIDConstants
override val id: String

Gets the provider ID.

Gets the provider ID.

Attributes

Returns

The provider ID.

Inherited from:
BaseYahooProvider
val logger: Logger

A named logger instance.

A named logger instance.

Attributes

Inherited from:
Logger
override protected val urls: Map[String, String]

Defines the URLs that are needed to retrieve the profile data.

Defines the URLs that are needed to retrieve the profile data.

Attributes

Inherited from:
BaseYahooProvider

Implicits

Inherited implicits

implicit override val executionContext: ExecutionContext

The execution context to handle the asynchronous operations.

The execution context to handle the asynchronous operations.

Attributes

Inherited from:
SocialProvider
Generated with