Class

github4s.api

Auth

Related Doc: package api

Permalink

class Auth[C, M[_]] extends AnyRef

Factory to encapsulate calls related to Auth operations

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Auth
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Auth()(implicit urls: GithubApiUrls, C: Capture[M], httpClientImpl: HttpRequestBuilderExtension[C, M])

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val accessTokenUrl: String

    Permalink
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def authorizeUrl(client_id: String, redirect_uri: String, scopes: List[String]): M[GHResponse[Authorize]]

    Permalink

    Generates the authorize url with a random state, both are returned within Authorize object

    Generates the authorize url with a random state, both are returned within Authorize object

    client_id

    the 20 character OAuth app client key for which to create the token

    redirect_uri

    the URL in your app where users will be sent after authorization

    scopes

    attached to the token

    returns

    GHResponse[Authorize] new state: first step oAuth

  7. val authorizeUrl: String

    Permalink
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def getAccessToken(client_id: String, client_secret: String, code: String, redirect_uri: String, state: String, headers: Map[String, String] = Map()): M[GHResponse[OAuthToken]]

    Permalink

    Requests an access token based on the code retrieved in the first step of the oAuth process

    Requests an access token based on the code retrieved in the first step of the oAuth process

    client_id

    the 20 character OAuth app client key for which to create the token

    client_secret

    the 40 character OAuth app client secret for which to create the token

    code

    the code you received as a response to Step 1

    redirect_uri

    the URL in your app where users will be sent after authorization

    state

    the unguessable random string you optionally provided in Step 1

    headers

    optional user headers to include in the request

    returns

    GHResponse[OAuthToken] new access_token: second step oAuth

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

    Permalink
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. val httpClient: HttpClient[C, M]

    Permalink
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def newAuth(username: String, password: String, scopes: List[String], note: String, client_id: String, client_secret: String, headers: Map[String, String] = Map()): M[GHResponse[Authorization]]

    Permalink

    Call to request a new authorization given a basic authentication, the returned object Authorization includes an access token

    Call to request a new authorization given a basic authentication, the returned object Authorization includes an access token

    username

    the username of the user

    password

    the password of the user

    scopes

    attached to the token

    note

    to remind you what the OAuth token is for

    client_id

    the 20 character OAuth app client key for which to create the token

    client_secret

    the 40 character OAuth app client secret for which to create the token

    headers

    optional user headers to include in the request

    returns

    GHResponse[Authorization] new authorization with access_token

  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped