com.mb3364.twitch.api.auth

Class Authenticator

java.lang.Object

com.mb3364.twitch.api.auth.Authenticator

public class Authenticator
extends java.lang.Object

The authenticator object allows a user to authenticate with the Twitch.tv servers.

Constructor Summary

Constructors

Constructor and Description
Authenticator(java.lang.String twitchBaseUrl)

Method Summary

Modifier and Type	Method and Description
boolean	awaitAccessToken() Listens for callback from twitch server with the access token.
java.lang.String	getAccessToken()
AuthenticationError	getAuthenticationError() Get the authentication error if it failed.
java.lang.String	getAuthenticationUrl(java.lang.String clientId, java.net.URI redirectURI, Scopes... scopes) Returns the authentication URL that you can redirect the user to in order to authorize your application to access their account and retrieve an access token.
java.lang.String	getClientId()
java.net.URI	getRedirectUri()
boolean	hasAccessToken() Check if an access token has been received.
boolean	hasAuthenticationError() Check if there was an authentication error.
void	setAccessToken(java.lang.String accessToken)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Authenticator

public Authenticator(java.lang.String twitchBaseUrl)

Method Detail

getAuthenticationUrl

public java.lang.String getAuthenticationUrl(java.lang.String clientId,
                                             java.net.URI redirectURI,
                                             Scopes... scopes)

Returns the authentication URL that you can redirect the user to in order to authorize your application to access their account and retrieve an access token.

Parameters:

clientId - the Twitch application client ID

redirectURI - the redirect URI for your Twitch application

scopes - the scopes needed for your application

Returns:

String, the authentication URL

awaitAccessToken

public boolean awaitAccessToken()

Listens for callback from twitch server with the access token. getAuthenticationUrl() must be called prior to this function!

Returns:

true if access token was received, false otherwise

getClientId

public java.lang.String getClientId()

getRedirectUri

public java.net.URI getRedirectUri()

getAccessToken

public java.lang.String getAccessToken()

setAccessToken

public void setAccessToken(java.lang.String accessToken)

hasAccessToken

public boolean hasAccessToken()

Check if an access token has been received.

Returns:

true if an access token has been received; false otherwise

getAuthenticationError

public AuthenticationError getAuthenticationError()

Get the authentication error if it failed.

Returns:

AuthenticationError if authentication failed. null otherwise

hasAuthenticationError

public boolean hasAuthenticationError()

Check if there was an authentication error.

Returns:

true if an error exists; false otherwise