Packages

trait Auth[F[_]] extends AnyRef

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

Abstract Value Members

  1. abstract def authorizeUrl(client_id: String, redirect_uri: String, scopes: List[String]): F[GHResponse[Authorize]]

    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

  2. abstract def getAccessToken(client_id: String, client_secret: String, code: String, redirect_uri: String, state: String, headers: Map[String, String] = Map()): F[GHResponse[OAuthToken]]

    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

  3. abstract def newAuth(username: String, password: String, scopes: List[String], note: String, client_id: String, client_secret: String, headers: Map[String, String] = Map()): F[GHResponse[Authorization]]

    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

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped