Packages

final case class Github(clientId: String) extends OAuth2Provider with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Github
  2. Serializable
  3. Product
  4. Equals
  5. OAuth2Provider
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Github(clientId: String)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def accessTokenRequest(authorization: AuthorizationResponse): HttpRequest

    Generates HTTP request for access token request.

    Generates HTTP request for access token request.

    Definition Classes
    GithubOAuth2Provider
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def authorizationRequest(scope: List[String]): HttpRequest

    Generates HTTP request for authorization request.

    Generates HTTP request for authorization request.

    Definition Classes
    GithubOAuth2Provider
  7. val clientId: String
  8. val clientIdentifier: String

    Public client identifier as provided after registration on authorization server.

    Public client identifier as provided after registration on authorization server. It is used for generating default file name, which holds access token.

    Definition Classes
    GithubOAuth2Provider
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  10. def decodeAccessTokenResponse(body: String): Either[String, AccessTokenResponse]

    Converts textual response of access token request into AccessTokenResponse.

    Converts textual response of access token request into AccessTokenResponse. Defaults to decoding from standard JSON format, can be overriden if OAuth2 server does not adhere to this standard.

    body

    response body

    returns

    decoded access token response

    Definition Classes
    OAuth2Provider
    See also

    https://datatracker.ietf.org/doc/html/rfc6749#section-5.1

    https://datatracker.ietf.org/doc/html/rfc6749#section-5.2

    https://datatracker.ietf.org/doc/html/rfc8628#section-3.5

  11. def decodeAuthorizationResponse(body: String): Either[String, AuthorizationResponse]

    Converts textual response of authorization request into AuthorizationResponse.

    Converts textual response of authorization request into AuthorizationResponse. Defaults to decoding from standard JSON format, can be overridden if OAuth2 server does not adhere to this standard.

    body

    response body

    returns

    decoded authorization response

    Definition Classes
    OAuth2Provider
    See also

    https://datatracker.ietf.org/doc/html/rfc8628#section-3.2

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. val name: String

    Name of the provider.

    Name of the provider.

    Definition Classes
    GithubOAuth2Provider
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. def refreshTokenRequest(refreshToken: String): Option[HttpRequest]

    Generates HTTP request for refresh token request.

    Generates HTTP request for refresh token request. Returns None if this operation is not supported by the provider.

    Definition Classes
    GithubOAuth2Provider
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from OAuth2Provider

Inherited from AnyRef

Inherited from Any

Ungrouped