Packages

class TwitterAuthenticationClient extends TwitterAuthClients with SystemShutdown

Represents the functionalities offered by the Twitter REST API for authentication

Source
TwitterAuthenticationClient.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TwitterAuthenticationClient
  2. SystemShutdown
  3. TwitterAuthClients
  4. TwitterOAuthClient
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TwitterAuthenticationClient(consumerToken: ConsumerToken)(implicit _system: ActorSystem = ...)

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 accessToken(token: RequestToken, oauth_verifier: String): Future[OAuthAccessToken]

    Allows a Consumer application to exchange the OAuth Request Token for an OAuth Access Token using OAuth 1.0.

    Allows a Consumer application to exchange the OAuth Request Token for an OAuth Access Token using OAuth 1.0. This method fulfills Section 6.3 of the OAuth 1.0 authentication flow. For more information see https://developer.twitter.com/en/docs/basics/authentication/api-reference/access_token.

    token

    : The OAuthRequestToken.token obtained from requestToken

    oauth_verifier

    : the oauth_verifier returned in the callback of the URL provided by authenticateUrl or authorizeUrl.

    returns

    : The access token for the requested user.

    Definition Classes
    TwitterOAuthClient
  5. def accessToken(x_auth_username: String, x_auth_password: String): Future[OAuthAccessToken]

    Allows a Consumer application to exchange the OAuth Request Token for an OAuth Access Token using xAuth.

    Allows a Consumer application to exchange the OAuth Request Token for an OAuth Access Token using xAuth. This method fulfills Section 6.3 of the OAuth 1.0 authentication flow. For more information see https://developer.twitter.com/en/docs/basics/authentication/api-reference/access_token.

    x_auth_username

    : The username of the user to obtain a token for.

    x_auth_password

    : The password of the user for which to obtain a token for.

    returns

    : The access token for the requested user.

    Definition Classes
    TwitterOAuthClient
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def authenticateUrl(token: RequestToken, force_login: Boolean = false, screen_name: Option[String] = None): String

    Allows a Consumer application to use an OAuth request_token to request user authorization.

    Allows a Consumer application to use an OAuth request_token to request user authorization. This method is a replacement of Section 6.2 of the OAuth 1.0 authentication flow for applications using the callback authentication flow. The method will use the currently logged in user as the account for access authorization unless the force_login parameter is set to true. This method differs from authorizeUrl in that if the user has already granted the application permission, the redirect will occur without the user having to re-approve the application. To realize this behavior, you must enable the Use Sign in with Twitter setting on your application record. For more information see https://developer.twitter.com/en/docs/basics/authentication/api-reference/authenticate.

    token

    : The OAuthRequestToken.token obtained from requestToken

    force_login

    : By default is false. When set to true, it forces the user to enter their credentials to ensure the correct users account is authorized.

    screen_name

    : Optional, by default it is None. It prefills the username input box of the OAuth login screen with the given value.

    returns

    : The authentication url to use in a web browser for the user to complete the authentication process.

    Definition Classes
    TwitterOAuthClient
  8. val authenticationClient: AuthenticationClient
    Attributes
    protected
    Definition Classes
    TwitterAuthenticationClientTwitterOAuthClient
  9. def authorizeUrl(token: RequestToken, force_login: Boolean = false, screen_name: Option[String] = None): String

    Allows a Consumer application to use an OAuth Request Token to request user authorization.

    Allows a Consumer application to use an OAuth Request Token to request user authorization. This method fulfills Section 6.2 of the OAuth 1.0 authentication flow. Desktop applications must use this method (and cannot use authenticateUrl). For more information see https://developer.twitter.com/en/docs/basics/authentication/api-reference/authenticate.

    token

    : The OAuthRequestToken.token obtained from requestToken

    force_login

    : By default is false. When set to true, it forces the user to enter their credentials to ensure the correct users account is authorized.

    screen_name

    : Optional, by default it is None. It prefills the username input box of the OAuth login screen with the given value.

    returns

    : The url to use in a web browser for the user to complete the authorization process.

    Definition Classes
    TwitterOAuthClient
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  11. val consumerToken: ConsumerToken
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def requestToken(oauth_callback: Option[String] = None, x_auth_access_type: Option[AccessType] = None): Future[OAuthRequestToken]

    Allows a Consumer application to obtain an OAuth Request Token to request user authorization.

    Allows a Consumer application to obtain an OAuth Request Token to request user authorization. This method fulfills Section 6.1 of the OAuth 1.0 authentication flow. For more information see https://developer.twitter.com/en/docs/basics/authentication/api-reference/request_token.

    oauth_callback

    : Optional, by default is None. For OAuth 1.0a compliance this parameter is required. The value you specify here will be used as the URL a user is redirected to should they approve your application’s access to their account. Set this to oob for out-of-band pin mode. This is also how you specify custom callbacks for use in desktop/mobile applications.

    x_auth_access_type

    : Optional, by default is None. Overrides the access level an application requests to a users account. Supported values are read or write . This parameter is intended to allow a developer to register a read/write application but also request read only access when appropriate.

    returns

    : The authentication request token.

    Definition Classes
    TwitterOAuthClient
  22. def shutdown(): Future[Unit]

    Shutdown of the actor system associated to the client

    Shutdown of the actor system associated to the client

    Definition Classes
    SystemShutdown
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. val system: ActorSystem
    Attributes
    protected
    Definition Classes
    TwitterAuthenticationClientSystemShutdown
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from SystemShutdown

Inherited from TwitterAuthClients

Inherited from TwitterOAuthClient

Inherited from AnyRef

Inherited from Any

Ungrouped