twitter4j.http
Interface OAuthSupport

All Known Implementing Classes:

AsyncTwitter, OAuthAuthorization, Twitter, TwitterOAuthSupportBase

public interface OAuthSupport

Since:

Twitter4J 2.1.0

Author:

Yusuke Yamamoto - yusuke at mac.com

Method Summary

AccessToken	getOAuthAccessToken() Retrieves an access token.
AccessToken	getOAuthAccessToken(RequestToken requestToken) Retrieves an access token associated with the supplied request token and sets userId.
AccessToken	getOAuthAccessToken(RequestToken requestToken, java.lang.String oauthVerifier) Retrieves an access token associated with the supplied request token and sets userId.
AccessToken	getOAuthAccessToken(java.lang.String oauthVerifier) Retrieves an access token.
RequestToken	getOAuthRequestToken() Retrieves a request token
RequestToken	getOAuthRequestToken(java.lang.String callbackURL) Retrieves a request token
void	setOAuthAccessToken(AccessToken accessToken) Sets the access token

Method Detail

getOAuthRequestToken

RequestToken getOAuthRequestToken()
                                  throws TwitterException

Retrieves a request token

Returns:

generated request token.

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter 2.0.0

See Also:

Twitter API Wiki - OAuth FAQ, OAuth Core 1.0a - 6.1. Obtaining an Unauthorized Request Token

getOAuthRequestToken

RequestToken getOAuthRequestToken(java.lang.String callbackURL)
                                  throws TwitterException

Retrieves a request token

Parameters:

callbackURL - callback URL

Returns:

generated request token

Throws:

TwitterException - when Twitter service or network is unavailable

Since:

Twitter 2.0.0

See Also:

Twitter API Wiki - OAuth FAQ, OAuth Core 1.0a - 6.1. Obtaining an Unauthorized Request Token

getOAuthAccessToken

AccessToken getOAuthAccessToken()
                                throws TwitterException

Retrieves an access token.

Returns:

access token

Throws:

TwitterException - when Twitter service or network is unavailable, or the user has not authorized

Since:

Twitter 2.0.0

See Also:

Twitter API Wiki - How long does an access token last?, OAuth Core 1.0a - 6.2. Obtaining User Authorization

getOAuthAccessToken

AccessToken getOAuthAccessToken(java.lang.String oauthVerifier)
                                throws TwitterException

Retrieves an access token.

Parameters:

oauthVerifier - OAuth verifier. AKA pin.

Returns:

access token

Throws:

TwitterException - when Twitter service or network is unavailable, or the user has not authorized

Since:

Twitter 2.0.0

See Also:

Twitter API Wiki - How long does an access token last?, OAuth Core 1.0a - 6.2. Obtaining User Authorization

getOAuthAccessToken

AccessToken getOAuthAccessToken(RequestToken requestToken)
                                throws TwitterException

Retrieves an access token associated with the supplied request token and sets userId.

Parameters:

requestToken - the request token

Returns:

access token associated with the supplied request token.

Throws:

TwitterException - when Twitter service or network is unavailable, or the user has not authorized

Since:

Twitter 2.0.0

See Also:

Twitter API Wiki - How long does an access token last?, OAuth Core 1.0a - 6.2. Obtaining User Authorization

getOAuthAccessToken

AccessToken getOAuthAccessToken(RequestToken requestToken,
                                java.lang.String oauthVerifier)
                                throws TwitterException

Retrieves an access token associated with the supplied request token and sets userId.

Parameters:

requestToken - the request token

oauthVerifier - OAuth verifier. AKA pin.

Returns:

access token associated with the supplied request token.

Throws:

TwitterException - when Twitter service or network is unavailable, or the user has not authorized

Since:

Twitter 2.0.0

See Also:

Twitter API Wiki - How long does an access token last?, OAuth Core 1.0a - 6.2. Obtaining User Authorization

setOAuthAccessToken

void setOAuthAccessToken(AccessToken accessToken)

Sets the access token

Parameters:

accessToken - accessToken

Since:

Twitter 2.0.0