class SteamProvider extends BaseSteamProvider with CommonSocialProfileBuilder
The Steam OAuth2 Provider.
- Alphabetic
- By Inheritance
- SteamProvider
- CommonSocialProfileBuilder
- BaseSteamProvider
- OpenIDProvider
- Logger
- OpenIDConstants
- SocialProvider
- ExecutionContextProvider
- SocialProfileBuilder
- Provider
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SteamProvider(httpLayer: HTTPLayer, service: OpenIDService, settings: OpenIDSettings)
- httpLayer
The HTTP layer implementation.
- service
The OpenID service implementation.
- settings
The OpenID provider settings.
Type Members
- type A = OpenIDInfo
The type of the auth info.
The type of the auth info.
- Definition Classes
- OpenIDProvider → SocialProvider
- type Content = Unit
The content type to parse a profile from.
The content type to parse a profile from.
- Definition Classes
- BaseSteamProvider → SocialProfileBuilder
- 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.
- Definition Classes
- CommonSocialProfileBuilder
- type Self = SteamProvider
The type of this class.
The type of this class.
- Definition Classes
- SteamProvider → SocialProvider
- type Settings = OpenIDSettings
The settings type.
The settings type.
- Definition Classes
- OpenIDProvider → SocialProvider
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val Mode: String
- Definition Classes
- OpenIDConstants
- val OpenID: String
- Definition Classes
- OpenIDConstants
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def authenticate[B]()(implicit request: ExtractableRequest[B]): Future[Either[Result, OpenIDInfo]]
Starts the authentication process.
Starts the authentication process.
- B
The type of the request body.
- request
The current request.
- returns
Either a Result or the auth info from the provider.
- Definition Classes
- OpenIDProvider → SocialProvider
- def buildProfile(authInfo: OpenIDInfo): Future[Profile]
Builds the social profile.
Builds the social profile.
- authInfo
The auth info received from the provider.
- returns
On success the build social profile, otherwise a failure.
- Attributes
- protected
- Definition Classes
- BaseSteamProvider → SocialProfileBuilder
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit val executionContext: ExecutionContext
The execution context to handle the asynchronous operations.
The execution context to handle the asynchronous operations.
- Definition Classes
- SocialProvider → ExecutionContextProvider
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- val httpLayer: HTTPLayer
The HTTP layer implementation.
The HTTP layer implementation.
- Attributes
- protected
- Definition Classes
- SteamProvider → SocialProvider
- val id: String
Gets the provider ID.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val logger: api.Logger
A named logger instance.
A named logger instance.
- Definition Classes
- Logger
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- val profileParser: SteamProfileParser
The profile parser implementation.
The profile parser implementation.
- returns
The profile parser implementation.
- Definition Classes
- SteamProvider → SocialProfileBuilder
- 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.
- url
The url to resolve.
- request
The current request.
- returns
The absolute url.
- Attributes
- protected
- Definition Classes
- 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.
- authInfo
The auth info for which the profile information should be retrieved.
- returns
The profile information for the given auth info.
- Definition Classes
- SocialProvider
- val service: OpenIDService
The OpenID service implementation.
The OpenID service implementation.
- Definition Classes
- SteamProvider → OpenIDProvider
- val settings: OpenIDSettings
Gets the provider settings.
Gets the provider settings.
- returns
The provider settings.
- Definition Classes
- SteamProvider → SocialProvider
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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.
- returns
The URLs that are needed to retrieve the profile data.
- Attributes
- protected
- Definition Classes
- BaseSteamProvider → SocialProfileBuilder
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withSettings(f: (Settings) => Settings): SteamProvider
Gets a provider initialized with a new settings object.
Gets a provider initialized with a new settings object.
- f
A function which gets the settings passed and returns different settings.
- returns
An instance of the provider initialized with new settings.
- Definition Classes
- SteamProvider → SocialProvider
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)