com.mohiva.play.silhouette.impl.providers

SocialProvider

trait SocialProvider extends Provider with SocialProfileBuilder

The base interface for all social providers.

Linear Supertypes
SocialProfileBuilder, Provider, AnyRef, Any
Known Subclasses
ClefProvider, DropboxProvider, FacebookProvider, FoursquareProvider, GitHubProvider, GoogleProvider, InstagramProvider, LinkedInProvider, LinkedInProvider, OAuth1Provider, OAuth2Provider, OpenIDProvider, SteamProvider, TwitterProvider, VKProvider, XingProvider, YahooProvider
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SocialProvider
  2. SocialProfileBuilder
  3. Provider
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. abstract type A <: AuthInfo

    The type of the auth info.

  2. abstract type Content

    The content type to parse a profile from.

    The content type to parse a profile from.

    Definition Classes
    SocialProfileBuilder

  3. abstract type Profile <: SocialProfile

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

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

    Definition Classes
    SocialProfileBuilder

Abstract Value Members

  1. abstract def authenticate[B]()(implicit request: ExtractableRequest[B]): Future[Either[Result, A]]

    Authenticates the user and returns the auth information.

    Authenticates the user and returns the auth information.

    Returns either a AuthInfo if all went OK or a Result that the controller sends to the browser (e.g.: in the case of OAuth where the user needs to be redirected to the service provider).

    request

    The request.

    returns

    Either a Result or the AuthInfo from the provider.

  2. abstract def buildProfile(authInfo: A): Future[Profile]

    Subclasses need to implement this method to populate the profile information from the service provider.

    Subclasses need to implement this method to populate the profile information from the service provider.

    authInfo

    The auth info received from the provider.

    returns

    On success the build social profile, otherwise a failure.

    Attributes
    protected
    Definition Classes
    SocialProfileBuilder

  3. abstract def id: String

    Gets the provider ID.

    Gets the provider ID.

    returns

    The provider ID.

    Definition Classes
    Provider

  4. abstract def profileParser: SocialProfileParser[Content, Profile]

    Returns the profile parser implementation.

    Returns the profile parser implementation.

    returns

    The profile parser implementation.

    Attributes
    protected
    Definition Classes
    SocialProfileBuilder

  5. abstract def urls: Map[String, String]

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

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

    Some providers need more than one request to different URLs to query the profile data. So we use a Map here to allow defining multiple URLs.

    returns

    The URLs that are needed to retrieve the profile data.

    Attributes
    protected
    Definition Classes
    SocialProfileBuilder

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  17. 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

  18. 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.

  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  20. def toString(): String

    Definition Classes
    AnyRef → Any

  21. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from SocialProfileBuilder

Inherited from Provider

Inherited from AnyRef

Inherited from Any

Ungrouped