Skip to content

Commit

Permalink
docs: recommend javadoc usage in helix docs index
Browse files Browse the repository at this point in the history
  • Loading branch information
iProdigy committed Jan 23, 2024
1 parent f551cec commit bbfcd7c
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/versioned_docs/version-1.x/rest-helix/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,17 @@ Warning: Client IDs should be unique for each application: do not re-use client

You can create new application on the [Twitch Developer Console](https://glass.twitch.tv/console/apps/create)

To obtain user access tokens, you will need need to undergo an OAuth2 flow (excluding the client credentials flow): https://dev.twitch.tv/docs/authentication/getting-tokens-oauth/
Alternatively, it can be easier to utilize a generator website like https://twitchtokengenerator.com (if you use their client id, the token will not expire).
User access tokens can be passed as the first argument to any `TwitchHelix` method,
or you can specify `withDefaultAuthToken(OAuth2Credential)` on a module builder.

:::info

We recommend you utilize our [JavaDocs](https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html) for more updated documentation regarding the Helix API module.

:::

## As Module: Twitch4J

To use Helix you need to enable the Helix API when building the Twitch4J Instance, as shown below:
Expand Down Expand Up @@ -99,6 +110,12 @@ def client = TwitchHelixBuilder.builder()

## API Methods

:::note

The following list is incomplete; Twitch4J implements all Helix endpoints, which is reflected in our [javadocs](https://twitch4j.github.io/javadoc/com/github/twitch4j/helix/TwitchHelix.html).

:::

Analytics:

- [Analytics -> Extension Analytics Url](./analytics-extension-url)
Expand Down

0 comments on commit bbfcd7c

Please sign in to comment.