Package com.github.twitch4j.helix
Class TwitchHelixBuilder
java.lang.Object
com.github.twitch4j.helix.TwitchHelixBuilder
Twitch API - Helix
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Twitch API Client (Helix)static TwitchHelixBuilder
builder()
Initialize the builderio.github.bucket4j.Bandwidth
Custom Rate Limit to use for Helix callsBaseUrlClient IdClient Secretcom.github.philippheuer.credentialmanager.CredentialManager
Credential Managercom.github.philippheuer.credentialmanager.domain.OAuth2Credential
Default Auth Token for API Requestsfeign.Logger.Level
you can overwrite the feign loglevel to print the full requests + responses if neededProxy ConfigurationRedirect UrlHTTP Request Queue SizeScheduler Thread Pool ExecutorDefault TimeoutUser AgentwithApiRateLimit
(io.github.bucket4j.Bandwidth apiRateLimit) Custom Rate Limit to use for Helix callswithBaseUrl
(String baseUrl) BaseUrlwithClientId
(String clientId) Client IdwithClientSecret
(String clientSecret) Client SecretwithCredentialManager
(com.github.philippheuer.credentialmanager.CredentialManager credentialManager) Credential ManagerwithDefaultAuthToken
(com.github.philippheuer.credentialmanager.domain.OAuth2Credential defaultAuthToken) Default Auth Token for API RequestswithLogLevel
(feign.Logger.Level logLevel) you can overwrite the feign loglevel to print the full requests + responses if neededwithProxyConfig
(ProxyConfig proxyConfig) Proxy ConfigurationwithRedirectUrl
(String redirectUrl) Redirect UrlwithRequestQueueSize
(Integer requestQueueSize) HTTP Request Queue SizewithScheduledThreadPoolExecutor
(ScheduledThreadPoolExecutor scheduledThreadPoolExecutor) Scheduler Thread Pool ExecutorwithTimeout
(Integer timeout) Default TimeoutwithUserAgent
(String userAgent) User Agent
-
Field Details
-
OFFICIAL_BASE_URL
The official base URL used by production Twitch Helix API servers.- See Also:
-
MOCK_BASE_URL
The default URL used by the Mock API server generated by the Twitch CLI.- See Also:
-
DEFAULT_BANDWIDTH
public static final io.github.bucket4j.Bandwidth DEFAULT_BANDWIDTH- See Also:
-
-
Method Details
-
builder
Initialize the builder- Returns:
- Twitch Helix Builder
-
build
Twitch API Client (Helix)- Returns:
- TwitchHelix
-
getClientId
Client Id -
getClientSecret
Client Secret -
getRedirectUrl
Redirect Url -
getCredentialManager
public com.github.philippheuer.credentialmanager.CredentialManager getCredentialManager()Credential Manager -
getUserAgent
User Agent -
getDefaultAuthToken
public com.github.philippheuer.credentialmanager.domain.OAuth2Credential getDefaultAuthToken()Default Auth Token for API Requests -
getRequestQueueSize
HTTP Request Queue Size -
getBaseUrl
BaseUrl -
getTimeout
Default Timeout -
getLogLevel
public feign.Logger.Level getLogLevel()you can overwrite the feign loglevel to print the full requests + responses if needed -
getProxyConfig
Proxy Configuration -
getScheduledThreadPoolExecutor
Scheduler Thread Pool Executor -
getApiRateLimit
public io.github.bucket4j.Bandwidth getApiRateLimit()Custom Rate Limit to use for Helix calls -
withClientId
Client Id- Returns:
- a clone of this object, except with this updated property (returns
this
if an identical value is passed).
-
withClientSecret
Client Secret- Returns:
- a clone of this object, except with this updated property (returns
this
if an identical value is passed).
-
withRedirectUrl
Redirect Url- Returns:
- a clone of this object, except with this updated property (returns
this
if an identical value is passed).
-
withCredentialManager
public TwitchHelixBuilder withCredentialManager(com.github.philippheuer.credentialmanager.CredentialManager credentialManager) Credential Manager- Returns:
- a clone of this object, except with this updated property (returns
this
if an identical value is passed).
-
withUserAgent
User Agent- Returns:
- a clone of this object, except with this updated property (returns
this
if an identical value is passed).
-
withDefaultAuthToken
public TwitchHelixBuilder withDefaultAuthToken(com.github.philippheuer.credentialmanager.domain.OAuth2Credential defaultAuthToken) Default Auth Token for API Requests- Returns:
- a clone of this object, except with this updated property (returns
this
if an identical value is passed).
-
withRequestQueueSize
HTTP Request Queue Size- Returns:
- a clone of this object, except with this updated property (returns
this
if an identical value is passed).
-
withBaseUrl
BaseUrl- Returns:
- a clone of this object, except with this updated property (returns
this
if an identical value is passed).
-
withTimeout
Default Timeout- Returns:
- a clone of this object, except with this updated property (returns
this
if an identical value is passed).
-
withLogLevel
you can overwrite the feign loglevel to print the full requests + responses if needed- Returns:
- a clone of this object, except with this updated property (returns
this
if an identical value is passed).
-
withProxyConfig
Proxy Configuration- Returns:
- a clone of this object, except with this updated property (returns
this
if an identical value is passed).
-
withScheduledThreadPoolExecutor
public TwitchHelixBuilder withScheduledThreadPoolExecutor(ScheduledThreadPoolExecutor scheduledThreadPoolExecutor) Scheduler Thread Pool Executor- Returns:
- a clone of this object, except with this updated property (returns
this
if an identical value is passed).
-
withApiRateLimit
Custom Rate Limit to use for Helix calls- Returns:
- a clone of this object, except with this updated property (returns
this
if an identical value is passed).
-