class TwitterAuthenticationClient extends TwitterAuthClients with SystemShutdown
Represents the functionalities offered by the Twitter REST API for authentication
- Alphabetic
- By Inheritance
- TwitterAuthenticationClient
- SystemShutdown
- TwitterAuthClients
- TwitterOAuthClient
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
-
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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
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 theUse 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 totrue
, 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
-
val
authenticationClient: AuthenticationClient
- Attributes
- protected
- Definition Classes
- TwitterAuthenticationClient → TwitterOAuthClient
-
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 totrue
, 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
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
- val consumerToken: ConsumerToken
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
val
system: ActorSystem
- Attributes
- protected
- Definition Classes
- TwitterAuthenticationClient → SystemShutdown
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )